#include <AlarmElement.h>

Inheritance diagram for AlarmElement:

Public Member Functions
	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 Attributes
std::string	alarm_name

std::string	corresponding_indicator_name

int	displayed_alarm_state

double	importance_of_the_alarm

int	displayed_operator_control_state

double	time_required_to_check_this_alarm

double	time_at_which_this_alarm_is_activated

Friends
class	boost::serialization::access

Detailed Description

Definition at line 19 of file AlarmElement.h.

Constructor & Destructor Documentation

◆ AlarmElement()

AlarmElement::AlarmElement ( )

Definition at line 17 of file AlarmElement.cpp.

References alarm_name, corresponding_indicator_name, displayed_alarm_state, displayed_operator_control_state, importance_of_the_alarm, sim::State::Off, sim::State::Reset, time_at_which_this_alarm_is_activated, and time_required_to_check_this_alarm.

◆ ~AlarmElement()

AlarmElement::~AlarmElement ( )

virtual

Definition at line 29 of file AlarmElement.cpp.

Member Function Documentation

◆ checkIfIsIdenticalAlarmElement()

bool AlarmElement::checkIfIsIdenticalAlarmElement ( AlarmElement & _ae )

Definition at line 80 of file AlarmElement.cpp.

References alarm_name, getAlarmName(), getTimeAtWhichThisAlarmIsActivated(), and time_at_which_this_alarm_is_activated.

Referenced by MentalAlarm::checkIfIsIdenticalMentalAlarm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyAlarmElement()

void AlarmElement::copyAlarmElement ( AlarmElement & _ae )

Definition at line 62 of file AlarmElement.cpp.

References alarm_name, corresponding_indicator_name, displayed_alarm_state, displayed_operator_control_state, getAlarmName(), getCorrespondingIndicatorName(), getDisplayedAlarmState(), getDisplayedOperatorControlState(), getImportanceOfTheAlarm(), getTimeAtWhichThisAlarmIsActivated(), getTimeRequiredToCheckThisAlarm(), importance_of_the_alarm, time_at_which_this_alarm_is_activated, and time_required_to_check_this_alarm.

Referenced by MentalAlarm::copyMentalAlarm(), and SystemAlarm::copySystemAlarm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAlarmName()

string AlarmElement::getAlarmName ( )

Definition at line 35 of file AlarmElement.cpp.

References alarm_name.

Referenced by ShortTermMemory::checkAndGenerateInfoChunkMentalForRelatedAlarm(), ControlPanel::checkForNewAlarms(), checkIfIsIdenticalAlarmElement(), copyAlarmElement(), ReasonMachine::CutTheLengthOfAlarmStack(), ReasonMachine::FirstRoundCheckInterpretation(), OperatorAT::infoChunking(), OperatorDM::infoChunking(), ControlPanelAlarm::initiateAllAlarms(), ReasonMachine::OneStepInterpretation20(), AlarmComponent::readInfoFromFile(), AlarmParameter::readInfoFromFile(), BranchSystemAlarmState::saveInfoToFile(), BranchExpectedAlarmState::translateMessage(), BranchSystemAlarmState::translateMessage(), AlarmComponent::updateDisplayedAlarmState(), AlarmParameter::updateDisplayedAlarmState(), and AlarmTwoParameterDifference::updateDisplayedAlarmState().

Here is the caller graph for this function:

◆ getCorrespondingIndicatorName()

string AlarmElement::getCorrespondingIndicatorName ( )

Definition at line 42 of file AlarmElement.cpp.

References corresponding_indicator_name.

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

Here is the caller graph for this function:

◆ getDisplayedAlarmState()

int AlarmElement::getDisplayedAlarmState ( )

Definition at line 43 of file AlarmElement.cpp.

References displayed_alarm_state.

Referenced by ControlPanel::checkForNewAlarms(), copyAlarmElement(), ControlPanel::executeRequestToPlant(), ReasonMachine::GetAlarmStateImediately(), BranchSystemAlarmState::translateMessage(), AlarmComponent::updateDisplayedAlarmState(), AlarmParameter::updateDisplayedAlarmState(), and AlarmTwoParameterDifference::updateDisplayedAlarmState().

Here is the caller graph for this function:

◆ getDisplayedAlarmStateString()

string AlarmElement::getDisplayedAlarmStateString ( )

Definition at line 46 of file AlarmElement.cpp.

References displayed_operator_control_state, and sim::State::On.

◆ getDisplayedOperatorControlState()

int AlarmElement::getDisplayedOperatorControlState ( )

Definition at line 57 of file AlarmElement.cpp.

References displayed_operator_control_state.

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

Here is the caller graph for this function:

◆ getImportanceOfTheAlarm()

double AlarmElement::getImportanceOfTheAlarm ( )

Definition at line 45 of file AlarmElement.cpp.

References importance_of_the_alarm.

Referenced by ControlPanel::checkForNewAlarms(), and copyAlarmElement().

Here is the caller graph for this function:

◆ getTimeAtWhichThisAlarmIsActivated()

double AlarmElement::getTimeAtWhichThisAlarmIsActivated ( )

Definition at line 61 of file AlarmElement.cpp.

References time_at_which_this_alarm_is_activated.

Referenced by checkIfIsIdenticalAlarmElement(), and copyAlarmElement().

Here is the caller graph for this function:

◆ getTimeRequiredToCheckThisAlarm()

double AlarmElement::getTimeRequiredToCheckThisAlarm ( )

Definition at line 59 of file AlarmElement.cpp.

References time_required_to_check_this_alarm.

Referenced by copyAlarmElement().

Here is the caller graph for this function:

◆ readInfoFromFile()

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

Definition at line 37 of file AlarmElement.cpp.

References alarm_name, corresponding_indicator_name, importance_of_the_alarm, and time_required_to_check_this_alarm.

Referenced by SystemAlarm::readInfoFromFile().

Here is the caller graph for this function:

◆ retrieveAlarmElementFromFile()

void AlarmElement::retrieveAlarmElementFromFile ( std::ifstream & )

Definition at line 76 of file AlarmElement.cpp.

References alarm_name, corresponding_indicator_name, displayed_alarm_state, displayed_operator_control_state, importance_of_the_alarm, time_at_which_this_alarm_is_activated, and time_required_to_check_this_alarm.

Referenced by MentalAlarm::retrieveMentalAlarmFromFile(), and SystemAlarm::retrieveSystemAlarmFromFile().

Here is the caller graph for this function:

◆ saveAlarmElementToFile()

void AlarmElement::saveAlarmElementToFile ( std::ofstream & )

Definition at line 71 of file AlarmElement.cpp.

References alarm_name, corresponding_indicator_name, displayed_alarm_state, displayed_operator_control_state, importance_of_the_alarm, time_at_which_this_alarm_is_activated, and time_required_to_check_this_alarm.

Referenced by MentalAlarm::saveMentalAlarmToFile(), and SystemAlarm::saveSystemAlarmToFile().

Here is the caller graph for this function:

◆ serialize()

template<class Archive >

void AlarmElement::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inline

Definition at line 47 of file AlarmElement.h.

References alarm_name, corresponding_indicator_name, displayed_alarm_state, displayed_operator_control_state, importance_of_the_alarm, time_at_which_this_alarm_is_activated, and time_required_to_check_this_alarm.

◆ setAlarmName()

void AlarmElement::setAlarmName ( std::string )

Definition at line 34 of file AlarmElement.cpp.

References alarm_name.

Referenced by Operator::ActiveFetchAlarmStateInfo(), and ExpectationORUnit::assessExpectation().

Here is the caller graph for this function:

◆ setCorrespondingIndicatorName()

void AlarmElement::setCorrespondingIndicatorName ( std::string )

Definition at line 40 of file AlarmElement.cpp.

References corresponding_indicator_name.

◆ setDisplayedAlarmState()

void AlarmElement::setDisplayedAlarmState ( int n )

Definition at line 41 of file AlarmElement.cpp.

References displayed_alarm_state.

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

Here is the caller graph for this function:

◆ setDisplayedOperatorControlState()

void AlarmElement::setDisplayedOperatorControlState ( int n )

Definition at line 56 of file AlarmElement.cpp.

References displayed_operator_control_state.

◆ setImportanceOfTheAlarm()

void AlarmElement::setImportanceOfTheAlarm ( double x )

Definition at line 44 of file AlarmElement.cpp.

References importance_of_the_alarm.

◆ setTimeAtWhichThisAlarmIsActivated()

void AlarmElement::setTimeAtWhichThisAlarmIsActivated ( double x )

Definition at line 60 of file AlarmElement.cpp.

References time_at_which_this_alarm_is_activated.

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

Here is the caller graph for this function:

◆ setTimeRequiredToCheckThisAlarm()

void AlarmElement::setTimeRequiredToCheckThisAlarm ( double x )

Definition at line 58 of file AlarmElement.cpp.

References time_required_to_check_this_alarm.

Referenced by Operator::ActiveFetchAlarmStateInfo().

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 45 of file AlarmElement.h.

Member Data Documentation

◆ alarm_name

std::string AlarmElement::alarm_name

private

Definition at line 59 of file AlarmElement.h.

Referenced by AlarmElement(), checkIfIsIdenticalAlarmElement(), copyAlarmElement(), getAlarmName(), readInfoFromFile(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setAlarmName().

◆ corresponding_indicator_name

std::string AlarmElement::corresponding_indicator_name

private

Definition at line 60 of file AlarmElement.h.

Referenced by AlarmElement(), copyAlarmElement(), getCorrespondingIndicatorName(), readInfoFromFile(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setCorrespondingIndicatorName().

◆ displayed_alarm_state

int AlarmElement::displayed_alarm_state

private

Definition at line 61 of file AlarmElement.h.

Referenced by AlarmElement(), copyAlarmElement(), getDisplayedAlarmState(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setDisplayedAlarmState().

◆ displayed_operator_control_state

int AlarmElement::displayed_operator_control_state

private

Definition at line 63 of file AlarmElement.h.

Referenced by AlarmElement(), copyAlarmElement(), getDisplayedAlarmStateString(), getDisplayedOperatorControlState(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setDisplayedOperatorControlState().

◆ importance_of_the_alarm

double AlarmElement::importance_of_the_alarm

private

Definition at line 62 of file AlarmElement.h.

Referenced by AlarmElement(), copyAlarmElement(), getImportanceOfTheAlarm(), readInfoFromFile(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setImportanceOfTheAlarm().

◆ time_at_which_this_alarm_is_activated

double AlarmElement::time_at_which_this_alarm_is_activated

private

Definition at line 65 of file AlarmElement.h.

Referenced by AlarmElement(), checkIfIsIdenticalAlarmElement(), copyAlarmElement(), getTimeAtWhichThisAlarmIsActivated(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setTimeAtWhichThisAlarmIsActivated().

◆ time_required_to_check_this_alarm

double AlarmElement::time_required_to_check_this_alarm

private

Definition at line 64 of file AlarmElement.h.

Referenced by AlarmElement(), copyAlarmElement(), getTimeRequiredToCheckThisAlarm(), readInfoFromFile(), retrieveAlarmElementFromFile(), saveAlarmElementToFile(), serialize(), and setTimeRequiredToCheckThisAlarm().

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

src/ADSIDAC/ControlPanel/AlarmElement.h
src/ADSIDAC/ControlPanel/AlarmElement.cpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AlarmElement()

◆ ~AlarmElement()

Member Function Documentation

◆ checkIfIsIdenticalAlarmElement()

◆ copyAlarmElement()

◆ getAlarmName()

◆ getCorrespondingIndicatorName()

◆ getDisplayedAlarmState()

◆ getDisplayedAlarmStateString()

◆ getDisplayedOperatorControlState()

◆ getImportanceOfTheAlarm()

◆ getTimeAtWhichThisAlarmIsActivated()

◆ getTimeRequiredToCheckThisAlarm()

◆ readInfoFromFile()

◆ retrieveAlarmElementFromFile()

◆ saveAlarmElementToFile()

◆ serialize()

◆ setAlarmName()

◆ setCorrespondingIndicatorName()

◆ setDisplayedAlarmState()

◆ setDisplayedOperatorControlState()

◆ setImportanceOfTheAlarm()

◆ setTimeAtWhichThisAlarmIsActivated()

◆ setTimeRequiredToCheckThisAlarm()

Friends And Related Function Documentation

◆ boost::serialization::access

Member Data Documentation

◆ alarm_name

◆ corresponding_indicator_name

◆ displayed_alarm_state

◆ displayed_operator_control_state

◆ importance_of_the_alarm

◆ time_at_which_this_alarm_is_activated

◆ time_required_to_check_this_alarm