OpenMAMA C++ API
Wombat::MamaMsgQual Class Reference

The MamaMsgQual class is a wrapper/utility class which provides useful interrogation, comparison and manipulation facilities for the Mama Message Qualifier data field (wMsgQual) which is a "bit-map" used to convey duplicate, delayed and out-of-sequence information about messages. More...

#include <MamaMsgQual.h>

Public Member Functions

 MamaMsgQual ()
 
 MamaMsgQual (mama_u16_t value)
 
 MamaMsgQual (const MamaMsgQual &copy)
 
 ~MamaMsgQual ()
 
MamaMsgQualoperator= (const MamaMsgQual &rhs)
 
bool operator== (const MamaMsgQual &rhs) const
 
bool operator== (mama_u16_t rhs) const
 
bool operator!= (const MamaMsgQual &rhs) const
 
bool operator!= (mama_u16_t rhs) const
 
void clear ()
 
void setValue (mama_u16_t value)
 
void setIsDefinatelyDuplicate (bool tf)
 
void setIsPossiblyDuplicate (bool tf)
 
void setIsDefinatelyDelayed (bool tf)
 
void setIsPossiblyDelayed (bool tf)
 
void setIsOutOfSequence (bool tf)
 
mama_u16_t getValue () const
 
bool getIsDefinatelyDuplicate () const
 
bool getIsPossiblyDuplicate () const
 
bool getIsDefinatelyDelayed () const
 
bool getIsPossiblyDelayed () const
 
bool getIsOutOfSequence () const
 
void getAsString (char *result, mama_size_t maxLen) const
 
const char * getAsString () const
 Return a string representation of the message qualifier. More...
 

Static Public Member Functions

static void getAsString (const mama_u16_t &value, char *result, mama_size_t maxLen)
 Static helper function to convert from the raw 16bit integer representation directly to a colon delimited string of conditions. More...
 

Detailed Description

The MamaMsgQual class is a wrapper/utility class which provides useful interrogation, comparison and manipulation facilities for the Mama Message Qualifier data field (wMsgQual) which is a "bit-map" used to convey duplicate, delayed and out-of-sequence information about messages.

Constructor & Destructor Documentation

§ MamaMsgQual() [1/3]

Wombat::MamaMsgQual::MamaMsgQual ( )

§ MamaMsgQual() [2/3]

Wombat::MamaMsgQual::MamaMsgQual ( mama_u16_t  value)

§ MamaMsgQual() [3/3]

Wombat::MamaMsgQual::MamaMsgQual ( const MamaMsgQual copy)

§ ~MamaMsgQual()

Wombat::MamaMsgQual::~MamaMsgQual ( )

Member Function Documentation

§ operator=()

MamaMsgQual& Wombat::MamaMsgQual::operator= ( const MamaMsgQual rhs)

§ operator==() [1/2]

bool Wombat::MamaMsgQual::operator== ( const MamaMsgQual rhs) const

§ operator==() [2/2]

bool Wombat::MamaMsgQual::operator== ( mama_u16_t  rhs) const

§ operator!=() [1/2]

bool Wombat::MamaMsgQual::operator!= ( const MamaMsgQual rhs) const
inline

§ operator!=() [2/2]

bool Wombat::MamaMsgQual::operator!= ( mama_u16_t  rhs) const
inline

§ clear()

void Wombat::MamaMsgQual::clear ( )

§ setValue()

void Wombat::MamaMsgQual::setValue ( mama_u16_t  value)

§ setIsDefinatelyDuplicate()

void Wombat::MamaMsgQual::setIsDefinatelyDuplicate ( bool  tf)

§ setIsPossiblyDuplicate()

void Wombat::MamaMsgQual::setIsPossiblyDuplicate ( bool  tf)

§ setIsDefinatelyDelayed()

void Wombat::MamaMsgQual::setIsDefinatelyDelayed ( bool  tf)

§ setIsPossiblyDelayed()

void Wombat::MamaMsgQual::setIsPossiblyDelayed ( bool  tf)

§ setIsOutOfSequence()

void Wombat::MamaMsgQual::setIsOutOfSequence ( bool  tf)

§ getValue()

mama_u16_t Wombat::MamaMsgQual::getValue ( ) const

§ getIsDefinatelyDuplicate()

bool Wombat::MamaMsgQual::getIsDefinatelyDuplicate ( ) const

§ getIsPossiblyDuplicate()

bool Wombat::MamaMsgQual::getIsPossiblyDuplicate ( ) const

§ getIsDefinatelyDelayed()

bool Wombat::MamaMsgQual::getIsDefinatelyDelayed ( ) const

§ getIsPossiblyDelayed()

bool Wombat::MamaMsgQual::getIsPossiblyDelayed ( ) const

§ getIsOutOfSequence()

bool Wombat::MamaMsgQual::getIsOutOfSequence ( ) const

§ getAsString() [1/3]

void Wombat::MamaMsgQual::getAsString ( char *  result,
mama_size_t  maxLen 
) const

§ getAsString() [2/3]

const char* Wombat::MamaMsgQual::getAsString ( ) const

Return a string representation of the message qualifier.

Note that the alternative getAsString() method is more efficient because this method must allocate a temporary buffer (automatically destroyed upon object destruction).

§ getAsString() [3/3]

static void Wombat::MamaMsgQual::getAsString ( const mama_u16_t &  value,
char *  result,
mama_size_t  maxLen 
)
static

Static helper function to convert from the raw 16bit integer representation directly to a colon delimited string of conditions.