rti::core::SampleFlag Class Reference

<<extension>> A set of flags that can be associated with a sample. More...

#include "rti/core/SampleFlag.hpp"

Inherits bitset< 32 >.

Public Types
typedef std::bitset< 32 >	MaskType
	A typedef of std::bitset<32> for convenience.

Public Member Functions
	SampleFlag ()
	Construct an empty SampleFlag with no bits set.
	SampleFlag (uint64_t mask)
	Construct a SampleFlag from an integer.
	SampleFlag (const MaskType &mask)
	Construct a SampleFlag from a MaskType object.

Static Public Member Functions
static const SampleFlag	redelivered ()
	Indicates that a sample has been redelivered by RTI Queuing Service.
static const SampleFlag	intermediate_reply_sequence ()
	Indicates that a response sample is not the last response sample for a given request. This bit is usually set by Connext Repliers sending multiple responses for a request.
static const SampleFlag	replicate ()
	Indicates if a sample must be broadcast by one RTI Queuing Service replica to other replicas.
static const SampleFlag	last_shared_reader_queue ()
	Indicates that a sample is the last sample in a SharedReaderQueue for a QueueConsumer DataReader.
static const SampleFlag	intermediate_topic_query_sample ()
	Indicates that a sample for a TopicQuery will be followed by more samples.

Detailed Description

<<extension>> A set of flags that can be associated with a sample.

A set of flags that can be associated with a sample.

• Least-significant bits [0-7] are reserved by RTI
• Least-significant bits [8-15] are application specific
• Least-significant bits [15-31] are invalid and cannot be used

Member Typedef Documentation

typedef std::bitset<32> rti::core::SampleFlag::MaskType

A typedef of std::bitset<32> for convenience.

Constructor & Destructor Documentation

rti::core::SampleFlag::SampleFlag ( )

inline

Construct an empty SampleFlag with no bits set.

rti::core::SampleFlag::SampleFlag ( uint64_t  mask )

inlineexplicit

Construct a SampleFlag from an integer.

Parameters

mask	Value whose bits are copied to the bitset positions

rti::core::SampleFlag::SampleFlag ( const MaskType &  mask )

inline

Construct a SampleFlag from a MaskType object.

Parameters

mask	A std::bitset<32> to construct this SampleFlag from

Member Function Documentation

static const SampleFlag rti::core::SampleFlag::redelivered ( )

inlinestatic

Indicates that a sample has been redelivered by RTI Queuing Service.

static const SampleFlag rti::core::SampleFlag::intermediate_reply_sequence ( )

inlinestatic

Indicates that a response sample is not the last response sample for a given request. This bit is usually set by Connext Repliers sending multiple responses for a request.

static const SampleFlag rti::core::SampleFlag::replicate ( )

inlinestatic

Indicates if a sample must be broadcast by one RTI Queuing Service replica to other replicas.

static const SampleFlag rti::core::SampleFlag::last_shared_reader_queue ( )

inlinestatic

Indicates that a sample is the last sample in a SharedReaderQueue for a QueueConsumer DataReader.

static const SampleFlag rti::core::SampleFlag::intermediate_topic_query_sample ( )

inlinestatic

Indicates that a sample for a TopicQuery will be followed by more samples.

This flag only applies to samples that have been published as a response to a rti::sub::TopicQuery.

When this bit is not set and dds::sub::SampleInfo::topic_query_guid is different from rti::core::Guid::unknown(), this sample is the last sample for that TopicQuery coming from the DataWriter identified by dds::sub::SampleInfo::original_publication_virtual_guid.