ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrMsg Class Referenceabstract

Message Log Data Structure Definition. More...

#include <FrMsg.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.

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 &GTime)
 Copy Constructor.
 
 FrMsg (Previous::FrMsg &Source, istream_type *Stream)
 Promotion Constructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & GetAlarm () const
 Retrieve the name of message, error flag, or alarm state.
 
const std::string & GetMessage () const
 Retieve the message body.
 
INT_4U GetSeverity () const
 Retieve the message severity level.
 
const GPSTime & GetGTime () const
 Retrieve the GPS time corresponding to this FrMsg.
 
FrMsgMerge (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
 
 FrMsg ()
 Default constructor.
 
 FrMsg (const FrMsg &Source)
 Copy Constructor.
 
 FrMsg (const std::string &Alarm, const std::string &Message, INT_4U Severity, const GPSTime &GTime)
 Copy Constructor.
 
 FrMsg (Previous::FrMsg &Source, istream_type *Stream)
 Promotion Constructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & GetAlarm () const
 Retrieve the name of message, error flag, or alarm state.
 
const std::string & GetMessage () const
 Retieve the message body.
 
INT_4U GetSeverity () const
 Retieve the message severity level.
 
const GPSTime & GetGTime () const
 Retrieve the GPS time corresponding to this FrMsg.
 
FrMsgMerge (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_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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.
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version.
 
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.
 

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.
 
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.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrMsgpCreate (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.
 
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.
 
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.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrMsgpCreate (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.
 
virtual void pWrite (ostream_type &Stream) const=0
 Write the structure to the stream.
 

Detailed Description

Message Log Data Structure Definition.

Constructor & Destructor Documentation

◆ 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]SourceThe 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]AlarmName of message, error flag or alarm state.
[in]MessageMessage body
[in]SeverityMessage severity level.
[in]GTimeGPS time corresponding to this FrMsg.
Returns
A new instance of this object.

◆ FrMsg() [4/8]

FrameCPP::Version_8::FrMsg::FrMsg ( Previous::FrMsg &  Source,
istream_type *  Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of an FrAdcData object
Todo:
Need to replace the next reference

◆ 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]SourceThe 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]AlarmName of message, error flag or alarm state.
[in]MessageMessage body
[in]SeverityMessage severity level.
[in]GTimeGPS time corresponding to this FrMsg.
Returns
A new instance of this object.

◆ FrMsg() [8/8]

FrameCPP::Version_8::FrMsg::FrMsg ( Previous::FrMsg &  Source,
istream_type *  Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of an FrAdcData object

Member Function Documentation

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase &  Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream 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]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase &  Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream 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 self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type &  Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [2/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type &  Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ demote() [1/2]

FrMsg::demote_ret_type FrameCPP::Version_8::FrMsg::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.
Todo:
Replace next references

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrMsg::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ GetAlarm() [1/2]

const std::string & 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 std::string & 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.

◆ GetGTime() [1/2]

const GPSTime & FrameCPP::Version_8::FrMsg::GetGTime ( ) const
inline

Retrieve the GPS time corresponding to this FrMsg.

Returns
The GPS time corresponding to this FrMsg.

◆ GetGTime() [2/2]

const GPSTime & FrameCPP::Version_8::FrMsg::GetGTime ( ) const
inline

Retrieve the GPS time corresponding to this FrMsg.

Returns
The GPS time corresponding to this FrMsg.

◆ GetMessage() [1/2]

const std::string & FrameCPP::Version_8::FrMsg::GetMessage ( ) const
inline

Retieve the message body.

Returns
The message body.

◆ GetMessage() [2/2]

const std::string & FrameCPP::Version_8::FrMsg::GetMessage ( ) const
inline

Retieve the message body.

Returns
The message body.

◆ GetSeverity() [1/2]

INT_4U FrameCPP::Version_8::FrMsg::GetSeverity ( ) const
inline

Retieve the message severity level.

Returns
The message severity level.

◆ GetSeverity() [2/2]

INT_4U FrameCPP::Version_8::FrMsg::GetSeverity ( ) const
inline

Retieve the message severity level.

Returns
The message severity level.

◆ Merge() [1/2]

FrMsg & FrameCPP::Version_8::FrMsg::Merge ( const FrMsg RHS)

Merge with another FrMsg.

Parameters
[in]RHSThe source of the information to append to this FrMsg structure.
Returns
A reference to this object
Todo:
Need to implement Merge routine

◆ Merge() [2/2]

FrMsg & FrameCPP::Version_8::FrMsg::Merge ( const FrMsg RHS)

Merge with another FrMsg.

Parameters
[in]RHSThe source of the information to append to this FrMsg structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrMsg::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrMsg::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrMsg::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrMsg::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
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
inline

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrMsg::operator== ( const FrMsg RHS) const

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrMsg::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrMsg::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [1/2]

FrMsg * FrameCPP::Version_8::FrMsg::pCreate ( istream_type &  Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [2/2]

virtual FrMsg * FrameCPP::Version_8::FrMsg::pCreate ( istream_type &  Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ Promote() [1/2]

FrMsg::promote_ret_type FrameCPP::Version_8::FrMsg::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_8::FrMsg::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

FrMsg::promote_ret_type FrameCPP::Version_8::FrMsg::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrMsg::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/3]

void FrameCPP::Version_8::FrMsg::pWrite ( ostream_type &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ pWrite() [2/3]

virtual void FrameCPP::Version_8::FrMsg::pWrite ( ostream_type &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type &  Stream) const
protectedpure virtualinherited

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_8::FrMsg::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrMsg::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrMsg::StructName ( )
inlinestatic

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrMsg::StructName ( )
static

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ vTOCQuery() [1/2]

void FrameCPP::Version_8::FrMsg::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_8::FrMsg::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

The documentation for this class was generated from the following files: