FilterSampleInfo Class Reference

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

Inherits Struct.

Public Attributes
SampleIdentity_t	related_sample_identity = new SampleIdentity_t()
	The identity of another sample related to this one.
int	priority = PRIORITY_UNDEFINED
	Positive integer designating the relative priority of the sample, used to determine the transmission order of pending transmissions.

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 = new SampleIdentity_t()

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.

int priority = PRIORITY_UNDEFINED

Positive integer designating the relative priority of the sample, used to determine the transmission order of pending transmissions.

To use publication priorities, the com.rti.dds.publication.DataWriterQos.publish_mode must be set for asynchronous publishing and the com.rti.dds.publication.DataWriter must use a com.rti.dds.publication.FlowController with a com.rti.dds.publication.FlowControllerSchedulingPolicy.FlowControllerSchedulingPolicy.HPF_FLOW_CONTROLLER_SCHED_POLICY

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