<<interface>> Instantiates DataReader < com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString >. More...

Inheritance diagram for KeyedStringDataReader:

Public Member Functions
void	read (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader. More...

void	take (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Access a collection of data-samples from the com.rti.dds.subscription.DataReader. More...

void	read_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition. More...

void	take_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition condition)
	Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read_w_condition except it accesses samples via the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take operation. More...

void	read_next_sample (KeyedString received_data, SampleInfo sample_info)
	Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader. More...

void	take_next_sample (KeyedString received_data, SampleInfo sample_info)
	Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader. More...

void	read_instance (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader. More...

void	take_instance (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader. More...

void	read_instance_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition. More...

void	take_instance_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition. More...

void	read_next_instance (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader. More...

void	take_next_instance (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader. More...

void	read_next_instance_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition. More...

void	take_next_instance_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition. More...

void	return_loan (KeyedStringSeq received_data, SampleInfoSeq info_seq)
	Indicates to the com.rti.dds.subscription.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 com.rti.dds.subscription.DataReader. More...

void	get_key_value (KeyedString key_holder, InstanceHandle_t handle)
	Retrieve the instance `key` that corresponds to an instance `handle`. More...

String	get_key_value (InstanceHandle_t handle)
	<<extension>> Retrieve the instance `key` that corresponds to an instance `handle`. More...

InstanceHandle_t	lookup_instance (KeyedString key_holder)
	Retrieve the instance `handle` that corresponds to an instance `key_holder`. More...

InstanceHandle_t	lookup_instance (String key)
	<<extension>> Retrieve the instance `handle` that corresponds to an instance `key`. More...

Public Member Functions inherited from DataReader
ReadCondition	create_readcondition (int sample_states, int view_states, int instance_states)
	Creates a com.rti.dds.subscription.ReadCondition. More...

ReadCondition	create_readcondition_w_params (ReadConditionParams params)
	<<extension>> Creates a com.rti.dds.subscription.ReadCondition with parameters. More...

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. More...

QueryCondition	create_querycondition_w_params (QueryConditionParams params)
	<<extension>> Creates a com.rti.dds.subscription.QueryCondition with parameters. More...

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. More...

void	set_qos (DataReaderQos qos)
	Sets the reader QoS. More...

void	set_qos_with_profile (String library_name, String profile_name)
	<<extension>> Changes the QoS of this reader using the input XML QoS profile. More...

void	get_qos (DataReaderQos qos)
	Gets the reader QoS. More...

void	set_listener (DataReaderListener l, int mask)
	Sets the reader listener. More...

DataReaderListener	get_listener ()
	Gets the reader listener. More...

void	call_listenerT (int mask)
	Calls the reader listener. More...

void	get_sample_rejected_status (SampleRejectedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE_REJECTED_STATUS communication status. More...

void	get_liveliness_changed_status (LivelinessChangedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS_CHANGED_STATUS communication status. More...

void	get_requested_deadline_missed_status (RequestedDeadlineMissedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED_DEADLINE_MISSED_STATUS communication status. More...

void	get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED_INCOMPATIBLE_QOS_STATUS communication status. More...

void	get_sample_lost_status (SampleLostStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE_LOST_STATUS_STATUS communication status. More...

void	get_subscription_matched_status (SubscriptionMatchedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION_MATCHED_STATUS communication status. More...

void	get_datareader_cache_status (DataReaderCacheStatus status)
	<<extension>> Gets the datareader cache status for this reader. More...

void	get_datareader_protocol_status (DataReaderProtocolStatus status)
	<<extension>> Gets the datareader protocol status for this reader. More...

void	get_matched_publication_datareader_protocol_status (DataReaderProtocolStatus status, InstanceHandle_t publication_handle)
	<<extension>> Gets the datareader protocol status for this reader, per matched publication identified by the publication_handle. More...

void	get_matched_publications (InstanceHandleSeq publication_handles)
	Retrieves the list of publications currently "associated" with this com.rti.dds.subscription.DataReader. More...

void	get_matched_publication_data (PublicationBuiltinTopicData publication_data, InstanceHandle_t publication_handle)
	Retrieves the information on a publication that is currently "associated" with the com.rti.dds.subscription.DataReader. More...

boolean	is_matched_publication_alive (InstanceHandle_t publication_handle)
	Check if a publication currently matched with a DataReader is alive. More...

void	get_matched_publication_participant_data (ParticipantBuiltinTopicData participant_data, InstanceHandle_t publication_handle)
	<<extension>> Retrieves the information on the discovered com.rti.dds.domain.DomainParticipant associated with the publication that is currently matching with the com.rti.dds.subscription.DataReader. More...

TopicDescription	get_topicdescription ()
	Returns the com.rti.dds.topic.TopicDescription associated with the com.rti.dds.subscription.DataReader. More...

Subscriber	get_subscriber ()
	Returns the com.rti.dds.subscription.Subscriber to which the com.rti.dds.subscription.DataReader belongs. More...

void	delete_contained_entities ()
	Deletes all the entities that were created by means of the "create" operations on the com.rti.dds.subscription.DataReader. More...

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. More...

void	acknowledge_sample (SampleInfo sample_info)
	<<extension>> Acknowledges a single sample explicitly. More...

void	acknowledge_all ()
	<<extension>> Acknowledges all previously accessed samples. More...

void	acknowledge_sample (SampleInfo sample_info, AckResponseData_t response_data)
	<<extension>> Acknowledges a single sample explicitly. More...

void	acknowledge_all (AckResponseData_t response_data)
	<<extension>> Acknowledges all previously accessed samples. More...

TopicQuery	create_topic_query (TopicQuerySelection selection)
	Creates a com.rti.dds.subscription.TopicQuery. More...

void	delete_topic_query (TopicQuery query)
	Deletes a com.rti.dds.subscription.TopicQuery. More...

TopicQuery	lookup_topic_query (GUID_t guid)
	Retrieves an existing com.rti.dds.subscription.TopicQuery. More...

void	read_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Reads data samples, if any are available. More...

void	take_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Takes data samples, if any are available. More...

void	read_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition read_condition)
	Reads data samples, if any are available. More...

void	take_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition read_condition)
	Takes data samples, if any are available. More...

void	read_next_sample_untyped (Object received_data, SampleInfo sample_info)
	Reads data samples, if any are available. More...

void	take_next_sample_untyped (Object received_data, SampleInfo sample_info)
	Takes data samples, if any are available. More...

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)
	Reads data samples, if any are available. More...

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)
	Takes data samples, if any are available. More...

void	read_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, GUID_t topic_query_guid, int sample_states, int view_states, int instance_states)
	Reads data samples, if any are available. More...

void	take_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, GUID_t topic_query_guid, int sample_states, int view_states, int instance_states)
	Takes data samples, if any are available. More...

void	read_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Reads data samples, if any are available. More...

void	take_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Takes data samples, if any are available. More...

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)
	Reads data samples, if any are available. More...

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)
	Takes data samples, if any are available. More...

void	read_next_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Reads data samples, if any are available. More...

void	take_next_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Takes data samples, if any are available. More...

void	return_loan_untyped (List received_data, SampleInfoSeq info_seq)
	Returns loaned sample data and meta-data. More...

void	get_key_value_untyped (Object key_holder, InstanceHandle_t handle)
	Fills in the key fields of the given data sample. More...

InstanceHandle_t	lookup_instance_untyped (Object key_value)

Public Member Functions inherited from Entity
void	enable ()
	Enables the com.rti.dds.infrastructure.Entity. More...

StatusCondition	get_statuscondition ()
	Allows access to the com.rti.dds.infrastructure.StatusCondition associated with the com.rti.dds.infrastructure.Entity. More...

int	get_status_changes ()
	Retrieves the list of communication statuses in the com.rti.dds.infrastructure.Entity that are triggered. More...

InstanceHandle_t	get_instance_handle ()
	Allows access to the com.rti.dds.infrastructure.InstanceHandle_t associated with the com.rti.dds.infrastructure.Entity. More...

Additional Inherited Members
Static Public Attributes inherited from DataReader
static final TopicQuerySelection	TOPIC_QUERY_SELECTION_USE_READER_CONTENT_FILTER
	Special value for creating a com.rti.dds.subscription.TopicQuery that applies the same filter as the DataReader's com.rti.dds.topic.ContentFilteredTopic. More...

static final TopicQuerySelection	TOPIC_QUERY_SELECTION_SELECT_ALL
	Special value for creating a com.rti.dds.subscription.TopicQuery that selects all the samples in a com.rti.dds.publication.DataWriter cache. More...

Detailed Description

<<interface>> Instantiates DataReader < com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString >.

See also: com.rti.ndds.example.FooDataReader; com.rti.dds.subscription.DataReader

Member Function Documentation

◆ read()

void read	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.read

References DataReader.read_untyped().

◆ take()

void take	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data-samples from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.take

References DataReader.take_untyped().

◆ read_w_condition()

void read_w_condition	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also: com.rti.ndds.example.FooDataReader.read_w_condition

References DataReader.read_w_condition_untyped().

◆ take_w_condition()

void take_w_condition	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		ReadCondition	condition
	)

Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read_w_condition except it accesses samples via the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take operation.

See also: com.rti.ndds.example.FooDataReader.take_w_condition

References DataReader.take_w_condition_untyped().

◆ read_next_sample()

void read_next_sample	(	KeyedString	received_data,
		SampleInfo	sample_info
	)

Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.read_next_sample

References DataReader.read_next_sample_untyped().

◆ take_next_sample()

void take_next_sample	(	KeyedString	received_data,
		SampleInfo	sample_info
	)

Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.take_next_sample

References DataReader.take_next_sample_untyped().

◆ read_instance()

void read_instance	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.read_instance

References DataReader.read_instance_untyped().

◆ take_instance()

void take_instance	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.take_instance

References DataReader.take_instance_untyped().

◆ read_instance_w_condition()

void read_instance_w_condition	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also: com.rti.ndds.example.FooDataReader.read_instance_w_condition

References DataReader.read_instance_w_condition_untyped().

◆ take_instance_w_condition()

void take_instance_w_condition	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also: com.rti.ndds.example.FooDataReader.take_instance_w_condition

References DataReader.take_instance_w_condition_untyped().

◆ read_next_instance()

void read_next_instance	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.read_next_instance

References DataReader.read_next_instance_untyped().

◆ take_next_instance()

void take_next_instance	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See also: com.rti.ndds.example.FooDataReader.take_next_instance

References DataReader.take_next_instance_untyped().

◆ read_next_instance_w_condition()

void read_next_instance_w_condition	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also: com.rti.ndds.example.FooDataReader.read_next_instance_w_condition

References DataReader.read_next_instance_w_condition_untyped().

◆ take_next_instance_w_condition()

void take_next_instance_w_condition	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also: com.rti.ndds.example.FooDataReader.take_next_instance_w_condition

References DataReader.take_next_instance_w_condition_untyped().

◆ return_loan()

void return_loan	(	KeyedStringSeq	received_data,
		SampleInfoSeq	info_seq
	)

Indicates to the com.rti.dds.subscription.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 com.rti.dds.subscription.DataReader.