ldas-tools-framecpp  2.9.3
Public Types | Public Member Functions | Protected Attributes | List of all members
FrameCPP::v3::FrMsgData Class Reference

Storage space for FrMsg information. More...

#include <FrMsg.hh>

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_ALARM_TYPE alarm_type
 
typedef FR_MSG_MESSAGE_TYPE message_type
 
typedef FR_MSG_SEVERITY_TYPE severity_type
 
typedef FR_HISTORY_NAME_TYPE name_type
 
typedef FR_HISTORY_TIME_TYPE time_type
 
typedef FR_HISTORY_COMMENT_TYPE comment_type
 
typedef FR_MSG_ALARM_TYPE alarm_type
 
typedef FR_MSG_MESSAGE_TYPE message_type
 
typedef FR_MSG_SEVERITY_TYPE severity_type
 

Public Member Functions

const alarm_typeGetAlarm () const
 
const message_typeGetMessage () const
 
severity_type GetSeverity () const
 
void SetAlarm (const alarm_type &Value)
 
void SetMessage (const message_type &Value)
 
void SetSeverity (severity_type Value)
 
const alarm_typeGetAlarm () const
 
const message_typeGetMessage () const
 
severity_type GetSeverity () const
 
void SetAlarm (const alarm_type &Value)
 
void SetMessage (const message_type &Value)
 
void SetSeverity (severity_type Value)
 
const name_typeGetName () const
 
const comment_typeGetComment () const
 
time_type GetTime () const
 
void SetName (const name_type &Value)
 
void SetComment (const comment_type &Value)
 
void SetTime (time_type Value)
 
const alarm_typeGetAlarm () const
 
const message_typeGetMessage () const
 
severity_type GetSeverity () const
 
void SetAlarm (const alarm_type &Value)
 
void SetMessage (const message_type &Value)
 
void SetSeverity (severity_type Value)
 

Protected Attributes

alarm_type alarm
 Name of message, error flag or alarm state. More...
 
message_type message
 Message body. More...
 
severity_type severity
 Message severity level (To Be Defined) More...
 
name_type name
 Name of history record. More...
 
time_type time
 Time of post-processing. More...
 
comment_type comment
 

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/3]

◆ alarm_type [2/3]

◆ alarm_type [3/3]

◆ comment_type

◆ message_type [1/3]

◆ message_type [2/3]

◆ message_type [3/3]

◆ name_type

◆ severity_type [1/3]

◆ severity_type [2/3]

◆ severity_type [3/3]

◆ time_type

Member Function Documentation

◆ GetAlarm() [1/3]

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

◆ GetAlarm() [2/3]

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

◆ GetAlarm() [3/3]

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

◆ GetComment()

const comment_type& FrameCPP::v3::FrMsgData::GetComment ( ) const
inline

◆ GetMessage() [1/3]

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

◆ GetMessage() [2/3]

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

◆ GetMessage() [3/3]

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

◆ GetName()

const name_type& FrameCPP::v3::FrMsgData::GetName ( ) const
inline

◆ GetSeverity() [1/3]

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

◆ GetSeverity() [2/3]

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

◆ GetSeverity() [3/3]

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

◆ GetTime()

time_type FrameCPP::v3::FrMsgData::GetTime ( ) const
inline

◆ SetAlarm() [1/3]

void FrameCPP::v3::FrMsgData::SetAlarm ( const alarm_type Value)
inline

◆ SetAlarm() [2/3]

void FrameCPP::v3::FrMsgData::SetAlarm ( const alarm_type Value)
inline

◆ SetAlarm() [3/3]

void FrameCPP::v3::FrMsgData::SetAlarm ( const alarm_type Value)
inline

◆ SetComment()

void FrameCPP::v3::FrMsgData::SetComment ( const comment_type Value)
inline

◆ SetMessage() [1/3]

void FrameCPP::v3::FrMsgData::SetMessage ( const message_type Value)
inline

◆ SetMessage() [2/3]

void FrameCPP::v3::FrMsgData::SetMessage ( const message_type Value)
inline

◆ SetMessage() [3/3]

void FrameCPP::v3::FrMsgData::SetMessage ( const message_type Value)
inline

◆ SetName()

void FrameCPP::v3::FrMsgData::SetName ( const name_type Value)
inline

◆ SetSeverity() [1/3]

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

◆ SetSeverity() [2/3]

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

◆ SetSeverity() [3/3]

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

◆ SetTime()

void FrameCPP::v3::FrMsgData::SetTime ( time_type  Value)
inline

Member Data Documentation

◆ alarm

alarm_type FrameCPP::v3::FrMsgData::alarm
protected

Name of message, error flag or alarm state.

◆ comment

comment_type FrameCPP::v3::FrMsgData::comment
protected

Program name and releant comments needed to define post-processing

◆ message

message_type FrameCPP::v3::FrMsgData::message
protected

Message body.

◆ name

name_type FrameCPP::v3::FrMsgData::name
protected

Name of history record.

◆ severity

severity_type FrameCPP::v3::FrMsgData::severity
protected

Message severity level (To Be Defined)

◆ time

time_type FrameCPP::v3::FrMsgData::time
protected

Time of post-processing.


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