rti::core::SampleIdentity Class Reference

<<extension>> <<value-type>> A SampleIdentity defines a pair (Virtual Writer Guid, SequenceNumber) that uniquely identifies a sample within a DDS domain and a Topic. More...

#include "rti/core/SampleIdentity.hpp"

Public Member Functions
	SampleIdentity ()
	Create a default SampleIdentity object. More...
	SampleIdentity (const Guid &the_writer_guid, const SequenceNumber &the_sequence_number)
	Create a SampleIdentity with the provided Guid and SequenceNumber. More...
const Guid &	writer_guid () const
	Get the 16-byte identifier identifying the virtual Guid. More...
Guid &	writer_guid ()
	Get the 16-byte identifier identifying the virtual Guid. More...
const SequenceNumber &	sequence_number () const
	Get the monotonically increasing 64-bit SequenceNumber that identifies the sample in the data source. More...
SequenceNumber &	sequence_number ()
	Get the monotonically increasing 64-bit SequenceNumber that identifies the sample in the data source. More...

Static Public Member Functions
static SampleIdentity	automatic ()
	Special value to indicate that RTI Connext will automatically assign the identity of a sample. More...
static SampleIdentity	unknown ()
	An invalid or unknown sample identity. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &out, const SampleIdentity &sid)
	Prints a SampleIdentity to an output stream. More...

Detailed Description

<<extension>> <<value-type>> A SampleIdentity defines a pair (Virtual Writer Guid, SequenceNumber) that uniquely identifies a sample within a DDS domain and a Topic.

Constructor & Destructor Documentation

SampleIdentity() [1/2]

rti::core::SampleIdentity::SampleIdentity ( )

inline

Create a default SampleIdentity object.

SampleIdentity() [2/2]

rti::core::SampleIdentity::SampleIdentity ( const Guid &  the_writer_guid, const SequenceNumber &  the_sequence_number  )

inline

Create a SampleIdentity with the provided Guid and SequenceNumber.

Parameters

the_writer_guid	The Guid to create the SampleIdentity with
the_sequence_number	The SequenceNumber to create the SampleIdentity with

Member Function Documentation

writer_guid() [1/2]

const Guid& rti::core::SampleIdentity::writer_guid ( ) const

inline

Get the 16-byte identifier identifying the virtual Guid.

writer_guid() [2/2]

Guid& rti::core::SampleIdentity::writer_guid ( )

inline

Get the 16-byte identifier identifying the virtual Guid.

sequence_number() [1/2]

const SequenceNumber& rti::core::SampleIdentity::sequence_number ( ) const

inline

Get the monotonically increasing 64-bit SequenceNumber that identifies the sample in the data source.

sequence_number() [2/2]

SequenceNumber& rti::core::SampleIdentity::sequence_number ( )

inline

Get the monotonically increasing 64-bit SequenceNumber that identifies the sample in the data source.

automatic()

static SampleIdentity rti::core::SampleIdentity::automatic ( )

inlinestatic

Special value to indicate that RTI Connext will automatically assign the identity of a sample.

unknown()

static SampleIdentity rti::core::SampleIdentity::unknown ( )

inlinestatic

An invalid or unknown sample identity.

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  out, const SampleIdentity &  sid  )

related

Prints a SampleIdentity to an output stream.