Public Member Functions | |
ReadCondition | create_readcondition (int sample_states, int view_states, int instance_states) |
Creates a com.rti.dds.subscription.ReadCondition. | |
QueryCondition | create_querycondition (int sample_states, int view_states, int instance_states, String query_expression, StringSeq query_parameters) |
Creates a com.rti.dds.subscription.QueryCondition. | |
void | delete_readcondition (ReadCondition condition) |
Deletes a com.rti.dds.subscription.ReadCondition or com.rti.dds.subscription.QueryCondition attached to the com.rti.dds.subscription.DataReader. | |
void | set_qos (DataReaderQos qos) |
Sets the reader QoS. | |
void | set_qos_with_profile (String library_name, String profile_name) |
<<eXtension>> Change the QoS of this reader using the input XML QoS profile. | |
void | get_qos (DataReaderQos qos) |
Gets the reader QoS. | |
void | set_listener (DataReaderListener l, int mask) |
Sets the reader listener. | |
DataReaderListener | get_listener () |
Get the reader listener. | |
void | call_listenerT (int mask) |
Calls the reader listener. | |
void | get_sample_rejected_status (SampleRejectedStatus status) |
Accesses the StatusKind.SAMPLE_REJECTED_STATUS communication status. | |
void | get_liveliness_changed_status (LivelinessChangedStatus status) |
Accesses the StatusKind.LIVELINESS_CHANGED_STATUS communication status. | |
void | get_requested_deadline_missed_status (RequestedDeadlineMissedStatus status) |
Accesses the StatusKind.REQUESTED_DEADLINE_MISSED_STATUS communication status. | |
void | get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus status) |
Accesses the StatusKind.REQUESTED_INCOMPATIBLE_QOS_STATUS communication status. | |
void | get_sample_lost_status (SampleLostStatus status) |
Accesses the StatusKind.SAMPLE_LOST_STATUS_STATUS communication status. | |
void | get_subscription_matched_status (SubscriptionMatchedStatus status) |
Accesses the StatusKind.SUBSCRIPTION_MATCHED_STATUS communication status. | |
void | get_datareader_cache_status (DataReaderCacheStatus status) |
<<eXtension>> Get the datareader cache status for this reader. | |
void | get_datareader_protocol_status (DataReaderProtocolStatus status) |
<<eXtension>> Get the datareader protocol status for this reader. | |
void | get_matched_publication_datareader_protocol_status (DataReaderProtocolStatus status, InstanceHandle_t publication_handle) |
<<eXtension>> Get the datareader protocol status for this reader, per matched publication identified by the publication_handle. | |
void | get_matched_publications (InstanceHandleSeq publication_handles) |
Retrieve the list of publications currently "associated" with this com.rti.dds.subscription.DataReader. | |
void | get_matched_publication_data (PublicationBuiltinTopicData publication_data, InstanceHandle_t publication_handle) |
This operation retrieves the information on a publication that is currently "associated" with the com.rti.dds.subscription.DataReader. | |
TopicDescription | get_topicdescription () |
Returns the com.rti.dds.topic.TopicDescription associated with the com.rti.dds.subscription.DataReader. | |
Subscriber | get_subscriber () |
Returns the com.rti.dds.subscription.Subscriber to which the com.rti.dds.subscription.DataReader belongs. | |
void | delete_contained_entities () |
Deletes all the entities that were created by means of the "create" operations on the com.rti.dds.subscription.DataReader. | |
void | wait_for_historical_data (Duration_t max_wait) |
Waits until all "historical" data is received for com.rti.dds.subscription.DataReader entities that have a non-VOLATILE Durability Qos kind. | |
void | read_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states) |
Read data samples, if any are available. | |
void | take_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states) |
Take data samples, if any are available. | |
void | read_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition read_condition) |
Read data samples, if any are available. | |
void | take_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition read_condition) |
Take data samples, if any are available. | |
void | read_next_sample_untyped (Object received_data, SampleInfo sample_info) |
Read data samples, if any are available. | |
void | take_next_sample_untyped (Object received_data, SampleInfo sample_info) |
Take data samples, if any are available. | |
void | read_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states) |
Read data samples, if any are available. | |
void | take_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states) |
Take data samples, if any are available. | |
void | read_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition) |
Read data samples, if any are available. | |
void | take_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition) |
Take data samples, if any are available. | |
void | read_next_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states) |
Read data samples, if any are available. | |
void | take_next_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states) |
Take data samples, if any are available. | |
void | read_next_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition) |
Read data samples, if any are available. | |
void | take_next_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition) |
Take data samples, if any are available. | |
void | return_loan_untyped (List received_data, SampleInfoSeq info_seq) |
Return loaned sample data and meta-data. | |
void | get_key_value_untyped (Object key_holder, InstanceHandle_t handle) |
Fill in the key fields of the given data sample. |
The subscription has a unique resulting type. The data-reader may give access to several instances of the resulting type, which can be distinguished from each other by their key
.
com.rti.dds.subscription.DataReader is an abstract class. It must be specialised for each particular application data-type (see USER_DATA). The additional methods or functions that must be defined in the auto-generated class for a hypothetical application type Foo
are specified in the generic type com.rti.dds.topic.example.FooDataReader.
The following operations may be called even if the com.rti.dds.subscription.DataReader is not enabled. Other operations will fail with the value RETCODE_NOT_ENABLED if called on a disabled com.rti.dds.subscription.DataReader:
ReadCondition create_readcondition | ( | int | sample_states, | |
int | view_states, | |||
int | instance_states | |||
) |
Creates a com.rti.dds.subscription.ReadCondition.
The returned com.rti.dds.subscription.ReadCondition will be attached and belong to the com.rti.dds.subscription.DataReader.
sample_states | <<in>> sample state of the data samples that are of interest | |
view_states | <<in>> view state of the data samples that are of interest | |
instance_states | <<in>> instance state of the data samples that are of interest |
QueryCondition create_querycondition | ( | int | sample_states, | |
int | view_states, | |||
int | instance_states, | |||
String | query_expression, | |||
StringSeq | query_parameters | |||
) |
Creates a com.rti.dds.subscription.QueryCondition.
The returned com.rti.dds.subscription.QueryCondition will be attached and belong to the com.rti.dds.subscription.DataReader.
Queries and Filters Syntax describes the syntax of query_expression
and query_parameters
.
sample_states | <<in>> sample state of the data samples that are of interest | |
view_states | <<in>> view state of the data samples that are of interest | |
instance_states | <<in>> instance state of the data samples that are of interest | |
query_expression | <<in>> Expression for the query. Cannot be NULL. | |
query_parameters | <<in>> Parameters for the query expression. Cannot be NULL. |
void delete_readcondition | ( | ReadCondition | condition | ) |
Deletes a com.rti.dds.subscription.ReadCondition or com.rti.dds.subscription.QueryCondition attached to the com.rti.dds.subscription.DataReader.
Since com.rti.dds.subscription.QueryCondition specializes com.rti.dds.subscription.ReadCondition, it can also be used to delete a com.rti.dds.subscription.QueryCondition.
condition | <<in>> Condition to be deleted. |
One | of the Standard Return Codes, or RETCODE_PRECONDITION_NOT_MET |
void set_qos | ( | DataReaderQos | qos | ) |
Sets the reader QoS.
This operation modifies the QoS of the com.rti.dds.subscription.DataReader.
The com.rti.dds.subscription.DataReaderQos.user_data, com.rti.dds.subscription.DataReaderQos.deadline, com.rti.dds.subscription.DataReaderQos.latency_budget, com.rti.dds.subscription.DataReaderQos.time_based_filter, com.rti.dds.subscription.DataReaderQos.reader_data_lifecycle can be changed. The other policies are immutable.
qos | <<in>> The com.rti.dds.subscription.DataReaderQos to be set to. Policies must be consistent. Immutable policies cannot be changed after com.rti.dds.subscription.DataReader is enabled. The special value Subscriber.DATAREADER_QOS_DEFAULT can be used to indicate that the QoS of the com.rti.dds.subscription.DataReader should be changed to match the current default com.rti.dds.subscription.DataReaderQos set in the com.rti.dds.subscription.Subscriber. Cannot be NULL. |
One | of the Standard Return Codes, RETCODE_IMMUTABLE_POLICY, or RETCODE_INCONSISTENT_POLICY. |
void set_qos_with_profile | ( | String | library_name, | |
String | profile_name | |||
) |
<<eXtension>> Change the QoS of this reader using the input XML QoS profile.
This operation modifies the QoS of the com.rti.dds.subscription.DataReader.
The com.rti.dds.subscription.DataReaderQos.user_data, com.rti.dds.subscription.DataReaderQos.deadline, com.rti.dds.subscription.DataReaderQos.latency_budget, com.rti.dds.subscription.DataReaderQos.time_based_filter, com.rti.dds.subscription.DataReaderQos.reader_data_lifecycle can be changed. The other policies are immutable.
library_name | <<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.subscription.Subscriber.set_default_library). | |
profile_name | <<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.subscription.Subscriber.set_default_profile). |
One | of the Standard Return Codes, RETCODE_IMMUTABLE_POLICY, or RETCODE_INCONSISTENT_POLICY. |
void get_qos | ( | DataReaderQos | qos | ) |
Gets the reader QoS.
This method may potentially allocate memory depending on the sequences contained in some QoS policies.
qos | <<inout>> The com.rti.dds.subscription.DataReaderQos to be filled up. Cannot be NULL. |
One | of the Standard Return Codes |
void set_listener | ( | DataReaderListener | l, | |
int | mask | |||
) |
Sets the reader listener.
l | <<in>> com.rti.dds.subscription.DataReaderListener to set to | |
mask | <<in>> com.rti.dds.infrastructure.StatusMask associated with the com.rti.dds.subscription.DataReaderListener. |
One | of the Standard Return Codes |
DataReaderListener get_listener | ( | ) |
void call_listenerT | ( | int | mask | ) |
void get_sample_rejected_status | ( | SampleRejectedStatus | status | ) |
Accesses the StatusKind.SAMPLE_REJECTED_STATUS communication status.
status | <<inout>> com.rti.dds.subscription.SampleRejectedStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes |
void get_liveliness_changed_status | ( | LivelinessChangedStatus | status | ) |
Accesses the StatusKind.LIVELINESS_CHANGED_STATUS communication status.
status | <<inout>> com.rti.dds.subscription.LivelinessChangedStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes |
void get_requested_deadline_missed_status | ( | RequestedDeadlineMissedStatus | status | ) |
Accesses the StatusKind.REQUESTED_DEADLINE_MISSED_STATUS communication status.
status | <<inout>> com.rti.dds.subscription.RequestedDeadlineMissedStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes |
void get_requested_incompatible_qos_status | ( | RequestedIncompatibleQosStatus | status | ) |
Accesses the StatusKind.REQUESTED_INCOMPATIBLE_QOS_STATUS communication status.
status | <<inout>> com.rti.dds.subscription.RequestedIncompatibleQosStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes |
void get_sample_lost_status | ( | SampleLostStatus | status | ) |
Accesses the StatusKind.SAMPLE_LOST_STATUS_STATUS communication status.
status | <<inout>> com.rti.dds.subscription.SampleLostStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes |
void get_subscription_matched_status | ( | SubscriptionMatchedStatus | status | ) |
Accesses the StatusKind.SUBSCRIPTION_MATCHED_STATUS communication status.
status | <<inout>> com.rti.dds.subscription.SubscriptionMatchedStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes |
void get_datareader_cache_status | ( | DataReaderCacheStatus | status | ) |
<<eXtension>> Get the datareader cache status for this reader.
status | <<inout>> com.rti.dds.subscription.DataReaderCacheStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes or RETCODE_NOT_ENABLED. |
void get_datareader_protocol_status | ( | DataReaderProtocolStatus | status | ) |
<<eXtension>> Get the datareader protocol status for this reader.
status | <<inout>> com.rti.dds.subscription.DataReaderProtocolStatus to be filled in. Cannot be NULL. |
One | of the Standard Return Codes or RETCODE_NOT_ENABLED. |
void get_matched_publication_datareader_protocol_status | ( | DataReaderProtocolStatus | status, | |
InstanceHandle_t | publication_handle | |||
) |
<<eXtension>> Get the datareader protocol status for this reader, per matched publication identified by the publication_handle.
Note: Status for a remote entity is only kept while the entity is alive. Once a remote entity is no longer alive, its status is deleted.
status | <<inout>>. The information to be filled in on the associated publication. Cannot be NULL. | |
publication_handle | <<in>>. Handle to a specific publication associated with the com.rti.dds.publication.DataWriter. Cannot be NULL.. Must correspond to a publication currently associated with the com.rti.dds.subscription.DataReader. |
One | of the Standard Return Codes or RETCODE_NOT_ENABLED |
void get_matched_publications | ( | InstanceHandleSeq | publication_handles | ) |
Retrieve the list of publications currently "associated" with this com.rti.dds.subscription.DataReader.
Matching publications are those in the same domain that have a matching com.rti.dds.topic.Topic, compatible QoS common partition that the com.rti.dds.domain.DomainParticipant has not indicated should be "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_publication operation.
The handles returned in the publication_handles'
list are the ones that are used by the DDS implementation to locally identify the corresponding matched com.rti.dds.publication.DataWriter entities. These handles match the ones that appear in the instance_handle
field of the com.rti.dds.subscription.SampleInfo when reading the PublicationBuiltinTopicDataTypeSupport.PUBLICATION_TOPIC_NAME builtin topic
publication_handles | <<inout>>. The sequence will be grown if the sequence has ownership and the system has the corresponding resources. Use a sequence without ownership to avoid dynamic memory allocation. If the sequence is too small to store all the matches and the system can not resize the sequence, this method will fail with RETCODE_OUT_OF_RESOURCES. |
One | of the Standard Return Codes, or RETCODE_OUT_OF_RESOURCES if the sequence is too small and the system can not resize it, or RETCODE_NOT_ENABLED |
void get_matched_publication_data | ( | PublicationBuiltinTopicData | publication_data, | |
InstanceHandle_t | publication_handle | |||
) |
This operation retrieves the information on a publication that is currently "associated" with the com.rti.dds.subscription.DataReader.
Publication with a matching com.rti.dds.topic.Topic, compatible QoS and common partition that the application has not indicated should be "ignored" by means of the com.rti.dds.domain.DomainParticipant.ignore_publication operation.
The publication_handle
must correspond to a publication currently associated with the com.rti.dds.subscription.DataReader. Otherwise, the operation will fail with RETCODE_BAD_PARAMETER. Use the operation com.rti.dds.subscription.DataReader.get_matched_publications to find the publications that are currently matched with the com.rti.dds.subscription.DataReader.
Note: This operation does not retrieve the following information in builtin.PublicationBuiltinTopicData:
publication_data | <<inout>>. The information to be filled in on the associated publication. Cannot be NULL. | |
publication_handle | <<in>>. Handle to a specific publication associated with the com.rti.dds.publication.DataWriter. Cannot be NULL.. Must correspond to a publication currently associated with the com.rti.dds.subscription.DataReader. |
One | of the Standard Return Codes or RETCODE_NOT_ENABLED |
TopicDescription get_topicdescription | ( | ) |
Returns the com.rti.dds.topic.TopicDescription associated with the com.rti.dds.subscription.DataReader.
Returns that same com.rti.dds.topic.TopicDescription that was used to create the com.rti.dds.subscription.DataReader.
Subscriber get_subscriber | ( | ) |
Returns the com.rti.dds.subscription.Subscriber to which the com.rti.dds.subscription.DataReader belongs.
void delete_contained_entities | ( | ) |
Deletes all the entities that were created by means of the "create" operations on the com.rti.dds.subscription.DataReader.
Deletes all contained com.rti.dds.subscription.ReadCondition and com.rti.dds.subscription.QueryCondition objects.
The operation will fail with RETCODE_PRECONDITION_NOT_MET if the any of the contained entities is in a state where it cannot be deleted.
Once com.rti.dds.subscription.DataReader.delete_contained_entities completes successfully, the application may delete the com.rti.dds.subscription.DataReader, knowing that it has no contained com.rti.dds.subscription.ReadCondition and com.rti.dds.subscription.QueryCondition objects.
One | of the Standard Return Codes, or RETCODE_PRECONDITION_NOT_MET |
void wait_for_historical_data | ( | Duration_t | max_wait | ) |
Waits until all "historical" data is received for com.rti.dds.subscription.DataReader entities that have a non-VOLATILE Durability Qos kind.
This operation is intended only for com.rti.dds.subscription.DataReader entities that have a non-VOLATILE Durability QoS kind.
As soon as an application enables a non-VOLATILE com.rti.dds.subscription.DataReader, it will start receiving both "historical" data (i.e., the data that was written prior to the time the com.rti.dds.subscription.DataReader joined the domain) as well as any new data written by the com.rti.dds.publication.DataWriter entities. There are situations where the application logic may require the application to wait until all "historical" data is received. This is the purpose of the com.rti.dds.subscription.DataReader.wait_for_historical_data operations.
The operation com.rti.dds.subscription.DataReader.wait_for_historical_data blocks the calling thread until either all "historical" data is received, or else duration specified by the max_wait parameter clapses, whichever happens first. A successful completion indicates that all the "historical" data was "received"; timing out indicates that max_wait elapsed before all the data was received.
max_wait | <<in>> Timeout value. Cannot be NULL. |
One | of the Standard Return Codes, RETCODE_TIMEOUT or RETCODE_NOT_ENABLED. |
void read_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
int | sample_states, | |||
int | view_states, | |||
int | instance_states | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read
void take_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
int | sample_states, | |||
int | view_states, | |||
int | instance_states | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take
void read_w_condition_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
ReadCondition | read_condition | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read_w_condition method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read_w_condition
void take_w_condition_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
ReadCondition | read_condition | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take_w_condition method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take_w_condition
void read_next_sample_untyped | ( | Object | received_data, | |
SampleInfo | sample_info | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read_next_sample method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read_next_sample
void take_next_sample_untyped | ( | Object | received_data, | |
SampleInfo | sample_info | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take_next_sample method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take_next_sample
void read_instance_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
int | sample_states, | |||
int | view_states, | |||
int | instance_states | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read_instance method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read_instance
void take_instance_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
int | sample_states, | |||
int | view_states, | |||
int | instance_states | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take_instance method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take_instance
void read_instance_w_condition_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
ReadCondition | read_condition | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read_next_instance_w_condition method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read_next_instance_w_condition
void take_instance_w_condition_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
ReadCondition | read_condition | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take_next_instance_w_condition method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take_next_instance_w_condition
void read_next_instance_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
int | sample_states, | |||
int | view_states, | |||
int | instance_states | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read_next_instance method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read_next_instance
void take_next_instance_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
int | sample_states, | |||
int | view_states, | |||
int | instance_states | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take_next_instance method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take_next_instance
void read_next_instance_w_condition_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
ReadCondition | read_condition | |||
) |
Read data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.read_next_instance_w_condition method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.read_next_instance_w_condition
void take_next_instance_w_condition_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq, | |||
int | max_samples, | |||
InstanceHandle_t | a_handle, | |||
ReadCondition | read_condition | |||
) |
Take data samples, if any are available.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.take_next_instance_w_condition method instead of this one. See that method for detailed documentation.
com.rti.dds.topic.example.FooDataReader.take_next_instance_w_condition
void return_loan_untyped | ( | List | received_data, | |
SampleInfoSeq | info_seq | |||
) |
Return loaned sample data and meta-data.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.return_loan method instead of this one. See that method for detailed documentation.
void get_key_value_untyped | ( | Object | key_holder, | |
InstanceHandle_t | handle | |||
) |
Fill in the key fields of the given data sample.
This method allows type-independent code to work with a variety of concrete com.rti.dds.topic.example.FooDataReader classes in a consistent way.
Statically type-safe code should use the appropriate com.rti.dds.topic.example.FooDataReader.get_key_value method instead of this one. See that method for detailed documentation.