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
	Stream Kinds
	DDS_StreamKind and associated elements

Classes
struct	DDS_CoherentSetInfo_t
	<<extension>> Type definition for a coherent set info. More...
struct	DDS_SampleInfo
	Information that accompanies each sample that is read or taken. More...
struct	DDS_SampleInfoSeq
	Declares IDL sequence < DDS_SampleInfo > . More...

Functions
DDS_Boolean	DDS_CoherentSetInfo_equals (const struct DDS_CoherentSetInfo_t *self, const struct DDS_CoherentSetInfo_t *other)
	Compares this CoherentSetInfo with another CoherentSetInfo for equality. More...
void	DDS_CoherentSetInfo_copy (struct DDS_CoherentSetInfo_t *self, const struct DDS_CoherentSetInfo_t *other)
	Copies another CoherentSetInfo into this CoherentSetInfo. More...
void	DDS_SampleInfo_get_sample_identity (const struct DDS_SampleInfo *self, struct DDS_SampleIdentity_t *identity)
	<<extension>> Retrieves the identity of the sample More...
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 More...

Detailed Description

DDS_SampleInfo, DDS_SampleStateKind, DDS_ViewStateKind, DDS_InstanceStateKind and associated elements

Function Documentation

DDS_CoherentSetInfo_equals()

DDS_Boolean DDS_CoherentSetInfo_equals	(	const struct DDS_CoherentSetInfo_t *	self,
		const struct DDS_CoherentSetInfo_t *	other
	)

Compares this CoherentSetInfo with another CoherentSetInfo for equality.

Parameters

self	<<in>> This CoherentSetInfo. Cannot be NULL.
other	<<in>> The other CoherentSetInfo to be compared with this GUID. Cannot be NULL.

Returns

DDS_BOOLEAN_TRUE if the two CoherentSetInfos have equal values, or DDS_BOOLEAN_FALSE otherwise.

DDS_CoherentSetInfo_copy()

void DDS_CoherentSetInfo_copy	(	struct DDS_CoherentSetInfo_t *	self,
		const struct DDS_CoherentSetInfo_t *	other
	)

Copies another CoherentSetInfo into this CoherentSetInfo.

Parameters

self	<<in>> This CoherentSetInfo. Cannot be NULL.
other	<<in>> The other CoherentSetInfo to be copied.

DDS_SampleInfo_get_sample_identity()

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

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