CoreDX DDS C++ Reference Manual
List of all members
CDX::DynamicTypeDataReader Class Reference

A DataReader that reads 'DynamicType' data elements A DynamicTypeDataReader can read data published by a normal DataWriter or by a DynamicTypeDataWriter, if the QoS and data types match. More...

Inheritance diagram for CDX::DynamicTypeDataReader:
DDS::DataReader DDS::Entity

Additional Inherited Members

- Public Member Functions inherited from DDS::DataReader
InstanceHandle_t get_instance_handle ()
 This operation returns the InstanceHandle_t that identifies the DataReader.
 
StatusMask get_status_changes ()
 This returns the list of triggered communication statuses in the DataReader. More...
 
ReturnCode_t enable ()
 Enables the DataReader. More...
 
StatusConditionget_statuscondition ()
 Gets the StatusCondition associated with this Entity. NOTE: The entity maintains ownership of the statuscondition, and it remains valid only as long as the Entity is valid. Destroying the Entity also destroys the status condition.
 
ReadConditioncreate_readcondition (SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 Creates a ReadCondition that is associated with this DataReader. More...
 
ReturnCode_t delete_readcondition (ReadCondition *a_condition)
 Destroys a ReadCondition (or QueryCondition). More...
 
ReturnCode_t delete_contained_entities ()
 This operation deletes all the ReadCondition and QueryCondition objects previously created by means of the DataReader_create_readcondition() and DataReader_create_querycondition() operations. More...
 
ReturnCode_t set_qos (const DataReaderQos &qos)
 Sets the DataReaderQos values. More...
 
ReturnCode_t get_qos (DataReaderQos &qos)
 Returns the current DataReaderQos settings held in the DataReader dr. More...
 
ReturnCode_t set_listener (DataReaderListener *a_listener, StatusMask mask)
 Installs a DataReaderListener on DataReader dr. More...
 
DataReaderListenerget_listener ()
 This operation returns the currently installed DataReaderListener. More...
 
TopicDescriptionget_topicdescription ()
 Returns the TopicDescription associated with DataReader dr. More...
 
Subscriberget_subscriber ()
 Returns the Subscribier that contains DataReader dr.
 
ReturnCode_t get_sample_rejected_status (SampleRejectedStatus *status)
 Provides access to the current SampleRejectedStatus of the DataReader. More...
 
ReturnCode_t get_liveliness_changed_status (LivelinessChangedStatus *status)
 Provides access to the current LivelinessChangedStatus of the DataReader. More...
 
ReturnCode_t get_requested_deadline_missed_status (RequestedDeadlineMissedStatus *status)
 Provides access to the current RequestedDeadlineMissedStatus of the DataReader. More...
 
ReturnCode_t get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus *status)
 Provides access to the current RequestedIncompatibleQosStatus of the DataReader. More...
 
ReturnCode_t get_subscription_matched_status (SubscriptionMatchedStatus *status)
 Provides access to the current SubscriptionMatchedStatus of the DataReader. More...
 
ReturnCode_t get_sample_lost_status (SampleLostStatus *status)
 Provides access to the current SampleLostStatus of the DataReader. More...
 
ReturnCode_t wait_for_historical_data (const Duration_t &max_wait)
 This routine blocks until all 'historical' data is received.
 
ReturnCode_t get_matched_publications (InstanceHandleSeq *publication_handles)
 This operation retrieves the list of DataWriters currently matched with the DataReader dr. More...
 
ReturnCode_t get_matched_publication_data (PublicationBuiltinTopicData *publication_data, const InstanceHandle_t publication_handle)
 This operation returns data that describes a particular matched DataWriter identified by publication_handle. More...
 
QueryConditioncreate_querycondition (SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states, const char *query_expression, const StringSeq &query_parameters)
 Creates a QueryCondition. More...
 
ReturnCode_t read (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 This operation accesses a collection of data values (with associated SampleInfo) within the DataReader. More...
 
ReturnCode_t take (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 This operation takes a collection of data values (with associated SampleInfo) from the DataReader. More...
 
ReturnCode_t read_w_condition (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, ReadCondition *a_condition)
 This operation accesses a collection of data values (with associated SampleInfo), subject to a filter, within the DataReader. More...
 
ReturnCode_t take_w_condition (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, ReadCondition *a_condition)
 This operation takes a collection of data values (with associated SampleInfo), subject to a filter, from the DataReader. More...
 
ReturnCode_t read_next_sample (void *received_data, SampleInfo *sample_info)
 This operation accesses a data value (with associated SampleInfo) within the DataReader. More...
 
ReturnCode_t take_next_sample (void *received_data, SampleInfo *sample_info)
 This operation takes a data value (with associated SampleInfo) from the DataReader. More...
 
ReturnCode_t read_instance (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, InstanceHandle_t a_handle, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 This operation accesses a collection of data values (with associated SampleInfo), belonging to a particular instance, within the DataReader. More...
 
ReturnCode_t take_instance (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, InstanceHandle_t a_handle, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 This operation takes a collection of data values (with associated SampleInfo), belonging to a particular instance, from the DataReader. More...
 
ReturnCode_t read_next_instance (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, InstanceHandle_t previous_handle, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 This operation accesses a collection of data values (with associated SampleInfo), instance by instance, within the DataReader. More...
 
ReturnCode_t take_next_instance (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, InstanceHandle_t previous_handle, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
 This operation takes a collection of data values (with associated SampleInfo), instance by instance, from the DataReader. More...
 
ReturnCode_t read_next_instance_w_condition (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, InstanceHandle_t previous_handle, ReadCondition *a_condition)
 This operation accesses a collection of data values (with associated SampleInfo), instance by instance subject to a filter, within the DataReader. More...
 
ReturnCode_t take_next_instance_w_condition (Sequence *received_data, SampleInfoSeq *sample_infos, long max_samples, InstanceHandle_t previous_handle, ReadCondition *a_condition)
 This operation takes a collection of data values (with associated SampleInfo), instance by instance subject to a filter, from the DataReader. More...
 
ReturnCode_t return_loan (Sequence *received_data, SampleInfoSeq *sample_infos)
 Returns data and sample_info values to a DataReader. More...
 
ReturnCode_t get_key_value (void *key_holder, InstanceHandle_t handle)
 This routine will populate the data structure indicated by key_holder with the key infomation identified by handle. More...
 
InstanceHandle_t lookup_instance (void *instance_data)
 Returns the handle that identifies the data instance provided in instance_data. More...
 
ReturnCode_t get_guid (GUID_t *guid)
 Access the GUID which uniquely identifies this reader.
 

Detailed Description

A DataReader that reads 'DynamicType' data elements A DynamicTypeDataReader can read data published by a normal DataWriter or by a DynamicTypeDataWriter, if the QoS and data types match.


© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.