Message Log Data Structure Definition.
More...
#include <FrMsg.hh>
|
| 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.
|
|
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.
|
|
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
|
|
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
|
|
|
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 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.
|
|
static const Common::Description * | StructDescription () |
| The description of structure.
|
|
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_desc_type | FrameSpecDescription () |
| Return the dictionary name of the structure.
|
|
static struct_id_type | FrameSpecId () |
| Return the dictionary name of the structure.
|
|
|
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 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 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.
|
|
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.
|
|
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 self_type * | pCreate (istream_type &Stream) const |
| Virtual constructor.
|
|
virtual void | pWrite (ostream_type &Stream) const |
| Write the structure to the stream.
|
|
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.
|
|
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
| Answer requests for information as needed by TOC.
|
|
|
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.
|
|
Message Log Data Structure Definition.
◆ FrMsg() [1/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
| ) |
|
Default constructor.
- Returns
- A new instance of this object.
◆ FrMsg() [2/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
const FrMsg & | Source | ) |
|
Copy Constructor.
- Parameters
-
[in] | Source | The object from which to copy the information. |
- Returns
- A new instance of this object.
◆ FrMsg() [3/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
const std::string & | Alarm, |
|
|
const std::string & | Message, |
|
|
INT_4U | Severity, |
|
|
const GPSTime & | GTime ) |
Copy Constructor.
- Parameters
-
[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. |
- Returns
- A new instance of this object.
◆ FrMsg() [4/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
Previous::FrMsg & | Source, |
|
|
stream_base_type * | Stream ) |
Promotion Constructor.
- Parameters
-
[in] | Source | An FrAdcData structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrAdcData structure was read. |
- Returns
- A new instance of an FrAdcData object
◆ FrMsg() [5/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
| ) |
|
Default constructor.
- Returns
- A new instance of this object.
◆ FrMsg() [6/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
const FrMsg & | Source | ) |
|
Copy Constructor.
- Parameters
-
[in] | Source | The object from which to copy the information. |
- Returns
- A new instance of this object.
◆ FrMsg() [7/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
const std::string & | Alarm, |
|
|
const std::string & | Message, |
|
|
INT_4U | Severity, |
|
|
const GPSTime & | GTime ) |
Copy Constructor.
- Parameters
-
[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. |
- Returns
- A new instance of this object.
◆ FrMsg() [8/8]
FrameCPP::Version_8::FrMsg::FrMsg |
( |
Previous::FrMsg & | Source, |
|
|
stream_base_type * | Stream ) |
Promotion Constructor.
- Parameters
-
[in] | Source | An FrAdcData structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrAdcData structure was read. |
- Returns
- A new instance of an FrAdcData object
◆ Bytes() [1/2]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
- Returns
- The number of bytes for this object
◆ Bytes() [2/2]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
- Returns
- The number of bytes for this object
◆ Create() [1/2]
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ Create() [2/2]
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ demote() [1/2]
template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::demote |
( |
INT_2U | Target, |
|
|
demote_arg_type | Obj, |
|
|
demote_stream_type * | Stream ) const |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
- Parameters
-
[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. |
- Returns
- An object of the previous generation.
- Todo
- Replace next references
◆ demote() [2/2]
template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::demote |
( |
INT_2U | Target, |
|
|
demote_arg_type | Obj, |
|
|
demote_stream_type * | Stream ) const |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
- Parameters
-
[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. |
- Returns
- An object of the previous generation.
- Todo
- Replace next references
◆ GetAlarm() [1/2]
const alarm_type & FrameCPP::Version_8::FrMsg::GetAlarm |
( |
| ) |
const |
Retrieve the name of message, error flag, or alarm state.
- Returns
- The name of message, error flag, or alarm state.
◆ GetAlarm() [2/2]
const alarm_type & FrameCPP::Version_8::FrMsg::GetAlarm |
( |
| ) |
const |
Retrieve the name of message, error flag, or alarm state.
- Returns
- The name of message, error flag, or alarm state.
◆ Merge() [1/2]
FrMsg & FrameCPP::Version_8::FrMsg::Merge |
( |
const FrMsg & | RHS | ) |
|
Merge with another FrMsg.
- Parameters
-
[in] | RHS | The source of the information to append to this FrMsg structure. |
- Returns
- A reference to this object
◆ Merge() [2/2]
FrMsg & FrameCPP::Version_8::FrMsg::Merge |
( |
const FrMsg & | RHS | ) |
|
Merge with another FrMsg.
- Parameters
-
[in] | RHS | The source of the information to append to this FrMsg structure. |
- Returns
- A reference to this object
◆ ObjectStructName() [1/2]
template<typename T >
virtual const char * FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::ObjectStructName |
( |
| ) |
const |
|
inlineprotectedvirtualinherited |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ ObjectStructName() [2/2]
template<typename T >
virtual const char * FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::ObjectStructName |
( |
| ) |
const |
|
inlineprotectedvirtualinherited |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ operator==() [1/4]
bool FrameCPP::v5::FrMsgData::operator== |
( |
const FrMsgData & | RHS | ) |
const |
|
inlineinherited |
equality operator
- Parameters
-
[in] | RHS | The fr_msg_data_type object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [2/4]
bool FrameCPP::Version_8::FrMsg::operator== |
( |
const FrMsg & | RHS | ) |
const |
|
inline |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [3/4]
bool FrameCPP::Version_8::FrMsg::operator== |
( |
const FrMsg & | RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [4/4]
equality operator for abstract data type
- Parameters
-
[in] | RHS | The object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ pBytes() [1/2]
template<typename T >
cmn_streamsize_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::pBytes |
( |
const Common::StreamBase & | Stream | ) |
const |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
- Parameters
-
[in] | Stream | The stream from which to the object is being read or written. |
- Returns
- The number of bytes need to read or write this object.
◆ pBytes() [2/2]
template<typename T >
cmn_streamsize_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::pBytes |
( |
const Common::StreamBase & | Stream | ) |
const |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
- Parameters
-
[in] | Stream | The stream from which to the object is being read or written. |
- Returns
- The number of bytes need to read or write this object.
◆ pCreate() [1/2]
template<typename T >
virtual self_type * FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::pCreate |
( |
istream_type & | Stream | ) |
const |
|
inlineprotectedvirtualinherited |
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
◆ pCreate() [2/2]
template<typename T >
virtual self_type * FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::pCreate |
( |
istream_type & | Stream | ) |
const |
|
inlineprotectedvirtualinherited |
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
◆ Promote() [1/2]
template<typename T >
ClassicIO< T >::promote_ret_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::Promote |
( |
INT_2U | Source, |
|
|
promote_arg_type | Obj, |
|
|
promote_stream_type * | Stream ) |
|
staticinherited |
Promote previous version of object to this version.
- Parameters
-
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
- Returns
- A new instance of FrameH based on Obj
◆ Promote() [2/2]
template<typename T >
static promote_ret_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::Promote |
( |
INT_2U | Source, |
|
|
promote_arg_type | Obj, |
|
|
promote_stream_type * | Stream ) |
|
staticinherited |
Promote previous version of object to this version.
- Parameters
-
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
- Returns
- A new instance of FrameH based on Obj
◆ promote() [1/2]
template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::promote |
( |
INT_2U | Target, |
|
|
promote_arg_type | Obj, |
|
|
promote_stream_type * | Stream ) const |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
- Parameters
-
[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. |
- Returns
- An object promoted to the next generation.
◆ promote() [2/2]
template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::promote |
( |
INT_2U | Target, |
|
|
promote_arg_type | Obj, |
|
|
promote_stream_type * | Stream ) const |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
- Parameters
-
[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. |
- Returns
- An object promoted to the next generation.
◆ pWrite() [1/2]
template<typename T >
virtual void FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::pWrite |
( |
ostream_type & | Stream | ) |
const |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ pWrite() [2/2]
template<typename T >
virtual void FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::pWrite |
( |
ostream_type & | Stream | ) |
const |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ StructDescription() [1/2]
template<typename T >
static const Common::Description * FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::StructDescription |
( |
| ) |
|
|
inlinestaticinherited |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ StructDescription() [2/2]
template<typename T >
static const Common::Description * FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::StructDescription |
( |
| ) |
|
|
inlinestaticinherited |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ vTOCQuery() [1/2]
template<typename T >
virtual void FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::vTOCQuery |
( |
int | InfoClass, |
|
|
va_list | vl ) const |
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
- Parameters
-
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
◆ vTOCQuery() [2/2]
template<typename T >
virtual void FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >::vTOCQuery |
( |
int | InfoClass, |
|
|
va_list | vl ) const |
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
- Parameters
-
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version8/FrMsg.hh
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4/src/Version8/FrMsg.hh