Index

Package: DDS.Builtin_KeyedString_DataWriter

Description

package DDS.Builtin_KeyedString_DataWriter is

Summary: <<interface>> Instantiates DataWriter < DDS_KeyedString >.


See also: FooDataWriter
See also: DDS.DataWriter

Classes

Ref 

type Ref is new Standard.DDS.DataWriter_Impl.Ref with null record;

Primitive operations:

dispose_w_key
dispose_w_key_w_params
dispose_w_key_w_timestamp
dispose_w_params
Dispose_W_Timestamp
Get_Key_Value
Get_Key_Value_W_Key
Lookup_Instance
lookup_instance_w_key
Register_Instance
Register_instance_w_key
Register_instance_w_key_w_params
Register_instance_w_key_w_timestamp
Register_Instance_W_Timestamp
Unregister_Instance
Unregister_instance_w_key
unregister_instance_w_key_w_params
unregister_instance_w_key_w_timestamp
unregister_instance_w_params
Unregister_Instance_W_Timestamp
write_string_w_key
write_string_w_key_w_params
write_string_w_key_w_timestamp
write_w_params
Write_W_Timestamp

Types

Ref_Access 

type Ref_Access is access all Ref'Class;

Ref_Access_Access 

type Ref_Access_Access is access all Ref_Access;

Subprograms & Entries

Narrow 

function Narrow 
(writer: DDS.DataWriter.Ref_Access) return DDS.Builtin_KeyedString_DataWriter.Ref_Access;

Summary: Narrow the given DDS.DataWriter pointer to a DDSKeyedStringDataWriter pointer.


See also: FooDataWriter.narrow

As_DataWriter 

function As_DataWriter 
(writer: DDS.Builtin_KeyedString_DataWriter.Ref_Access) return DDS.DataWriter.Ref_Access;

Summary: Widen the given DDSKeyedStringDataWriter pointer to a DDS.DataWriter pointer.


See also: FooDataWriter.as_datawriter

Register_Instance 

function Register_Instance 
(This: not null access Ref;
Instance_Data: DDS.KeyedString) return Standard.DDS.InstanceHandle_T;

Summary: Informs RTI Connext that the application will be modifying a particular instance.


See also: FooDataWriter.register_instance

Register_Instance_W_Timestamp 

function Register_Instance_W_Timestamp 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Source_Timestamp: in Standard.DDS.Time_T) return Standard.DDS.InstanceHandle_T;

Summary: Performs the same functions as DDSKeyedStringDataWriter.register_instance except that the application provides the value for the source_timestamp.


See also: FooDataWriter.register_instance_w_timestamp

Unregister_Instance 

procedure Unregister_Instance 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Handle: access Standard.DDS.InstanceHandle_T);

Summary: Reverses the action of DDSKeyedStringDataWriter.register_instance.


See also: FooDataWriter.unregister_instance

Unregister_Instance_W_Timestamp 

procedure Unregister_Instance_W_Timestamp 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Handle: access Standard.DDS.InstanceHandle_T;
Source_Timestamp: in Standard.DDS.Time_T);

Summary: Performs the same function as DDSKeyedStringDataWriter.unregister_instance except that it also provides the value for the source_timestamp.


See also: FooDataWriter.unregister_instance_w_timestamp

Write 

procedure Write 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Handle: in Standard.DDS.InstanceHandle_T_Access);

Summary: Modifies the value of a DDS_KeyedString data instance.


See also: FooDataWriter.write

Write_W_Timestamp 

procedure Write_W_Timestamp 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Handle: in Standard.DDS.InstanceHandle_T_Access;
Source_Timestamp: in Standard.DDS.Time_T);

Summary: Performs the same function as DDSKeyedStringDataWriter.write except that it also provides the value for the source_timestamp.


See also: FooDataWriter.write_w_timestamp

Dispose 

procedure Dispose 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Instance_Handle: access Standard.DDS.InstanceHandle_T);

Summary: Requests the middleware to delete the data.


See also: FooDataWriter.dispose

Dispose_W_Timestamp 

procedure Dispose_W_Timestamp 
(This: not null access Ref;
Instance_Data: DDS.KeyedString;
Instance_Handle: access Standard.DDS.InstanceHandle_T;
Source_Timestamp: access Standard.DDS.Time_T);

Summary: Performs the same functions as DDSKeyedStringDataWriter.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: FooDataWriter.dispose_w_timestamp

Get_Key_Value 

procedure Get_Key_Value 
(This: not null access Ref;
Key_Holder: DDS.KeyedString;
Handle: access Standard.DDS.InstanceHandle_T);

Summary: Retrieve the instance key that corresponds to an instance handle.


See also: FooDataWriter.get_key_value

Lookup_Instance 

function Lookup_Instance 
(This: not null access Ref;
Key_Holder: DDS.KeyedString) return Standard.DDS.InstanceHandle_T;

Summary: Retrieve the instance handle that corresponds to an instance key_holder.


See also: FooDataWriter.lookup_instance

Register_instance_w_key 

function Register_instance_w_key 
(This: not null access Ref;
key: DDS.String) return DDS.InstanceHandle_T;

Summary: <<ext>> Informs RTI Connext that the application will be modifying a particular instance.


See also: FooDataWriter.register_instance

Register_instance_w_key_w_timestamp 

function Register_instance_w_key_w_timestamp 
(This: not null access Ref;
key: DDS.String;
source_timestamp: access DDS.Time_T) return DDS.InstanceHandle_T;

Summary: <<ext>> Performs the same functions as DDSKeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.


See also: FooDataWriter.register_instance_w_timestamp

Register_instance_w_key_w_params 

function Register_instance_w_key_w_params 
(This: not null access Ref;
key: DDS.String;
params: access DDS.WriteParams_T) return DDS.InstanceHandle_T;

Unregister_instance_w_key 

procedure Unregister_instance_w_key 
(This: not null access Ref;
key: DDS.String;
handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Reverses the action of DDSKeyedStringDataWriter::register_instance.


See also: FooDataWriter.unregister_instance

unregister_instance_w_params 

procedure unregister_instance_w_params 
(This: not null access Ref;
instance_data: access DDS.KeyedString;
params: access DDS.WriteParams_T);

unregister_instance_w_key_w_timestamp 

procedure unregister_instance_w_key_w_timestamp 
(This: not null access Ref;
key: DDS.String;
handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: <<ext>> Performs the same function as DDSKeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.


See also: FooDataWriter.unregister_instance_w_timestamp

unregister_instance_w_key_w_params 

procedure unregister_instance_w_key_w_params 
(This: not null access Ref;
key: DDS.String;
params: access DDS.WriteParams_T);

write_string_w_key 

procedure write_string_w_key 
(This: not null access Ref;
key: DDS.String;
str: DDS.String;
handle: DDS.InstanceHandle_T);

Summary: <<ext>> Modifies the value of a DDS_KeyedString data instance.


See also: FooDataWriter.write

write_string_w_key_w_timestamp 

procedure write_string_w_key_w_timestamp 
(This: not null access Ref;
key: DDS.String;
str: DDS.String;
handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: <<ext>> Performs the same function as DDSKeyedStringDataWriter::write except that it also provides the value for the source_timestamp.


See also: FooDataWriter.write_w_timestamp

write_w_params 

procedure write_w_params 
(This: not null access Ref;
instance_data: access DDS.KeyedString;
params: access DDS.WriteParams_T);

write_string_w_key_w_params 

procedure write_string_w_key_w_params 
(This: not null access Ref;
key: DDS.String;
str: DDS.String;
params: access DDS.WriteParams_T);

dispose_w_key 

procedure dispose_w_key 
(This: not null access Ref;
key: DDS.String;
instance_handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Requests the middleware to delete the data.


See also: FooDataWriter.dispose

dispose_w_params 

procedure dispose_w_params 
(This: not null access Ref;
instance_data: access DDS.KeyedString;
params: access DDS.WriteParams_T);

dispose_w_key_w_timestamp 

procedure dispose_w_key_w_timestamp 
(This: not null access Ref;
key: DDS.String;
instance_handle: access DDS.InstanceHandle_T;
source_timestamp: access DDS.Time_T);

Summary: <<ext>> Performs the same functions as DDSKeyedStringDataWriter::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: FooDataWriter.dispose_w_timestamp

dispose_w_key_w_params 

procedure dispose_w_key_w_params 
(This: not null access Ref;
key: DDS.String;
params: access DDS.WriteParams_T);

lookup_instance_w_key 

function lookup_instance_w_key 
(This: not null access Ref;
key: DDS.String) return DDS.InstanceHandle_T;

Summary: <<ext>> Retrieve the instance handle that corresponds to an instance key.


See also: FooDataWriter.lookup_instance

Get_Key_Value_W_Key 

procedure Get_Key_Value_W_Key 
(This: not null access Ref;
key: DDS.String;
handle: access DDS.InstanceHandle_T);

Summary: <<ext>> Retrieve the instance key that corresponds to an instance handle.


See also: FooDataWriter.get_key_value

CreateTypedI 

function CreateTypedI return Standard.DDS.DataWriter.Ref_Access;

DestroyTypedI 

procedure DestroyTypedI 
(Writer: in out Standard.DDS.DataWriter.Ref_Access);