RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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.
 
 SampleIdentity (const Guid &the_writer_guid, const SequenceNumber &the_sequence_number)
 Create a SampleIdentity with the provided Guid and SequenceNumber.
 
const Guidwriter_guid () const
 Get the 16-byte identifier identifying the virtual Guid.
 
Guidwriter_guid ()
 Get the 16-byte identifier identifying the virtual Guid.
 
const SequenceNumbersequence_number () const
 Get the monotonically increasing 64-bit SequenceNumber that identifies the sample in the data source.
 
SequenceNumbersequence_number ()
 Get the monotonically increasing 64-bit SequenceNumber that identifies the sample in the data source.
 

Static Public Member Functions

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

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.
 

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

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

Create a default SampleIdentity object.

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_guidThe Guid to create the SampleIdentity with
the_sequence_numberThe SequenceNumber to create the SampleIdentity with

Member Function Documentation

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

Get the 16-byte identifier identifying the virtual Guid.

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

Get the 16-byte identifier identifying the virtual Guid.

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

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

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

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

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

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

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

An invalid or unknown sample identity.

Friends And Related Function Documentation

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

Prints a SampleIdentity to an output stream.


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc