SampleStateKind Class Reference

Indicates whether or not a sample has ever been read. More...

Static Public Attributes
static final int	READ_SAMPLE_STATE = 0x0001 << 0
	Sample has been read.
static final int	NOT_READ_SAMPLE_STATE = 0x0001 << 1
	Sample has not been read.
static final int	ANY_SAMPLE_STATE = 0xffff
	Any sample state com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ_SAMPLE_STATE | com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT_READ_SAMPLE_STATE.

Detailed Description

Indicates whether or not a sample has ever been read.

For each sample received, the middleware internally maintains a sample_state relative to each com.rti.dds.subscription.DataReader. The sample state can be either:

• com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ_SAMPLE_STATE indicates that the com.rti.dds.subscription.DataReader has already accessed that sample by means of a read or take operation.

• com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT_READ_SAMPLE_STATE indicates that the com.rti.dds.subscription.DataReader has not accessed that sample before.

The sample state will, in general, be different for each sample in the collection returned by read or take.

Member Data Documentation

final int READ_SAMPLE_STATE = 0x0001 << 0

static

Sample has been read.

final int NOT_READ_SAMPLE_STATE = 0x0001 << 1

static

Sample has not been read.