Provides meta information associated with the sample. More...

Public Attributes
struct DDS_SampleIdentity_t	related_sample_identity
	The identity of another sample related to this one. More...

struct DDS_GUID_t	related_source_guid
	Identifies the application logical data source that is related to the sample being written. More...

struct DDS_GUID_t	related_reader_guid
	Identifies a DataReader that is logically related to the sample. More...

struct DDS_SampleIdentity_t	sample_identity
	The identity of the sample. More...

struct DDS_GUID_t	source_guid
	Identifies the application logical data source associated with the sample being written. More...

Detailed Description

Provides meta information associated with the sample.

This can be used by a content filter to perform filtering on meta data.

Member Data Documentation

◆ related_sample_identity

struct DDS_SampleIdentity_t DDS_FilterSampleInfo::related_sample_identity

The identity of another sample related to this one.

The value of this field identifies another sample that is logically related to the one that is written. For example, the DDSDataWriter created by a Replier uses this field to associate the identity of the request sample with a response sample.

The related_sample_identity can be set using the field DDS_WriteParams_t::related_sample_identity when writing a sample using the method FooDataWriter::write_w_params.

Default value DDS_UNKNOWN_SAMPLE_IDENTITY denotes a sample not associated with any other sample.

A DDSDataReader can inspect the related sample identity of a received sample by accessing the fields DDS_SampleInfo::related_original_publication_virtual_guid and DDS_SampleInfo::related_original_publication_virtual_sequence_number.

◆ related_source_guid

struct DDS_GUID_t DDS_FilterSampleInfo::related_source_guid

Identifies the application logical data source that is related to the sample being written.

The related_source_guid can be set by using the field DDS_WriteParams_t::related_source_guid when writing a sample using the method FooDataWriter::write_w_params.

Default value DDS_GUID_UNKNOWN denotes a sample as lacking a related data source.

A DDSDataReader can inspect the related_source_guid of a received sample by accessing the field DDS_SampleInfo::related_source_guid.

◆ related_reader_guid

struct DDS_GUID_t DDS_FilterSampleInfo::related_reader_guid

Identifies a DataReader that is logically related to the sample.

The related_reader_guid can be set by using the field DDS_WriteParams_t::related_reader_guid when writing a sample using the method FooDataWriter::write_w_params.

Default value DDS_GUID_UNKNOWN denotes a sample without an associated DataReader.

A DDSDataReader can inspect the related_reader_guid of a received sample by accessing the field DDS_SampleInfo::related_source_guid.

◆ sample_identity

struct DDS_SampleIdentity_t DDS_FilterSampleInfo::sample_identity

The identity of the sample.

The value of this field uniquely identifies a sample within its source DataWriter.

The identity of a sample can be set by using the field DDS_WriteParams_t::identity when writing a sample using the method FooDataWriter::write_w_params.

Default value DDS_UNKNOWN_SAMPLE_IDENTITY can be used to let the DataWriter assign a default identity to a sample. In this case, sample_identity.writer_guid will be set to the GUID of the DataWriter, while sample_identity.sequence_number will be set to the next sequence number to be written by the DataWriter.

A DDSDataReader can inspect the identity of a received sample by accessing the fields DDS_SampleInfo::original_publication_virtual_guid and DDS_SampleInfo::original_publication_virtual_sequence_number.

◆ source_guid

struct DDS_GUID_t DDS_FilterSampleInfo::source_guid

Identifies the application logical data source associated with the sample being written.

The source_guid can be set by using the field DDS_WriteParams_t::source_guid when writing a sample using the method FooDataWriter::write_w_params.

Default value DDS_GUID_UNKNOWN denotes a sample without a logical data source associated with it.

A DDSDataReader can inspect the logical data source of a sample by accessing the field DDS_SampleInfo::source_guid.