ldas-tools-framecpp
2.7.0
|
Message Log Data Structure Definition. More...
#include <FrMsg.hh>
Classes | |
struct | fr_msg_data_type |
Public Member Functions | |
FrMsg () | |
Default constructor. More... | |
FrMsg (const FrMsg &Source) | |
Copy Constructor. More... | |
FrMsg (const std::string &Alarm, const std::string &Message, INT_4U Severity, const GPSTime >ime) | |
Copy Constructor. More... | |
FrMsg (Previous::FrMsg &Source, istream_type *Stream) | |
Promotion Constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const std::string & | GetAlarm () const |
Retrieve the name of message, error flag, or alarm state. More... | |
const std::string & | GetMessage () const |
Retieve the message body. More... | |
INT_4U | GetSeverity () const |
Retieve the message severity level. More... | |
const GPSTime & | GetGTime () const |
Retrieve the GPS time corresponding to this FrMsg. More... | |
FrMsg & | Merge (const FrMsg &RHS) |
Merge with another FrMsg. More... | |
bool | operator== (const FrMsg &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
FrMsg () | |
Default constructor. More... | |
FrMsg (const FrMsg &Source) | |
Copy Constructor. More... | |
FrMsg (const std::string &Alarm, const std::string &Message, INT_4U Severity, const GPSTime >ime) | |
Copy Constructor. More... | |
FrMsg (Previous::FrMsg &Source, istream_type *Stream) | |
Promotion Constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const std::string & | GetAlarm () const |
Retrieve the name of message, error flag, or alarm state. More... | |
const std::string & | GetMessage () const |
Retieve the message body. More... | |
INT_4U | GetSeverity () const |
Retieve the message severity level. More... | |
const GPSTime & | GetGTime () const |
Retrieve the GPS time corresponding to this FrMsg. More... | |
FrMsg & | Merge (const FrMsg &RHS) |
Merge with another FrMsg. More... | |
bool | operator== (const FrMsg &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
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) |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrMsg * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrMsg * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
Private Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
FrMsg (istream_type &Stream) | |
Stream Constructor. More... | |
FrMsg (istream_type &Stream) | |
Stream Constructor. More... | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual More... | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual More... | |
Private Attributes | |
fr_msg_data_type | m_data |
ChecksumType | m_chkSum |
Structure checksum. More... | |
Message Log Data Structure Definition.
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
private |
|
private |
|
inherited |
|
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, |
istream_type * | Stream | ||
) |
|
private |
Stream Constructor.
[in] | Stream | The stream from which the object is being read. |
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, |
istream_type * | Stream | ||
) |
|
private |
Stream Constructor.
[in] | Stream | The stream from which the object is being read. |
|
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, and FrameCPP::Version_8::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::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 |
|
protectedvirtual |
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. |
|
protectedvirtual |
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. |
const std::string & FrameCPP::Version_8::FrMsg::GetAlarm | ( | ) | const |
Retrieve the name of message, error flag, or alarm state.
const std::string& FrameCPP::Version_8::FrMsg::GetAlarm | ( | ) | const |
Retrieve the name of message, error flag, or alarm state.
|
inline |
|
inline |
|
inline |
Retieve the message body.
|
inline |
Retieve the message body.
|
inline |
Retieve the message severity level.
|
inline |
Retieve the message severity level.
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The 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. |
|
protectedvirtual |
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 >.
|
protectedvirtual |
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 >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
static |
|
static |
|
protectedvirtual |
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. |
|
protectedvirtual |
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. |
|
protectedvirtual |
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 >.
|
protectedvirtual |
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 >.
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
|
inlineinherited |
|
inherited |
|
protectedvirtual |
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.
|
protectedvirtual |
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.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
private |