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

#include <AlarmControlPanelUnit.h>

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

Public Member Functions

 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 functional_state
 
int displayed_alarm_state_when_fail
 
SystemDisplay * ptr_to_corresponding_indicator
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 14 of file AlarmControlPanelUnit.h.

Constructor & Destructor Documentation

◆ AlarmControlPanelUnit()

AlarmControlPanelUnit::AlarmControlPanelUnit ( )

Definition at line 16 of file AlarmControlPanelUnit.cpp.

References displayed_alarm_state_when_fail, functional_state, sim::State::Off, ptr_to_corresponding_indicator, and sim::State::Succeed.

◆ ~AlarmControlPanelUnit()

AlarmControlPanelUnit::~AlarmControlPanelUnit ( )
virtual

Definition at line 23 of file AlarmControlPanelUnit.cpp.

Member Function Documentation

◆ copyAlarmControlPanelUnit()

void AlarmControlPanelUnit::copyAlarmControlPanelUnit ( AlarmControlPanelUnit &  _au)

Definition at line 38 of file AlarmControlPanelUnit.cpp.

References SystemAlarm::copySystemAlarm(), displayed_alarm_state_when_fail, functional_state, getDisplayedAlarmStateWhenFail(), and getFuncationalState().

Referenced by AlarmComponent::copyAlarmComponent(), AlarmParameter::copyAlarmParameter(), and AlarmTwoParameterDifference::copyAlarmTwoParameterDifference().

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

◆ getDisplayedAlarmStateWhenFail()

int AlarmControlPanelUnit::getDisplayedAlarmStateWhenFail ( )

Definition at line 30 of file AlarmControlPanelUnit.cpp.

References displayed_alarm_state_when_fail.

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

Here is the caller graph for this function:

◆ getFuncationalState()

int AlarmControlPanelUnit::getFuncationalState ( )

Definition at line 29 of file AlarmControlPanelUnit.cpp.

References functional_state.

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

Here is the caller graph for this function:

◆ getPtrToCorrespondingIndicator()

SystemDisplay * AlarmControlPanelUnit::getPtrToCorrespondingIndicator ( )

Definition at line 31 of file AlarmControlPanelUnit.cpp.

References ptr_to_corresponding_indicator.

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

Here is the caller graph for this function:

◆ readInfoFromFile()

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

Definition at line 35 of file AlarmControlPanelUnit.cpp.

References SystemAlarm::readInfoFromFile().

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

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

◆ retrieveAlarmControlPanelUnitFromFile()

void AlarmControlPanelUnit::retrieveAlarmControlPanelUnitFromFile ( std::ifstream &  )

Definition at line 47 of file AlarmControlPanelUnit.cpp.

References displayed_alarm_state_when_fail, functional_state, and SystemAlarm::retrieveSystemAlarmFromFile().

Referenced by AlarmComponent::retrieveAlarmComponentFromFile(), AlarmParameter::retrieveAlarmParameterFromFile(), and AlarmTwoParameterDifference::retrieveAlarmTwoParameterDifferenceFromFile().

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

◆ saveAlarmControlPanelUnitToFile()

void AlarmControlPanelUnit::saveAlarmControlPanelUnitToFile ( std::ofstream &  )

Definition at line 43 of file AlarmControlPanelUnit.cpp.

References displayed_alarm_state_when_fail, functional_state, and SystemAlarm::saveSystemAlarmToFile().

Referenced by AlarmComponent::saveAlarmComponentToFile(), AlarmParameter::saveAlarmParameterToFile(), and AlarmTwoParameterDifference::saveAlarmTwoParameterDifferenceToFile().

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

◆ serialize()

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

Definition at line 35 of file AlarmControlPanelUnit.h.

References functional_state.

◆ setDisplayedAlarmStateWhenFail()

void AlarmControlPanelUnit::setDisplayedAlarmStateWhenFail ( int  state)

Definition at line 28 of file AlarmControlPanelUnit.cpp.

References displayed_alarm_state_when_fail.

◆ setFuncationalState()

void AlarmControlPanelUnit::setFuncationalState ( int  state)

Definition at line 27 of file AlarmControlPanelUnit.cpp.

References functional_state.

◆ setPtrToCorrespondingIndicator()

void AlarmControlPanelUnit::setPtrToCorrespondingIndicator ( SystemDisplay *  ptr)

Definition at line 32 of file AlarmControlPanelUnit.cpp.

References ptr_to_corresponding_indicator.

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

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 33 of file AlarmControlPanelUnit.h.

Member Data Documentation

◆ displayed_alarm_state_when_fail

int AlarmControlPanelUnit::displayed_alarm_state_when_fail
private

Definition at line 30 of file AlarmControlPanelUnit.h.

Referenced by AlarmControlPanelUnit(), copyAlarmControlPanelUnit(), getDisplayedAlarmStateWhenFail(), retrieveAlarmControlPanelUnitFromFile(), saveAlarmControlPanelUnitToFile(), and setDisplayedAlarmStateWhenFail().

◆ functional_state

int AlarmControlPanelUnit::functional_state
private

Definition at line 30 of file AlarmControlPanelUnit.h.

Referenced by AlarmControlPanelUnit(), copyAlarmControlPanelUnit(), getFuncationalState(), retrieveAlarmControlPanelUnitFromFile(), saveAlarmControlPanelUnitToFile(), serialize(), and setFuncationalState().

◆ ptr_to_corresponding_indicator

SystemDisplay* AlarmControlPanelUnit::ptr_to_corresponding_indicator
private

Definition at line 31 of file AlarmControlPanelUnit.h.

Referenced by AlarmControlPanelUnit(), getPtrToCorrespondingIndicator(), and setPtrToCorrespondingIndicator().

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