FilterSampleInfo Class Reference

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

Inherits Struct.

Public Attributes
SampleIdentity_t	related_sample_identity
	The identity of another sample related to this one.
GUID_t	related_reader_guid
	Identifies a DataReader that is logically related to the sample.
GUID_t	related_source_guid
	Identifies the application logical data source that is related to the sample being written.

Additional Inherited Members
Public Member Functions inherited from Struct
abstract boolean	equals (Object obj)
abstract int	hashCode ()
String	toString ()
Protected Member Functions inherited from Struct
	Struct ()
abstract void	pull_from_nativeI (long native_status)
abstract void	push_to_nativeI (long native_status)

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

SampleIdentity_t 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 com.rti.dds.publication.DataWriter created by a Replier uses this field to associate the identity of the request sample with a reponse sample.

To specify that there is no related sample identity, use the value com.rti.dds.infrastructure.SampleIdentity_t.SampleIdentity_t.UNKNOWN_SAMPLE_IDENTITY.

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

GUID_t related_reader_guid

Identifies a DataReader that is logically related to the sample.

The related_reader_guid can be set by using the field com.rti.dds.infrastructure.WriteParams_t.related_reader_guid when writing a sample using the method com.rti.ndds.example.FooDataWriter.write_w_params.

GUID_t 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 com.rti.dds.infrastructure.WriteParams_t.related_source_guid when writing a sample using the method com.rti.ndds.example.FooDataWriter.write_w_params.