ldas-tools-framecpp 3.0.4
|
Message Log Data Structure Definition. More...
#include <FrMsg.hh>
Public Member Functions | |
FrMsg () | |
Default constructor. | |
FrMsg (const FrMsg &Source) | |
Copy Constructor. | |
FrMsg (const std::string &Alarm, const std::string &Message, INT_4U Severity, const GPSTime >ime) | |
Copy Constructor. | |
FrMsg (Previous::FrMsg &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
virtual | ~FrMsg () |
const alarm_type & | GetAlarm () const |
Retrieve the name of message, error flag, or alarm state. | |
FrMsg & | Merge (const FrMsg &RHS) |
Merge with another FrMsg. | |
bool | operator== (const FrMsg &RHS) const |
equality operator | |
FrMsg () | |
Default constructor. | |
FrMsg (const FrMsg &Source) | |
Copy Constructor. | |
FrMsg (const std::string &Alarm, const std::string &Message, INT_4U Severity, const GPSTime >ime) | |
Copy Constructor. | |
FrMsg (Previous::FrMsg &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
virtual | ~FrMsg () |
const alarm_type & | GetAlarm () const |
Retrieve the name of message, error flag, or alarm state. | |
FrMsg & | Merge (const FrMsg &RHS) |
Merge with another FrMsg. | |
bool | operator== (const FrMsg &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
bool | operator== (const FrMsgData &RHS) const |
equality operator | |
const message_type & | GetMessage () const |
severity_type | GetSeverity () const |
GTime_type | GetGTime () const |
void | SetAlarm (const alarm_type &Value) |
void | SetMessage (const message_type &Value) |
void | SetSeverity (severity_type Value) |
void | SetGTime (GTime_type Value) |
Static Public Member Functions | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream) |
Promote previous version of object to this version. | |
static const Common::Description * | StructDescription () |
The description of structure. | |
template<class T> | |
static int | DataType (const T *Data) |
template<class T> | |
static int | DataType (const T &Data) |
template<class T> | |
static int | DataType (const T *Data) |
template<class T> | |
static int | DataType (const T &Data) |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
static struct_name_type | FrameSpecName () |
static struct_name_type | StructName () |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. |
Static Public Attributes | |
static constexpr severity_type const | DEFAULT_SEVERITY { 0 } |
static struct_name_type | struct_name |
static struct_desc_type | struct_desc |
static struct_id_type | struct_id |
Protected Types | |
typedef STRING | io_alarm_type |
typedef STRING | io_message_type |
typedef INT_4U | io_gtimes_type |
typedef INT_4U | io_gtimen_type |
typedef STRING | internal_alarm_type |
typedef STRING | internal_message_type |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Demotes object to previous version of the frame spec. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Promotes object to another version of the frame spec. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual self_type * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. |
Protected Attributes | |
alarm_type | alarm |
Name of message, error flag or alarm state. | |
message_type | message |
Message body. | |
severity_type | severity |
Message severity level (To Be Defined) | |
GTime_type | GTime |
GPS time coresponding to this FrMsg. |
Private Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
void | save (Archive &ar, const unsigned int version) const |
void | load (Archive &ar, const unsigned int version) |
Private Attributes | |
ChecksumType | m_chkSum |
Structure checksum. |
Message Log Data Structure Definition.
typedef FrMsgImpl::Data::alarm_type FrameCPP::Version_8::FrMsg::alarm_type |
typedef FrMsgImpl::Data::alarm_type FrameCPP::Version_8::FrMsg::alarm_type |
|
inherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef FrMsgImpl::Data::severity_type FrameCPP::Version_8::FrMsg::severity_type |
typedef FrMsgImpl::Data::severity_type FrameCPP::Version_8::FrMsg::severity_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_8::FrMsg::FrMsg | ( | ) |
Default constructor.
FrameCPP::Version_8::FrMsg::FrMsg | ( | const FrMsg & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_8::FrMsg::FrMsg | ( | const std::string & | Alarm, |
const std::string & | Message, | ||
INT_4U | Severity, | ||
const GPSTime & | GTime ) |
Copy Constructor.
[in] | Alarm | Name of message, error flag or alarm state. |
[in] | Message | Message body |
[in] | Severity | Message severity level. |
[in] | GTime | GPS time corresponding to this FrMsg. |
FrameCPP::Version_8::FrMsg::FrMsg | ( | Previous::FrMsg & | Source, |
stream_base_type * | Stream ) |
|
virtual |
FrameCPP::Version_8::FrMsg::FrMsg | ( | ) |
Default constructor.
FrameCPP::Version_8::FrMsg::FrMsg | ( | const FrMsg & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_8::FrMsg::FrMsg | ( | const std::string & | Alarm, |
const std::string & | Message, | ||
INT_4U | Severity, | ||
const GPSTime & | GTime ) |
Copy Constructor.
[in] | Alarm | Name of message, error flag or alarm state. |
[in] | Message | Message body |
[in] | Severity | Message severity level. |
[in] | GTime | GPS time corresponding to this FrMsg. |
FrameCPP::Version_8::FrMsg::FrMsg | ( | Previous::FrMsg & | Source, |
stream_base_type * | Stream ) |
|
virtual |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
const alarm_type & FrameCPP::Version_8::FrMsg::GetAlarm | ( | ) | const |
Retrieve the name of message, error flag, or alarm state.
const alarm_type & FrameCPP::Version_8::FrMsg::GetAlarm | ( | ) | const |
Retrieve the name of message, error flag, or alarm state.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineprivateinherited |
|
inlineprotectedvirtualinherited |
The name structure name of this object.
|
inlineinherited |
equality operator
[in] | RHS | The fr_msg_data_type object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
bool FrameCPP::Version_8::FrMsg::operator== | ( | const FrMsg & | RHS | ) | const |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
|
virtualinherited |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
staticinherited |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprivateinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
|
inlineinherited |
|
inherited |
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
protectedinherited |
Name of message, error flag or alarm state.
|
staticconstexpr |
|
protectedinherited |
GPS time coresponding to this FrMsg.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
protectedinherited |
Message body.
|
protectedinherited |
Message severity level (To Be Defined)
|
staticinherited |
|
staticinherited |
|
staticinherited |