DDS::KeyedStringDataWriter Class Reference
[KeyedString Built-in Type]

<<interface>> Instantiates DataWriter < DDS::KeyedString >. More...

#include <managed_keyedstringSupport.h>

Inheritance diagram for DDS::KeyedStringDataWriter:

DDS::TypedDataWriter< T > DDS::DataWriter DDS::DomainEntity DDS::Entity

List of all members.

Public Member Functions

InstanceHandle_t register_instance (System::String^ key)
 <<eXtension>> Informs RTI Data Distribution Service that the application will be modifying a particular instance.
InstanceHandle_t register_instance_w_timestamp (System::String^ key, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.
void unregister_instance (System::String^ key, DDS::InstanceHandle_t% handle)
 <<eXtension>> Reverses the action of DDS::KeyedStringDataWriter::register_instance.
void unregister_instance_w_timestamp (System::String^ key, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
void write (System::String^ key, System::String^ str, DDS::InstanceHandle_t% handle)
 <<eXtension>> Modifies the value of a DDS::KeyedString data instance.
void write_w_timestamp (System::String^ key, System::String^ str, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::write except that it also provides the value for the source_timestamp.
void dispose (System::String^ key, DDS::InstanceHandle_t% instance_handle)
 <<eXtension>> Requests the middleware to delete the data.
void dispose_w_timestamp (System::String^ key, DDS::InstanceHandle_t% instance_handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDS::DataReader objects by means of the source_timestamp attribute inside the DDS::SampleInfo.
System::String^ get_key_value (DDS::InstanceHandle_t% handle)
 <<eXtension>> Retrieve the instance key that corresponds to an instance handle.
InstanceHandle_t lookup_instance (System::String^ key)
 <<eXtension>> Retrieve the instance handle that corresponds to an instance key.


Detailed Description

<<interface>> Instantiates DataWriter < DDS::KeyedString >.

See also:
DDS::TypedDataWriter

DDS::DataWriter


Member Function Documentation

InstanceHandle_t DDS::KeyedStringDataWriter::register_instance ( System::String^   key  ) 

<<eXtension>> Informs RTI Data Distribution Service that the application will be modifying a particular instance.

See also:
DDS::TypedDataWriter::register_instance

InstanceHandle_t DDS::KeyedStringDataWriter::register_instance_w_timestamp ( System::String^   key,
DDS::Time_t%   source_timestamp 
)

<<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.

See also:
DDS::TypedDataWriter::register_instance_w_timestamp

void DDS::KeyedStringDataWriter::unregister_instance ( System::String^   key,
DDS::InstanceHandle_t%   handle 
)

void DDS::KeyedStringDataWriter::unregister_instance_w_timestamp ( System::String^   key,
DDS::InstanceHandle_t%   handle,
DDS::Time_t%   source_timestamp 
)

<<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.

See also:
DDS::TypedDataWriter::unregister_instance_w_timestamp

void DDS::KeyedStringDataWriter::write ( System::String^   key,
System::String^   str,
DDS::InstanceHandle_t%   handle 
)

<<eXtension>> Modifies the value of a DDS::KeyedString data instance.

See also:
DDS::TypedDataWriter::write

void DDS::KeyedStringDataWriter::write_w_timestamp ( System::String^   key,
System::String^   str,
DDS::InstanceHandle_t%   handle,
DDS::Time_t%   source_timestamp 
)

<<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::write except that it also provides the value for the source_timestamp.

See also:
DDS::TypedDataWriter::write_w_timestamp

void DDS::KeyedStringDataWriter::dispose ( System::String^   key,
DDS::InstanceHandle_t%   instance_handle 
)

<<eXtension>> Requests the middleware to delete the data.

See also:
DDS::TypedDataWriter::dispose

void DDS::KeyedStringDataWriter::dispose_w_timestamp ( System::String^   key,
DDS::InstanceHandle_t%   instance_handle,
DDS::Time_t%   source_timestamp 
)

<<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDS::DataReader objects by means of the source_timestamp attribute inside the DDS::SampleInfo.

See also:
DDS::TypedDataWriter::dispose_w_timestamp

System::String ^ DDS::KeyedStringDataWriter::get_key_value ( DDS::InstanceHandle_t%   handle  ) 

<<eXtension>> Retrieve the instance key that corresponds to an instance handle.

See also:
DDS::TypedDataWriter::get_key_value

InstanceHandle_t DDS::KeyedStringDataWriter::lookup_instance ( System::String^   key  ) 

<<eXtension>> Retrieve the instance handle that corresponds to an instance key.

See also:
DDS::TypedDataWriter::lookup_instance


RTI Data Distribution Service .Net APIs Version 4.5e Copyright © 23 Oct 2011 Real-Time Innovations, Inc