Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Msg

Message Log Data
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/msg.hh"


public function member index:

Msg(); Default Constructor.
Msg(const Msg& msg); Copy Constructor.
Msg(const std::string& alarm, const std::string& message, INT_4U severity, const Time& gtime); Constructor
const std::string& getAlarm() const;
virtual INT_2U getClassId() const;
inline const Time& getGTime() const; Get message GPS time.
inline const std::string& getMessage() const; Get Message
static SH getSH(); Get Structure Header
static SH getSH3(); Frame data version 3 and 4 definition
inline INT_4U getSeverity() const; Get Severity
inline bool operator !=(const Msg& msg) const; Not-equal comparison.
const Msg& operator +=(const Msg&); += Operator.
const Msg& operator =(const Msg&); Assignment Operator.
bool operator ==(const Msg& msg) const; Equal comparison.
 

private function member index:

static Msg* read(FrameReaderBase& in); Reads a Msg object from an Input object.
static Msg* read3(FrameReaderBase& in); Frame data versions 3 and 4 reader
virtual void write(Output& out) const; Writes a Msg object to an Output object.
 

Description:

This class represents message log data. It is modeled after the FrMsg structure in the Frame Specification, LIGO-T970130-B-E.

The Msg class has the following attributes:
AttributeDescription
alarmName of message, error flag or alarm state
messageMessage body
severityMessage severity level
GTimeGPS time in seconds and nanoseconds


Function Member Descriptions:


FrameCPP::Version_3_4_5::Msg::Msg - Default Constructor.


Msg();
This creates a Msg object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Msg::Msg - Copy Constructor.


Msg(const Msg& msg);

Parameters:
ParameterDescription
const Msg& msgObject to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Msg::Msg - Constructor


Msg(const std::string& alarm, const std::string& message, INT_4U severity, const Time& gtime);
This creates a log message with the specified values.

Parameters:
ParameterDescription
const std::string& alarmName of message, error flag or alarm state
const std::string& messageMessage body
INT_4U severityMessage severity level
const Time& gtimeGPS time in seconds and nanoseconds

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Msg::getAlarm


const std::string& getAlarm() const;



FrameCPP::Version_3_4_5::Msg::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Msg::getGTime - Get message GPS time.


inline const Time& getGTime() const;

Return value:
const Time&- GPS time.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Msg::getMessage - Get Message


inline const std::string& getMessage() const;
Get the message body.

Return value:
const std::string&- The message body

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Msg::getSH - Get Structure Header


static SH getSH();
Constructs the Structure Header for this class.

Return value:
SH- Msg structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Msg::getSH3 - Frame data version 3 and 4 definition


static SH getSH3();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Msg::getSeverity - Get Severity


inline INT_4U getSeverity() const;
Get the message severity level.

Return value:
INT_4U- The severity

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Msg::operator != - Not-equal comparison.


inline bool operator !=(const Msg& msg) const;

Parameters:
ParameterDescription
const Msg& msgThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Msg::operator += - += Operator.


const Msg& operator +=(const Msg&);

Parameters:
ParameterDescription
const Msg& msgObject to be added.

Return value:
const Msg&- This object.


FrameCPP::Version_3_4_5::Msg::operator = - Assignment Operator.


const Msg& operator =(const Msg&);

Parameters:
ParameterDescription
const Msg& msgObject to be assigned.

Return value:
const Msg&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Msg::operator == - Equal comparison.


bool operator ==(const Msg& msg) const;
Determines whether two Msg objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const Msg& msgThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Msg::read - Reads a Msg object from an Input object.


static Msg* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
Input& inInput data stream object.

Return value:
Msg*- Newly created.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::Msg::read3 - Frame data versions 3 and 4 reader


static Msg* read3(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::Msg::write - Writes a Msg object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& outOutput data object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Msg::mAlarm - Name of message, error flag or alarm state

std::string mAlarm;

FrameCPP::Version_3_4_5::Msg::mGTime - GPS time

Time mGTime;

FrameCPP::Version_3_4_5::Msg::mMessage - Message body

std::string mMessage;

FrameCPP::Version_3_4_5::Msg::mSeverity - Message severity level

INT_4U mSeverity;