← Documentation
ADS-IDAC Engine 5.0.0
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SystemAlarm Class Reference

#include <SystemAlarm.h>

Inheritance diagram for SystemAlarm:
[legend]
Collaboration diagram for SystemAlarm:
[legend]

Public Member Functions

 SystemAlarm ()
 
virtual ~SystemAlarm ()
 
void setTypeOfAlarm (DisplayType type)
 
DisplayType getTypeOfAlarm ()
 
void readInfoFromFile (std::ifstream &)
 
void copySystemAlarm (SystemAlarm &)
 
void saveSystemAlarmToFile (std::ofstream &)
 
void retrieveSystemAlarmFromFile (std::ifstream &)
 
- Public Member Functions inherited from AlarmElement
 AlarmElement ()
 
virtual ~AlarmElement ()
 
void copyAlarmElement (AlarmElement &)
 
void setAlarmName (std::string)
 
std::string getAlarmName ()
 
void readInfoFromFile (std::ifstream &)
 
void setCorrespondingIndicatorName (std::string)
 
void setDisplayedAlarmState (int)
 
void setImportanceOfTheAlarm (double)
 
void setDisplayedOperatorControlState (int)
 
std::string getCorrespondingIndicatorName ()
 
std::string getDisplayedAlarmStateString ()
 
int getDisplayedAlarmState ()
 
double getImportanceOfTheAlarm ()
 
int getDisplayedOperatorControlState ()
 
void setTimeRequiredToCheckThisAlarm (double)
 
double getTimeRequiredToCheckThisAlarm ()
 
void setTimeAtWhichThisAlarmIsActivated (double)
 
double getTimeAtWhichThisAlarmIsActivated ()
 
void saveAlarmElementToFile (std::ofstream &)
 
void retrieveAlarmElementFromFile (std::ifstream &)
 
bool checkIfIsIdenticalAlarmElement (AlarmElement &)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

DisplayType type_of_alarm
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 13 of file SystemAlarm.h.

Constructor & Destructor Documentation

◆ SystemAlarm()

SystemAlarm::SystemAlarm ( )

Definition at line 16 of file SystemAlarm.cpp.

◆ ~SystemAlarm()

SystemAlarm::~SystemAlarm ( )
virtual

Definition at line 20 of file SystemAlarm.cpp.

Member Function Documentation

◆ copySystemAlarm()

void SystemAlarm::copySystemAlarm ( SystemAlarm &  _sys_a)

Definition at line 29 of file SystemAlarm.cpp.

References AlarmElement::copyAlarmElement(), getTypeOfAlarm(), and type_of_alarm.

Referenced by ControlPanel::checkForNewAlarms(), AlarmControlPanelUnit::copyAlarmControlPanelUnit(), BranchSystemAlarmState::copyBranchSystemAlarmState(), and CommunicationAlarm::copyCommunicationAlarm().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getTypeOfAlarm()

DisplayType SystemAlarm::getTypeOfAlarm ( )

Definition at line 28 of file SystemAlarm.cpp.

References type_of_alarm.

Referenced by copySystemAlarm().

Here is the caller graph for this function:

◆ readInfoFromFile()

void SystemAlarm::readInfoFromFile ( std::ifstream &  )

Definition at line 24 of file SystemAlarm.cpp.

References AlarmElement::readInfoFromFile().

Referenced by AlarmControlPanelUnit::readInfoFromFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ retrieveSystemAlarmFromFile()

void SystemAlarm::retrieveSystemAlarmFromFile ( std::ifstream &  )

Definition at line 37 of file SystemAlarm.cpp.

References AlarmElement::retrieveAlarmElementFromFile(), and type_of_alarm.

Referenced by AlarmControlPanelUnit::retrieveAlarmControlPanelUnitFromFile(), BranchSystemAlarmState::retrieveBranchSystemAlarmStateFromFile(), and CommunicationAlarm::retrieveCommunicationAlarmFromFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ saveSystemAlarmToFile()

void SystemAlarm::saveSystemAlarmToFile ( std::ofstream &  )

Definition at line 33 of file SystemAlarm.cpp.

References AlarmElement::saveAlarmElementToFile(), and type_of_alarm.

Referenced by AlarmControlPanelUnit::saveAlarmControlPanelUnitToFile(), BranchSystemAlarmState::saveBranchSystemAlarmStateToFile(), and CommunicationAlarm::saveCommunicationAlarmToFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ serialize()

template<class Archive >
void SystemAlarm::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprivate

Definition at line 29 of file SystemAlarm.h.

References type_of_alarm.

◆ setTypeOfAlarm()

void SystemAlarm::setTypeOfAlarm ( DisplayType  type)

Definition at line 27 of file SystemAlarm.cpp.

References type_of_alarm.

Referenced by AlarmComponent::AlarmComponent(), AlarmParameter::AlarmParameter(), and AlarmTwoParameterDifference::AlarmTwoParameterDifference().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 27 of file SystemAlarm.h.

Member Data Documentation

◆ type_of_alarm

DisplayType SystemAlarm::type_of_alarm
private

Definition at line 25 of file SystemAlarm.h.

Referenced by copySystemAlarm(), getTypeOfAlarm(), retrieveSystemAlarmFromFile(), saveSystemAlarmToFile(), serialize(), and setTypeOfAlarm().

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