DDSStringDataReader Class Reference
[String Built-in Type]

<<interface>> Instantiates DataReader < char* >. More...

Inheritance diagram for DDSStringDataReader:

List of all members.

Public Member Functions
virtual DDS_ReturnCode_t	read (DDS_StringSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
	Access a collection of data samples from the DDSDataReader.
virtual DDS_ReturnCode_t	take (DDS_StringSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
	Access a collection of data-samples from the DDSDataReader.
virtual DDS_ReturnCode_t	read_w_condition (DDS_StringSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
	Accesses via DDSStringDataReader::read the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t	take_w_condition (DDS_StringSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
	Analogous to DDSStringDataReader::read_w_condition except it accesses samples via the DDSStringDataReader::take operation.
virtual DDS_ReturnCode_t	read_next_sample (char *received_data, DDS_SampleInfo &sample_info)
	Copies the next not-previously-accessed data value from the DDSDataReader.
virtual DDS_ReturnCode_t	take_next_sample (char *received_data, DDS_SampleInfo &sample_info)
	Copies the next not-previously-accessed data value from the DDSDataReader.
virtual DDS_ReturnCode_t	return_loan (DDS_StringSeq &received_data, DDS_SampleInfoSeq &info_seq)
	Indicates to the DDSDataReader 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 DDSDataReader.
Static Public Member Functions
static DDSStringDataReader *	narrow (DDSDataReader *reader)
	Narrow the given DDSDataReader pointer to a DDSStringDataReader pointer.

---

Detailed Description

<<interface>> Instantiates DataReader < char* >.

See also:

FooDataReader

DDSDataReader

String Support

---

Member Function Documentation

virtual DDS_ReturnCode_t DDSStringDataReader::read	(	DDS_StringSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples = DDS_LENGTH_UNLIMITED,
		DDS_SampleStateMask	sample_states = DDS_ANY_SAMPLE_STATE,
		DDS_ViewStateMask	view_states = DDS_ANY_VIEW_STATE,
		DDS_InstanceStateMask	instance_states = DDS_ANY_INSTANCE_STATE
	)			[virtual]

Access a collection of data samples from the DDSDataReader.

See also:

FooDataReader::read

virtual DDS_ReturnCode_t DDSStringDataReader::take	(	DDS_StringSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples = DDS_LENGTH_UNLIMITED,
		DDS_SampleStateMask	sample_states = DDS_ANY_SAMPLE_STATE,
		DDS_ViewStateMask	view_states = DDS_ANY_VIEW_STATE,
		DDS_InstanceStateMask	instance_states = DDS_ANY_INSTANCE_STATE
	)			[virtual]

Access a collection of data-samples from the DDSDataReader.

See also:

FooDataReader::take

virtual DDS_ReturnCode_t DDSStringDataReader::read_w_condition	(	DDS_StringSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples,
		DDSReadCondition *	condition
	)			[virtual]

Accesses via DDSStringDataReader::read the samples that match the criteria specified in the DDSReadCondition.

See also:

FooDataReader::read_w_condition

virtual DDS_ReturnCode_t DDSStringDataReader::take_w_condition	(	DDS_StringSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples,
		DDSReadCondition *	condition
	)			[virtual]

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

See also:

FooDataReader::take_w_condition

virtual DDS_ReturnCode_t DDSStringDataReader::read_next_sample	(	char *	received_data,
		DDS_SampleInfo &	sample_info
	)			[virtual]

Copies the next not-previously-accessed data value from the DDSDataReader.

See also:

FooDataReader::read_next_sample

virtual DDS_ReturnCode_t DDSStringDataReader::take_next_sample	(	char *	received_data,
		DDS_SampleInfo &	sample_info
	)			[virtual]

Copies the next not-previously-accessed data value from the DDSDataReader.

See also:

FooDataReader::take_next_sample

virtual DDS_ReturnCode_t DDSStringDataReader::return_loan	(	DDS_StringSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq
	)			[virtual]

Indicates to the DDSDataReader 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 DDSDataReader.

See also:

FooDataReader::return_loan

static DDSStringDataReader* DDSStringDataReader::narrow

(

DDSDataReader *

reader

)

[static]

Narrow the given DDSDataReader pointer to a DDSStringDataReader pointer.

See also:

FooDataReader::narrow