Class Index | Cross Index | Namespace Index |
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. |
The Msg class has the following attributes:
Attribute | Description |
alarm | Name of message, error flag or alarm state |
message | Message body |
severity | Message severity level |
GTime | GPS time in seconds and nanoseconds |
This creates a Msg object with the following properties:
- alarm = "none"
- message = ""
- severity = 0
- gtime = 0 seconds and 0 nanoseconds
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Msg& msg | Object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
This creates a log message with the specified values.
Parameters:
Parameter | Description |
const std::string& alarm | Name of message, error flag or alarm state |
const std::string& message | Message body |
INT_4U severity | Message severity level |
const Time& gtime | GPS time in seconds and nanoseconds |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Exceptions:
Exception | Description |
None. |
Return value:
const Time&- GPS time.
Exceptions:
Exception | Description |
None. | |
None. |
Get the message body.
Return value:
const std::string&- The message body
Exceptions:
Exception | Description |
None. | |
None. |
Constructs the Structure Header for this class.
Return value:
SH- Msg structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Get the message severity level.
Return value:
INT_4U- The severity
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const Msg& msg | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Msg& msg | Object to be added. |
Return value:
const Msg&- This object.
Parameters:
Parameter | Description |
const Msg& msg | Object to be assigned. |
Return value:
const Msg&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two Msg objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const Msg& msg | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
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:
Parameter | Description |
Input& in | Input data stream object. |
Return value:
Msg*- Newly created.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Parameters:
Parameter | Description |
Output& out | Output data object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |