OpenMAMA
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
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.

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.

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

Wombat::MamaMsgQual::MamaMsgQual ( )
Wombat::MamaMsgQual::MamaMsgQual ( mama_u16_t  value)
Wombat::MamaMsgQual::MamaMsgQual ( const MamaMsgQual copy)
Wombat::MamaMsgQual::~MamaMsgQual ( )

Member Function Documentation

MamaMsgQual& Wombat::MamaMsgQual::operator= ( const MamaMsgQual rhs)
bool Wombat::MamaMsgQual::operator== ( const MamaMsgQual rhs) const
bool Wombat::MamaMsgQual::operator== ( mama_u16_t  rhs) const
bool Wombat::MamaMsgQual::operator!= ( const MamaMsgQual rhs) const
{
return ! operator== (rhs);
}
bool Wombat::MamaMsgQual::operator!= ( mama_u16_t  rhs) const
{
return ! operator== (rhs);
}
void Wombat::MamaMsgQual::clear ( )
void Wombat::MamaMsgQual::setValue ( mama_u16_t  value)
void Wombat::MamaMsgQual::setIsDefinatelyDuplicate ( bool  tf)
void Wombat::MamaMsgQual::setIsPossiblyDuplicate ( bool  tf)
void Wombat::MamaMsgQual::setIsDefinatelyDelayed ( bool  tf)
void Wombat::MamaMsgQual::setIsPossiblyDelayed ( bool  tf)
void Wombat::MamaMsgQual::setIsOutOfSequence ( bool  tf)
mama_u16_t Wombat::MamaMsgQual::getValue ( ) const
bool Wombat::MamaMsgQual::getIsDefinatelyDuplicate ( ) const
bool Wombat::MamaMsgQual::getIsPossiblyDuplicate ( ) const
bool Wombat::MamaMsgQual::getIsDefinatelyDelayed ( ) const
bool Wombat::MamaMsgQual::getIsPossiblyDelayed ( ) const
bool Wombat::MamaMsgQual::getIsOutOfSequence ( ) const
void Wombat::MamaMsgQual::getAsString ( char *  result,
mama_size_t  maxLen 
) const
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).

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.


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


© 2012 Linux Foundation