Index

Package: DDS.Builtin_KeyedString_DataReader

Description

package DDS.Builtin_KeyedString_DataReader is

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


See also: FooDataReader
See also: DDS.DataReader

Classes

Ref 

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

Ancestors:

Primitive operations:

DDS.DataReader_Impl.Call_ListnerT (Inherited)
DDS.DataReader_Impl.Create_Querycondition (Inherited)
DDS.DataReader_Impl.Create_Readcondition (Inherited)
DDS.DataReader_Impl.Delete_Contained_Entities (Inherited)
DDS.DataReader_Impl.Delete_Readcondition (Inherited)
DDS.DataReader_Impl.Get_Datareader_Cache_Status (Inherited)
DDS.DataReader_Impl.Get_Datareader_Protocol_Status (Inherited)
DDS.DataReader_Impl.Get_Key_Value (Inherited)
DDS.DataReader_Impl.Get_Listener (Inherited)
DDS.DataReader_Impl.Get_Liveliness_Changed_Status (Inherited)
DDS.DataReader_Impl.Get_Matched_Publication_Data (Inherited)
DDS.DataReader_Impl.Get_Matched_Publication_Datareader_Protocol_Status (Inherited)
DDS.DataReader_Impl.Get_Matched_Publications (Inherited)
DDS.DataReader_Impl.Get_Qos (Inherited)
DDS.DataReader_Impl.Get_Requested_Deadline_Missed_Status (Inherited)
DDS.DataReader_Impl.Get_Requested_Incompatible_Qos_Status (Inherited)
DDS.DataReader_Impl.Get_Sample_Lost_Status (Inherited)
DDS.DataReader_Impl.Get_Sample_Rejected_Status (Inherited)
DDS.DataReader_Impl.Get_Subscriber (Inherited)
DDS.DataReader_Impl.Get_Subscription_Matched_Status (Inherited)
DDS.DataReader_Impl.Get_Topicdescription (Inherited)
DDS.DataReader_Impl.Lookup_Instance (Inherited)
DDS.DataReader_Impl.Read (Inherited)
DDS.DataReader_Impl.Read_Instance (Inherited)
DDS.DataReader_Impl.Read_Next_Instance (Inherited)
DDS.DataReader_Impl.Read_Next_Instance_W_Condition (Inherited)
DDS.DataReader_Impl.Read_Next_Sample (Inherited)
DDS.DataReader_Impl.Read_Or_Take_UntypedI (Inherited)
DDS.DataReader_Impl.Read_Or_Take_UntypedI (Inherited)
DDS.DataReader_Impl.Read_W_Condition (Inherited)
DDS.DataReader_Impl.Return_Loan (Inherited)
DDS.DataReader_Impl.Set_Listener (Inherited)
DDS.DataReader_Impl.Set_Qos (Inherited)
DDS.DataReader_Impl.Set_Qos_With_Profile (Inherited)
DDS.DataReader_Impl.Set_Qos_With_Profile (Inherited)
DDS.DataReader_Impl.Take (Inherited)
DDS.DataReader_Impl.Take_Instance (Inherited)
DDS.DataReader_Impl.Take_Next_Instance (Inherited)
DDS.DataReader_Impl.Take_Next_Instance_W_Condition (Inherited)
DDS.DataReader_Impl.Take_Next_Sample (Inherited)
DDS.DataReader_Impl.Take_W_Condition (Inherited)
DDS.DataReader_Impl.Wait_For_Historical_Data (Inherited)
Get_Key_Value
Get_Key_Value_W_Key
Lookup_Instance
Lookup_Instance_W_Key
Read_Instance
Read_Instance_W_Condition
Read_Next_Instance
Read_Next_Instance_W_Condition
Read_Next_Sample
Read_W_Condition
Take_Instance
Take_Instance_W_Condition
Take_Next_Instance
Take_Next_Instance_W_Condition
Take_Next_Sample
Take_W_Condition

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

Get_FacadeI 

function Get_FacadeI 
(C_DataReader: System.Address) return Ref_Access;

Narrow 

function Narrow 
(reader: DDS.DataReader.Ref_Access) return DDS.Builtin_KeyedString_DataReader.Ref_Access;

Summary: Narrow the given DDS.DataReader pointer to a DDSKeyedStringDataReader pointer.


See also: FooDataReader.narrow

As_DataReader 

function As_DataReader 
(writer: DDS.Builtin_KeyedString_DataReader.Ref_Access) return DDS.DataReader.Ref_Access;

Summary: Widen the given DDSKeyedStringDataReader pointer to a DDS.DataReader pointer.


See also: FooDataReader.as_datareader

Read 

procedure Read 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Sample_States: in Standard.DDS.SampleStateMask := Standard.DDS.ANY_SAMPLE_STATE;
View_States: in Standard.DDS.ViewStateMask := Standard.DDS.ANY_VIEW_STATE;
Instance_States: in Standard.DDS.InstanceStateMask := Standard.DDS.ANY_INSTANCE_STATE);

Summary: Access a collection of data samples from the DDS.DataReader.


See also: FooDataReader.read

Take 

procedure Take 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Sample_States: in Standard.DDS.SampleStateMask := Standard.DDS.ANY_SAMPLE_STATE;
View_States: in Standard.DDS.ViewStateMask := Standard.DDS.ANY_VIEW_STATE;
Instance_States: in Standard.DDS.InstanceStateMask := Standard.DDS.ANY_INSTANCE_STATE);

Summary: Access a collection of data-samples from the DDS.DataReader.


See also: FooDataReader.take

Read_W_Condition 

procedure Read_W_Condition 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Condition: access Standard.DDS.ReadCondition.Ref'Class);

Summary: Accesses via DDSKeyedStringDataReader.read the samples that match the criteria specified in the DDS.ReadCondition.


See also: FooDataReader.read_w_condition

Take_W_Condition 

procedure Take_W_Condition 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Condition: access Standard.DDS.ReadCondition.Ref'Class);

Summary: Analogous to DDSKeyedStringDataReader.read_w_condition except it accesses samples via the DDSKeyedStringDataReader.take operation.


See also: FooDataReader.take_w_condition

Read_Next_Sample 

procedure Read_Next_Sample 
(This: not null access constant Ref;
Received_Data: in out DDS.KeyedString;
Sample_Info: not null access Standard.DDS.SampleInfo);

Summary: Copies the next not-previously-accessed data value from the DDS.DataReader.


See also: FooDataReader.read_next_sample

Take_Next_Sample 

procedure Take_Next_Sample 
(This: not null access constant Ref;
Received_Data: in out DDS.KeyedString;
Sample_Info: not null access Standard.DDS.SampleInfo);

Summary: Copies the next not-previously-accessed data value from the DDS.DataReader.


See also: FooDataReader.take_next_sample

Read_Instance 

procedure Read_Instance 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
A_Handle: access constant Standard.DDS.InstanceHandle_T;
Sample_States: in Standard.DDS.SampleStateMask := Standard.DDS.ANY_SAMPLE_STATE;
View_States: in Standard.DDS.ViewStateMask := Standard.DDS.ANY_VIEW_STATE;
Instance_States: in Standard.DDS.InstanceStateMask := Standard.DDS.ANY_INSTANCE_STATE);

Summary: Access a collection of data samples from the DDS.DataReader.


See also: FooDataReader.read_instance

Take_Instance 

procedure Take_Instance 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
A_Handle: access constant Standard.DDS.InstanceHandle_T;
Sample_States: in Standard.DDS.SampleStateMask := Standard.DDS.ANY_SAMPLE_STATE;
View_States: in Standard.DDS.ViewStateMask := Standard.DDS.ANY_VIEW_STATE;
Instance_States: in Standard.DDS.InstanceStateMask := Standard.DDS.ANY_INSTANCE_STATE);

Summary: Access a collection of data samples from the DDS.DataReader.


See also: FooDataReader.take_instance

Read_Instance_W_Condition 

procedure Read_Instance_W_Condition 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
A_Handle: access Standard.DDS.InstanceHandle_T;
Condition: Standard.DDS.ReadCondition.Ref_Access);

Take_Instance_W_Condition 

procedure Take_Instance_W_Condition 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
A_Handle: access Standard.DDS.InstanceHandle_T;
Condition: Standard.DDS.ReadCondition.Ref_Access);

Read_Next_Instance 

procedure Read_Next_Instance 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Previous_Handle: access constant Standard.DDS.InstanceHandle_T;
Sample_States: in Standard.DDS.SampleStateMask := Standard.DDS.ANY_SAMPLE_STATE;
View_States: in Standard.DDS.ViewStateMask := Standard.DDS.ANY_VIEW_STATE;
Instance_States: in Standard.DDS.InstanceStateMask := Standard.DDS.ANY_INSTANCE_STATE);

Summary: Access a collection of data samples from the DDS.DataReader.


See also: FooDataReader.read_next_instance

Take_Next_Instance 

procedure Take_Next_Instance 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Previous_Handle: access constant Standard.DDS.InstanceHandle_T;
Sample_States: in Standard.DDS.SampleStateMask := Standard.DDS.ANY_SAMPLE_STATE;
View_States: in Standard.DDS.ViewStateMask := Standard.DDS.ANY_VIEW_STATE;
Instance_States: in Standard.DDS.InstanceStateMask := Standard.DDS.ANY_INSTANCE_STATE);

Summary: Access a collection of data samples from the DDS.DataReader.


See also: FooDataReader.take_next_instance

Read_Next_Instance_W_Condition 

procedure Read_Next_Instance_W_Condition 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Previous_Handle: access constant Standard.DDS.InstanceHandle_T;
Condition: Standard.DDS.ReadCondition.Ref_Access);

Summary: Accesses via DDSKeyedStringDataReader.read_next_instance the samples that match the criteria specified in the DDS.ReadCondition.


See also: FooDataReader.read_next_instance_w_condition

Take_Next_Instance_W_Condition 

procedure Take_Next_Instance_W_Condition 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence;
Max_Samples: in Standard.DDS.Long := Standard.DDS.LENGTH_UNLIMITED;
Previous_Handle: access constant Standard.DDS.InstanceHandle_T;
Condition: Standard.DDS.ReadCondition.Ref_Access);

Summary: Accesses via DDSKeyedStringDataReader.take_next_instance the samples that match the criteria specified in the DDS.ReadCondition.


See also: FooDataReader.take_next_instance_w_condition

Return_Loan 

procedure Return_Loan 
(This: not null access constant Ref;
Received_Data: not null access KeyedString_Seq.Sequence;
Info_Seq: not null access Standard.DDS.SampleInfo_Seq.Sequence);

Summary: Indicates to the DDS.DataReader that the application is done accessing the collection of received_data and info_seq obtained by some earlier invocation of read or take on the DDS.DataReader.


See also: FooDataReader.return_loan

Get_Key_Value 

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

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


See also: FooDataReader.get_key_value

Lookup_Instance 

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

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


See also: FooDataReader.lookup_instance

Get_Key_Value_W_Key 

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

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


See also: FooDataReader.get_key_value

Lookup_Instance_W_Key 

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

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


See also: FooDataReader.lookup_instance

CreateTypedI 

function CreateTypedI return Standard.DDS.DataReader.Ref_Access;

DestroyTypedI 

procedure DestroyTypedI 
(Reader: in out Standard.DDS.DataReader.Ref_Access);