Data Samples

DDS_SampleInfo, DDS_SampleStateKind, DDS_ViewStateKind, DDS_InstanceStateKind and associated elements More...

Modules
	Sample States
	DDS_SampleStateKind and associated elements
	View States
	DDS_ViewStateKind and associated elements
	Instance States
	DDS_InstanceStateKind and associated elements

Classes
struct	DDS_SampleInfo
	Information that accompanies each sample that is read or taken. More...
struct	DDS_SampleInfoSeq
	Declares IDL sequence < DDS_SampleInfo > . More...

Functions
void	DDS_SampleInfo_get_sample_identity (const struct DDS_SampleInfo *self, struct DDS_SampleIdentity_t *identity)
	<<extension>> Retrieves the identity of the sample
void	DDS_SampleInfo_get_related_sample_identity (const struct DDS_SampleInfo *self, struct DDS_SampleIdentity_t *related_identity)
	<<extension>> Retrieves the identity of a sample related to this one

Detailed Description

DDS_SampleInfo, DDS_SampleStateKind, DDS_ViewStateKind, DDS_InstanceStateKind and associated elements

Function Documentation

void DDS_SampleInfo_get_sample_identity	(	const struct DDS_SampleInfo *	self,
		struct DDS_SampleIdentity_t *	identity
	)

<<extension>> Retrieves the identity of the sample

The identity is composed of the DDS_SampleInfo::original_publication_virtual_guid and the DDS_SampleInfo::original_publication_virtual_sequence_number

See Also

DDS_SampleInfo_get_related_sample_identity

void DDS_SampleInfo_get_related_sample_identity	(	const struct DDS_SampleInfo *	self,
		struct DDS_SampleIdentity_t *	related_identity
	)

<<extension>> Retrieves the identity of a sample related to this one

A sample can be logically related to another sample, when the DDSDataWriter wrote it using DDS_WriteParams_t::related_sample_identity. By default, a sample does not have a related sample, and this operation returns DDS_UNKNOWN_SAMPLE_IDENTITY.

The related identity is composed of the DDS_SampleInfo::related_original_publication_virtual_guid and the DDS_SampleInfo::related_original_publication_virtual_sequence_number

See Also

DDS_WriteParams_t::related_sample_identity