rti::topic::FilterSampleInfo Class Reference

<<extension>> <<value-type>> Provides meta information associated with the sample. More...

#include <rti/topic/FilterSampleInfo.hpp>

Public Member Functions
rti::core::SampleIdentity	related_sample_identity () const
	Get the related sample identity of the sample being filtered. More...
rti::core::Guid	related_source_guid () const
	Get the related source GUID of the sample being filtered. More...
rti::core::Guid	related_reader_guid () const
	Get the related reader GUID of the sample being filtered. More...
rti::core::SampleIdentity	sample_identity () const
	Get the sample identity of the sample being filtered. More...
rti::core::Guid	source_guid () const
	Get the source GUID of the sample being filtered. More...
int32_t	priority () const
	Get the priority of the sample being filtered. More...

Detailed Description

<<extension>> <<value-type>> Provides meta information associated with the sample.

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

Member Function Documentation

related_sample_identity()

rti::core::SampleIdentity rti::topic::FilterSampleInfo::related_sample_identity ( ) const

inline

Get the related sample identity of the sample being filtered.

The value of this field identifies another sample that is logically related to the one that is written. For example, the dds::pub::DataWriter 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 rti::pub::WriteParams::related_sample_identity when writing a sample using the method dds::pub::DataWriter::write(const T&,rti::pub::WriteParams&).

Default value rti::core::SampleIdentity::unknown() denotes a sample not associated with any other sample.

A dds::sub::DataReader can inspect the related sample identity of a received sample by accessing the fields dds::sub::SampleInfo::related_original_publication_virtual_guid and dds::sub::SampleInfo::related_original_publication_virtual_sequence_number.

related_source_guid()

rti::core::Guid rti::topic::FilterSampleInfo::related_source_guid ( ) const

inline

Get the related source GUID of the sample being filtered.

The related_source_guid can be set by using the field rti::pub::WriteParams::related_source_guid when writing a sample using the method dds::pub::DataWriter::write(const T&,rti::pub::WriteParams&).

Default value rti::core::Guid::unknown() denotes a sample as lacking a related data source.

A dds::sub::DataReader can inspect the related_source_guid of a received sample by accessing the field dds::sub::SampleInfo::related_source_guid.

related_reader_guid()

rti::core::Guid rti::topic::FilterSampleInfo::related_reader_guid ( ) const

inline

Get the related reader GUID of the sample being filtered.

The related_reader_guid can be set by using the field rti::pub::WriteParams::related_reader_guid when writing a sample using the method dds::pub::DataWriter::write(const T&,rti::pub::WriteParams&).

Default value rti::core::Guid::unknown() denotes a sample without an associated DataReader.

A dds::sub::DataReader can inspect the related_reader_guid of a received sample by accessing the field dds::sub::SampleInfo::related_source_guid.

sample_identity()

rti::core::SampleIdentity rti::topic::FilterSampleInfo::sample_identity ( ) const

inline

Get the sample identity of the sample being filtered.

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 rti::pub::WriteParams::identity when writing a sample using the method dds::pub::DataWriter::write(const T&,rti::pub::WriteParams&).

Default value rti::core::SampleIdentity::unknown() 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 dds::sub::DataReader can inspect the identity of a received sample by accessing the fields dds::sub::SampleInfo::original_publication_virtual_guid and dds::sub::SampleInfo::original_publication_virtual_sequence_number.

source_guid()

rti::core::Guid rti::topic::FilterSampleInfo::source_guid ( ) const

inline

Get the source GUID of the sample being filtered.

The source_guid can be set by using the field rti::pub::WriteParams::source_guid when writing a sample using the method dds::pub::DataWriter::write(const T&,rti::pub::WriteParams&).

Default value rti::core::Guid::unknown() denotes a sample without a logical data source associated with it.

A dds::sub::DataReader can inspect the logical data source of a sample by accessing the field dds::sub::SampleInfo::source_guid.

priority()

int32_t rti::topic::FilterSampleInfo::priority ( ) const

inline

Get the priority of the sample being filtered.

To use publication priorities, the rti::core::policy::PublishMode must be set for asynchronous publishing and the dds::pub::DataWriter must use a rti::pub::FlowController with a FlowControllerSchedulingPolicy_def::HIGHEST_PRIORITY_FIRST

For Multi-channel DataWriters, the publication priority of a sample may be used as a filter criteria for determining channel membership.