ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::v5::FrMsgData Class Reference

Storage space for FrMsg information. More...

#include <FrMsg.hh>

Inheritance diagram for FrameCPP::v5::FrMsgData:
Inheritance graph
[legend]

Public Types

typedef FR_MSG_ALARM_TYPE alarm_type
typedef FR_MSG_MESSAGE_TYPE message_type
typedef FR_MSG_SEVERITY_TYPE severity_type
typedef FR_MSG_GTIME_TYPE GTime_type
typedef FR_MSG_ALARM_TYPE alarm_type
typedef FR_MSG_MESSAGE_TYPE message_type
typedef FR_MSG_SEVERITY_TYPE severity_type
typedef FR_MSG_GTIME_TYPE GTime_type

Public Member Functions

const alarm_type & GetAlarm () const
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)
bool operator== (const FrMsgData &RHS) const
 equality operator
const alarm_type & GetAlarm () const
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)
bool operator== (const FrMsgData &RHS) const
 equality operator

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.

Detailed Description

Storage space for FrMsg information.

This stores information about an FrMsg element that needs to persist beyond an I/O operation

Member Typedef Documentation

◆ alarm_type [1/2]

typedef FR_MSG_ALARM_TYPE FrameCPP::v5::FrMsgData::alarm_type

◆ alarm_type [2/2]

typedef FR_MSG_ALARM_TYPE FrameCPP::v5::FrMsgData::alarm_type

◆ GTime_type [1/2]

typedef FR_MSG_GTIME_TYPE FrameCPP::v5::FrMsgData::GTime_type

◆ GTime_type [2/2]

typedef FR_MSG_GTIME_TYPE FrameCPP::v5::FrMsgData::GTime_type

◆ message_type [1/2]

typedef FR_MSG_MESSAGE_TYPE FrameCPP::v5::FrMsgData::message_type

◆ message_type [2/2]

typedef FR_MSG_MESSAGE_TYPE FrameCPP::v5::FrMsgData::message_type

◆ severity_type [1/2]

typedef FR_MSG_SEVERITY_TYPE FrameCPP::v5::FrMsgData::severity_type

◆ severity_type [2/2]

typedef FR_MSG_SEVERITY_TYPE FrameCPP::v5::FrMsgData::severity_type

Member Function Documentation

◆ GetAlarm() [1/2]

const alarm_type & FrameCPP::v5::FrMsgData::GetAlarm ( ) const
inline

◆ GetAlarm() [2/2]

const alarm_type & FrameCPP::v5::FrMsgData::GetAlarm ( ) const
inline

◆ GetGTime() [1/2]

GTime_type FrameCPP::v5::FrMsgData::GetGTime ( ) const
inline

◆ GetGTime() [2/2]

GTime_type FrameCPP::v5::FrMsgData::GetGTime ( ) const
inline

◆ GetMessage() [1/2]

const message_type & FrameCPP::v5::FrMsgData::GetMessage ( ) const
inline

◆ GetMessage() [2/2]

const message_type & FrameCPP::v5::FrMsgData::GetMessage ( ) const
inline

◆ GetSeverity() [1/2]

severity_type FrameCPP::v5::FrMsgData::GetSeverity ( ) const
inline

◆ GetSeverity() [2/2]

severity_type FrameCPP::v5::FrMsgData::GetSeverity ( ) const
inline

◆ operator==() [1/2]

bool FrameCPP::v5::FrMsgData::operator== ( const FrMsgData & RHS) const
inline

equality operator

Parameters
[in]RHSThe 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/2]

bool FrameCPP::v5::FrMsgData::operator== ( const FrMsgData & RHS) const
inline

equality operator

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

◆ SetAlarm() [1/2]

void FrameCPP::v5::FrMsgData::SetAlarm ( const alarm_type & Value)
inline

◆ SetAlarm() [2/2]

void FrameCPP::v5::FrMsgData::SetAlarm ( const alarm_type & Value)
inline

◆ SetGTime() [1/2]

void FrameCPP::v5::FrMsgData::SetGTime ( GTime_type Value)
inline

◆ SetGTime() [2/2]

void FrameCPP::v5::FrMsgData::SetGTime ( GTime_type Value)
inline

◆ SetMessage() [1/2]

void FrameCPP::v5::FrMsgData::SetMessage ( const message_type & Value)
inline

◆ SetMessage() [2/2]

void FrameCPP::v5::FrMsgData::SetMessage ( const message_type & Value)
inline

◆ SetSeverity() [1/2]

void FrameCPP::v5::FrMsgData::SetSeverity ( severity_type Value)
inline

◆ SetSeverity() [2/2]

void FrameCPP::v5::FrMsgData::SetSeverity ( severity_type Value)
inline

Member Data Documentation

◆ alarm

alarm_type FrameCPP::v5::FrMsgData::alarm
protected

Name of message, error flag or alarm state.

◆ GTime

GTime_type FrameCPP::v5::FrMsgData::GTime
protected

GPS time coresponding to this FrMsg.

◆ message

message_type FrameCPP::v5::FrMsgData::message
protected

Message body.

◆ severity

severity_type FrameCPP::v5::FrMsgData::severity
protected

Message severity level (To Be Defined)

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/storage/data/v5/FrMsg.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/storage/data/v5/FrMsg.hh