RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::SequenceNumber Class Reference

<<extension>> <<value-type>> A class representing the DDS 64-bit Sequence Number More...

#include <rti/core/SequenceNumber.hpp>

Public Member Functions

 SequenceNumber ()
 Create a default SequenceNumber, equal to unknown()
 
 SequenceNumber (int32_t high_value, uint32_t low_value)
 Create a SequenceNumber with the provided high and low values.
 
 SequenceNumber (int64_t the_value)
 Creates a SequenceNumber from an int64_t.
 
int32_t high () const
 Get the value of the most significant part of the sequence number.
 
SequenceNumberhigh (int32_t the_value)
 Set the value of the most significant part of the sequence number.
 
uint32_t low () const
 Get the value of the most significant part of the sequence number.
 
SequenceNumberlow (uint32_t the_value)
 Set the value of the least significant part of the sequence number.
 
long long value () const
 Get the value of the sequence number.
 
void value (long long value)
 Set the value of the sequence number.
 
SequenceNumber operator+ (const SequenceNumber &other) const
 Add two SequenceNumbers.
 
SequenceNumber operator- (const SequenceNumber &other) const
 Subtract one SequenceNumber from another.
 
SequenceNumberoperator+= (const SequenceNumber &other)
 Compound assignment operator, assigning the result of the addition to the current SequenceNumber object.
 
SequenceNumberoperator-= (const SequenceNumber &other)
 Compound assignment operator, assigning the result of the subtraction to the current SequenceNumber object.
 
SequenceNumber operator++ ()
 Pre-increment the value of the SequenceNumber by 1.
 
SequenceNumber operator++ (int)
 Post-increment the value of the SequenceNumber by 1.
 
SequenceNumber operator-- ()
 Pre-decrement the value of the SequenceNumber by 1.
 
SequenceNumber operator-- (int)
 Post-decrement the value of the SequenceNumber by 1.
 
bool operator< (const SequenceNumber &other) const
 Compare two SequenceNumbers for a less-than relationship.
 
bool operator<= (const SequenceNumber &other) const
 Compare two SequenceNumbers for a less-than-or-equal relationship.
 
bool operator> (const SequenceNumber &other) const
 Compare two SequenceNumbers for a greater-than relationship.
 
bool operator>= (const SequenceNumber &other) const
 Compare two SequenceNumbers for a greater-than-or-equal relationship.
 

Static Public Member Functions

static SequenceNumber zero ()
 Create a SequenceNumber representing 0.
 
static SequenceNumber unknown ()
 Create a SequenceNumber representing the unknown SequenceNumber value.
 
static SequenceNumber maximum ()
 Create a SequenceNumber representing the highest, most positive value for the sequence number.
 
static SequenceNumber automatic ()
 Create a SequenceNumber that will cause the value to be internally determined by RTI Connext.
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &out, const SequenceNumber &sn)
 Prints a SequenceNumber to an output stream.
 

Detailed Description

<<extension>> <<value-type>> A class representing the DDS 64-bit Sequence Number

Constructor & Destructor Documentation

rti::core::SequenceNumber::SequenceNumber ( )
inline

Create a default SequenceNumber, equal to unknown()

rti::core::SequenceNumber::SequenceNumber ( int32_t  high_value,
uint32_t  low_value 
)
inline

Create a SequenceNumber with the provided high and low values.

Parameters
high_valueThe value for the most significant part of the sequence number.
low_valueThe value for the least significant part of the sequence number.
rti::core::SequenceNumber::SequenceNumber ( int64_t  the_value)
inline

Creates a SequenceNumber from an int64_t.

Member Function Documentation

static SequenceNumber rti::core::SequenceNumber::zero ( )
inlinestatic

Create a SequenceNumber representing 0.

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

Create a SequenceNumber representing the unknown SequenceNumber value.

static SequenceNumber rti::core::SequenceNumber::maximum ( )
inlinestatic

Create a SequenceNumber representing the highest, most positive value for the sequence number.

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

Create a SequenceNumber that will cause the value to be internally determined by RTI Connext.

See Also
rti::core::WriteParams::replace_auto()
int32_t rti::core::SequenceNumber::high ( ) const
inline

Get the value of the most significant part of the sequence number.

SequenceNumber& rti::core::SequenceNumber::high ( int32_t  the_value)
inline

Set the value of the most significant part of the sequence number.

uint32_t rti::core::SequenceNumber::low ( ) const
inline

Get the value of the most significant part of the sequence number.

SequenceNumber& rti::core::SequenceNumber::low ( uint32_t  the_value)
inline

Set the value of the least significant part of the sequence number.

long long rti::core::SequenceNumber::value ( ) const

Get the value of the sequence number.

void rti::core::SequenceNumber::value ( long long  value)

Set the value of the sequence number.

SequenceNumber rti::core::SequenceNumber::operator+ ( const SequenceNumber other) const

Add two SequenceNumbers.

SequenceNumber rti::core::SequenceNumber::operator- ( const SequenceNumber other) const

Subtract one SequenceNumber from another.

SequenceNumber& rti::core::SequenceNumber::operator+= ( const SequenceNumber other)

Compound assignment operator, assigning the result of the addition to the current SequenceNumber object.

SequenceNumber& rti::core::SequenceNumber::operator-= ( const SequenceNumber other)

Compound assignment operator, assigning the result of the subtraction to the current SequenceNumber object.

SequenceNumber rti::core::SequenceNumber::operator++ ( )

Pre-increment the value of the SequenceNumber by 1.

SequenceNumber rti::core::SequenceNumber::operator++ ( int  )

Post-increment the value of the SequenceNumber by 1.

SequenceNumber rti::core::SequenceNumber::operator-- ( )

Pre-decrement the value of the SequenceNumber by 1.

SequenceNumber rti::core::SequenceNumber::operator-- ( int  )

Post-decrement the value of the SequenceNumber by 1.

bool rti::core::SequenceNumber::operator< ( const SequenceNumber other) const

Compare two SequenceNumbers for a less-than relationship.

bool rti::core::SequenceNumber::operator<= ( const SequenceNumber other) const

Compare two SequenceNumbers for a less-than-or-equal relationship.

bool rti::core::SequenceNumber::operator> ( const SequenceNumber other) const

Compare two SequenceNumbers for a greater-than relationship.

bool rti::core::SequenceNumber::operator>= ( const SequenceNumber other) const

Compare two SequenceNumbers for a greater-than-or-equal relationship.

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  out,
const SequenceNumber sn 
)
related

Prints a SequenceNumber to an output stream.


RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc