KeyedStringDataReader Class Reference
[KeyedString Built-in Type]

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

Inheritance diagram for KeyedStringDataReader:

List of all members.

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.
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.
void	read_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.KeyedStringDataReader.read the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
void	take_w_condition (KeyedStringSeq received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition condition)
	Analogous to com.rti.dds.type.builtin.KeyedStringDataReader.read_w_condition except it accesses samples via the com.rti.dds.type.builtin.KeyedStringDataReader.take operation.
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.
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.
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.
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.
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.KeyedStringDataReader.read_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
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.KeyedStringDataReader.take_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
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.
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.
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.KeyedStringDataReader.read_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
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.KeyedStringDataReader.take_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
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.
void	get_key_value (KeyedString key_holder, InstanceHandle_t handle)
	Retrieve the instance key that corresponds to an instance handle.
String	get_key_value (InstanceHandle_t handle)
	<<eXtension>> Retrieve the instance key that corresponds to an instance handle.
InstanceHandle_t	lookup_instance (KeyedString key_holder)
	Retrieve the instance handle that corresponds to an instance key_holder.
InstanceHandle_t	lookup_instance (String key)
	<<eXtension>> Retrieve the instance handle that corresponds to an instance key.

---

Detailed Description

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

See also:

com.rti.dds.topic.example.FooDataReader

com.rti.dds.subscription.DataReader

---

Member Function Documentation

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.dds.topic.example.FooDataReader.read

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.dds.topic.example.FooDataReader.take

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

Accesses via 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.dds.topic.example.FooDataReader.read_w_condition

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

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

See also:

com.rti.dds.topic.example.FooDataReader.take_w_condition

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.dds.topic.example.FooDataReader.read_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.dds.topic.example.FooDataReader.take_next_sample

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.dds.topic.example.FooDataReader.read_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.dds.topic.example.FooDataReader.take_instance

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.KeyedStringDataReader.read_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also:

com.rti.dds.topic.example.FooDataReader.read_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.KeyedStringDataReader.take_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also:

com.rti.dds.topic.example.FooDataReader.take_instance_w_condition

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.dds.topic.example.FooDataReader.read_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.dds.topic.example.FooDataReader.take_next_instance

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.KeyedStringDataReader.read_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also:

com.rti.dds.topic.example.FooDataReader.read_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.KeyedStringDataReader.take_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See also:

com.rti.dds.topic.example.FooDataReader.take_next_instance_w_condition

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.

See also:

com.rti.dds.topic.example.FooDataReader.return_loan

void get_key_value	(	KeyedString	key_holder,
		InstanceHandle_t	handle
	)

Retrieve the instance key that corresponds to an instance handle.

See also:

com.rti.dds.topic.example.FooDataReader.get_key_value

String get_key_value

(

InstanceHandle_t

handle

)

<<eXtension>> Retrieve the instance key that corresponds to an instance handle.

See also:

com.rti.dds.topic.example.FooDataReader.get_key_value

InstanceHandle_t lookup_instance

(

KeyedString

key_holder

)

Retrieve the instance handle that corresponds to an instance key_holder.

See also:

com.rti.dds.topic.example.FooDataReader.lookup_instance

InstanceHandle_t lookup_instance

(

String

key

)

<<eXtension>> Retrieve the instance handle that corresponds to an instance key.

See also:

com.rti.dds.topic.example.FooDataReader.lookup_instance