Fast DDS  Version 3.0.0
Fast DDS
Loading...
Searching...
No Matches
SampleIdentity Class Reference

This class is used to specify a sample. More...

#include <SampleIdentity.hpp>

Public Member Functions

 SampleIdentity ()
 Default constructor.
 
 SampleIdentity (const SampleIdentity &sample_id)
 Copy constructor.
 
 SampleIdentity (SampleIdentity &&sample_id)
 Move constructor.
 
SampleIdentityoperator= (const SampleIdentity &sample_id)
 Assignment operator.
 
SampleIdentityoperator= (SampleIdentity &&sample_id)
 Move constructor.
 
bool operator== (const SampleIdentity &sample_id) const
 
bool operator!= (const SampleIdentity &sample_id) const
 
bool operator< (const SampleIdentity &sample) const
 To allow using SampleIdentity as map key.
 
SampleIdentitywriter_guid (const GUID_t &guid)
 
SampleIdentitywriter_guid (GUID_t &&guid)
 
const GUID_twriter_guid () const
 
GUID_twriter_guid ()
 
SampleIdentitysequence_number (const SequenceNumber_t &seq)
 
SampleIdentitysequence_number (SequenceNumber_t &&seq)
 
const SequenceNumber_tsequence_number () const
 
SequenceNumber_tsequence_number ()
 

Static Public Member Functions

static SampleIdentity unknown ()
 

Friends

std::istream & operator>> (std::istream &input, SampleIdentity &sid)
 Stream operator, retrieves a GUID.
 
std::ostream & operator<< (std::ostream &output, const SampleIdentity &sid)
 Stream operator, prints a GUID.
 

Detailed Description

This class is used to specify a sample.

Constructor & Destructor Documentation

◆ SampleIdentity() [1/3]

SampleIdentity ( )
inline

Default constructor.

Constructs an unknown SampleIdentity.

◆ SampleIdentity() [2/3]

SampleIdentity ( const SampleIdentity sample_id)
inline

Copy constructor.

◆ SampleIdentity() [3/3]

SampleIdentity ( SampleIdentity &&  sample_id)
inline

Move constructor.

Member Function Documentation

◆ operator!=()

bool operator!= ( const SampleIdentity sample_id) const
inline

◆ operator<()

bool operator< ( const SampleIdentity sample) const
inline

To allow using SampleIdentity as map key.

Parameters
sample
Returns

◆ operator=() [1/2]

SampleIdentity & operator= ( const SampleIdentity sample_id)
inline

Assignment operator.

◆ operator=() [2/2]

SampleIdentity & operator= ( SampleIdentity &&  sample_id)
inline

Move constructor.

◆ operator==()

bool operator== ( const SampleIdentity sample_id) const
inline

◆ sequence_number() [1/4]

SequenceNumber_t & sequence_number ( )
inline

◆ sequence_number() [2/4]

const SequenceNumber_t & sequence_number ( ) const
inline

◆ sequence_number() [3/4]

SampleIdentity & sequence_number ( const SequenceNumber_t seq)
inline

◆ sequence_number() [4/4]

SampleIdentity & sequence_number ( SequenceNumber_t &&  seq)
inline

◆ unknown()

static SampleIdentity unknown ( )
inlinestatic

◆ writer_guid() [1/4]

GUID_t & writer_guid ( )
inline

◆ writer_guid() [2/4]

const GUID_t & writer_guid ( ) const
inline

◆ writer_guid() [3/4]

SampleIdentity & writer_guid ( const GUID_t guid)
inline

◆ writer_guid() [4/4]

SampleIdentity & writer_guid ( GUID_t &&  guid)
inline

Friends And Related Symbol Documentation

◆ operator<<

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

Stream operator, prints a GUID.

Parameters
outputOutput stream.
sidSampleIdentity to print.
Returns
Stream operator.

◆ operator>>

std::istream & operator>> ( std::istream &  input,
SampleIdentity sid 
)
friend

Stream operator, retrieves a GUID.

Parameters
inputInput stream.
sidSampleIdentity to read.
Returns
Stream operator.

The documentation for this class was generated from the following file: