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

#include <AlarmComponent.h>

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

Public Member Functions

 AlarmComponent ()
 
virtual ~AlarmComponent ()
 
void copyAlarmComponent (AlarmComponent &)
 
void setComponentStateThatActivateTheAlarm (int state)
 
int getComponentStateThatActivateTheAlarm ()
 
void readInfoFromFile (std::ifstream &)
 
void saveAlarmComponentToFile (std::ofstream &)
 
void retrieveAlarmComponentFromFile (std::ifstream &)
 
int updateDisplayedAlarmState (ControlPanelDisplay &)
 
- 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

int component_state_that_activate_the_alarm
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 15 of file AlarmComponent.h.

Constructor & Destructor Documentation

◆ AlarmComponent()

AlarmComponent::AlarmComponent ( )

Definition at line 19 of file AlarmComponent.cpp.

References AlarmComponent, component_state_that_activate_the_alarm, SystemAlarm::setTypeOfAlarm(), and sim::State::Unknown.

Here is the call graph for this function:

◆ ~AlarmComponent()

AlarmComponent::~AlarmComponent ( )
virtual

Definition at line 25 of file AlarmComponent.cpp.

Member Function Documentation

◆ copyAlarmComponent()

void AlarmComponent::copyAlarmComponent ( AlarmComponent &  _ac)

Definition at line 126 of file AlarmComponent.cpp.

References component_state_that_activate_the_alarm, AlarmControlPanelUnit::copyAlarmControlPanelUnit(), and getComponentStateThatActivateTheAlarm().

Here is the call graph for this function:

◆ getComponentStateThatActivateTheAlarm()

int AlarmComponent::getComponentStateThatActivateTheAlarm ( )

Definition at line 30 of file AlarmComponent.cpp.

References component_state_that_activate_the_alarm.

Referenced by copyAlarmComponent().

Here is the caller graph for this function:

◆ readInfoFromFile()

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

Definition at line 31 of file AlarmComponent.cpp.

References SimulationContext::Branch_center, sim::State::Close, component_state_that_activate_the_alarm, g_sim, AlarmElement::getAlarmName(), NoKB, sim::State::Off, sim::State::On, sim::State::Open, r5pars_, AlarmControlPanelUnit::readInfoFromFile(), BranchRecord::setTempESMessage(), and BranchRecord::setTempTypeOfConsequence().

Here is the call graph for this function:

◆ retrieveAlarmComponentFromFile()

void AlarmComponent::retrieveAlarmComponentFromFile ( std::ifstream &  )

Definition at line 134 of file AlarmComponent.cpp.

References component_state_that_activate_the_alarm, and AlarmControlPanelUnit::retrieveAlarmControlPanelUnitFromFile().

Here is the call graph for this function:

◆ saveAlarmComponentToFile()

void AlarmComponent::saveAlarmComponentToFile ( std::ofstream &  )

Definition at line 130 of file AlarmComponent.cpp.

References component_state_that_activate_the_alarm, and AlarmControlPanelUnit::saveAlarmControlPanelUnitToFile().

Here is the call graph for this function:

◆ serialize()

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

Definition at line 32 of file AlarmComponent.h.

◆ setComponentStateThatActivateTheAlarm()

void AlarmComponent::setComponentStateThatActivateTheAlarm ( int  state)

Definition at line 29 of file AlarmComponent.cpp.

References component_state_that_activate_the_alarm.

◆ updateDisplayedAlarmState()

int AlarmComponent::updateDisplayedAlarmState ( ControlPanelDisplay &  _cpd)

Definition at line 60 of file AlarmComponent.cpp.

References AdsSimErr, sim::State::Auto, SimulationContext::Branch_center, component_state_that_activate_the_alarm, g_sim, AlarmElement::getAlarmName(), AlarmElement::getCorrespondingIndicatorName(), AlarmElement::getDisplayedAlarmState(), AlarmControlPanelUnit::getDisplayedAlarmStateWhenFail(), DisplayComponentState::getDisplayedComponentOperationalState(), AlarmElement::getDisplayedOperatorControlState(), ControlPanelDisplay::getDisplayFromMap(), AlarmControlPanelUnit::getFuncationalState(), AlarmControlPanelUnit::getPtrToCorrespondingIndicator(), sim::State::Off, sim::State::On, r5pars_, sim::State::Reset, AlarmElement::setDisplayedAlarmState(), AlarmControlPanelUnit::setPtrToCorrespondingIndicator(), BranchRecord::setTempESMessage(), BranchRecord::setTempTypeOfConsequence(), AlarmElement::setTimeAtWhichThisAlarmIsActivated(), and sim::State::Succeed.

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 30 of file AlarmComponent.h.

Member Data Documentation

◆ component_state_that_activate_the_alarm

int AlarmComponent::component_state_that_activate_the_alarm
private

Definition at line 28 of file AlarmComponent.h.

Referenced by AlarmComponent(), copyAlarmComponent(), getComponentStateThatActivateTheAlarm(), readInfoFromFile(), retrieveAlarmComponentFromFile(), saveAlarmComponentToFile(), setComponentStateThatActivateTheAlarm(), and updateDisplayedAlarmState().

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