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

#include <AlarmParameter.h>

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

Public Member Functions

 AlarmParameter ()
 
virtual ~AlarmParameter ()
 
void readInfoFromFile (std::ifstream &)
 
int updateDisplayedAlarmState (ControlPanelDisplay &)
 
void setThresholdValueThatActivateTheAlarm (double)
 
void setRelationalOperatorToActivateTheAlarm (int)
 
double getThresholdValueThatActivateTheAlarm ()
 
int getRelationalOperatorToActivateTheAlarm ()
 
void copyAlarmParameter (AlarmParameter &)
 
void saveAlarmParameterToFile (std::ofstream &)
 
void retrieveAlarmParameterFromFile (std::ifstream &)
 
- Public Member Functions inherited from AlarmControlPanelUnit
 AlarmControlPanelUnit ()
 
virtual ~AlarmControlPanelUnit ()
 
void setFuncationalState (int state)
 
void setDisplayedAlarmStateWhenFail (int state)
 
int getFuncationalState ()
 
int getDisplayedAlarmStateWhenFail ()
 
void setPtrToCorrespondingIndicator (SystemDisplay *ptr)
 
SystemDisplay * getPtrToCorrespondingIndicator ()
 
void readInfoFromFile (std::ifstream &)
 
void copyAlarmControlPanelUnit (AlarmControlPanelUnit &)
 
void saveAlarmControlPanelUnitToFile (std::ofstream &)
 
void retrieveAlarmControlPanelUnitFromFile (std::ifstream &)
 
- Public Member Functions inherited from SystemAlarm
 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

double threshold_value_that_activate_the_alarm
 
int relational_operator_to_activate_the_alarm
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 14 of file AlarmParameter.h.

Constructor & Destructor Documentation

◆ AlarmParameter()

AlarmParameter::AlarmParameter ( )

Definition at line 19 of file AlarmParameter.cpp.

References AlarmParameter, relational_operator_to_activate_the_alarm, SystemAlarm::setTypeOfAlarm(), threshold_value_that_activate_the_alarm, and sim::State::Unknown.

Here is the call graph for this function:

◆ ~AlarmParameter()

AlarmParameter::~AlarmParameter ( )
virtual

Definition at line 26 of file AlarmParameter.cpp.

Member Function Documentation

◆ copyAlarmParameter()

void AlarmParameter::copyAlarmParameter ( AlarmParameter &  _ap)

Definition at line 215 of file AlarmParameter.cpp.

References AlarmControlPanelUnit::copyAlarmControlPanelUnit(), getRelationalOperatorToActivateTheAlarm(), getThresholdValueThatActivateTheAlarm(), relational_operator_to_activate_the_alarm, and threshold_value_that_activate_the_alarm.

Here is the call graph for this function:

◆ getRelationalOperatorToActivateTheAlarm()

int AlarmParameter::getRelationalOperatorToActivateTheAlarm ( )

Definition at line 65 of file AlarmParameter.cpp.

References relational_operator_to_activate_the_alarm.

Referenced by copyAlarmParameter().

Here is the caller graph for this function:

◆ getThresholdValueThatActivateTheAlarm()

double AlarmParameter::getThresholdValueThatActivateTheAlarm ( )

Definition at line 64 of file AlarmParameter.cpp.

References threshold_value_that_activate_the_alarm.

Referenced by copyAlarmParameter().

Here is the caller graph for this function:

◆ readInfoFromFile()

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

Definition at line 30 of file AlarmParameter.cpp.

References SimulationContext::Branch_center, sim::Compare::EQ, g_sim, sim::Compare::GE, AlarmElement::getAlarmName(), sim::Compare::GT, sim::Compare::LE, sim::Compare::LT, NoKB, r5pars_, AlarmControlPanelUnit::readInfoFromFile(), relational_operator_to_activate_the_alarm, BranchRecord::setTempESMessage(), BranchRecord::setTempTypeOfConsequence(), and threshold_value_that_activate_the_alarm.

Here is the call graph for this function:

◆ retrieveAlarmParameterFromFile()

void AlarmParameter::retrieveAlarmParameterFromFile ( std::ifstream &  )

Definition at line 225 of file AlarmParameter.cpp.

References relational_operator_to_activate_the_alarm, AlarmControlPanelUnit::retrieveAlarmControlPanelUnitFromFile(), and threshold_value_that_activate_the_alarm.

Here is the call graph for this function:

◆ saveAlarmParameterToFile()

void AlarmParameter::saveAlarmParameterToFile ( std::ofstream &  )

Definition at line 220 of file AlarmParameter.cpp.

References relational_operator_to_activate_the_alarm, AlarmControlPanelUnit::saveAlarmControlPanelUnitToFile(), and threshold_value_that_activate_the_alarm.

Here is the call graph for this function:

◆ serialize()

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

Definition at line 34 of file AlarmParameter.h.

◆ setRelationalOperatorToActivateTheAlarm()

void AlarmParameter::setRelationalOperatorToActivateTheAlarm ( int  n)

Definition at line 63 of file AlarmParameter.cpp.

References relational_operator_to_activate_the_alarm.

◆ setThresholdValueThatActivateTheAlarm()

void AlarmParameter::setThresholdValueThatActivateTheAlarm ( double  x)

Definition at line 62 of file AlarmParameter.cpp.

References threshold_value_that_activate_the_alarm.

◆ updateDisplayedAlarmState()

int AlarmParameter::updateDisplayedAlarmState ( ControlPanelDisplay &  _cp)

Definition at line 66 of file AlarmParameter.cpp.

References AdsSimErr, sim::State::Auto, SimulationContext::Branch_center, sim::Compare::EQ, g_sim, sim::Compare::GE, AlarmElement::getAlarmName(), AlarmElement::getCorrespondingIndicatorName(), AlarmElement::getDisplayedAlarmState(), AlarmControlPanelUnit::getDisplayedAlarmStateWhenFail(), AlarmElement::getDisplayedOperatorControlState(), DisplayParameterValue::getDisplayedParameterValue(), ControlPanelDisplay::getDisplayFromMap(), AlarmControlPanelUnit::getFuncationalState(), AlarmControlPanelUnit::getPtrToCorrespondingIndicator(), sim::Compare::GT, sim::Compare::LE, sim::Compare::LT, sim::State::Off, sim::State::On, r5pars_, relational_operator_to_activate_the_alarm, sim::State::Reset, AlarmElement::setDisplayedAlarmState(), AlarmControlPanelUnit::setPtrToCorrespondingIndicator(), BranchRecord::setTempESMessage(), BranchRecord::setTempTypeOfConsequence(), AlarmElement::setTimeAtWhichThisAlarmIsActivated(), sim::State::Succeed, and threshold_value_that_activate_the_alarm.

Referenced by ControlPanelAlarm::initiateAllAlarms().

Here is the call graph for this function:
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 32 of file AlarmParameter.h.

Member Data Documentation

◆ relational_operator_to_activate_the_alarm

int AlarmParameter::relational_operator_to_activate_the_alarm
private

Definition at line 30 of file AlarmParameter.h.

Referenced by AlarmParameter(), copyAlarmParameter(), getRelationalOperatorToActivateTheAlarm(), readInfoFromFile(), retrieveAlarmParameterFromFile(), saveAlarmParameterToFile(), setRelationalOperatorToActivateTheAlarm(), and updateDisplayedAlarmState().

◆ threshold_value_that_activate_the_alarm

double AlarmParameter::threshold_value_that_activate_the_alarm
private

Definition at line 29 of file AlarmParameter.h.

Referenced by AlarmParameter(), copyAlarmParameter(), getThresholdValueThatActivateTheAlarm(), readInfoFromFile(), retrieveAlarmParameterFromFile(), saveAlarmParameterToFile(), setThresholdValueThatActivateTheAlarm(), and updateDisplayedAlarmState().

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