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

#include <ControlElement.h>

Inheritance diagram for ControlElement:
[legend]

Public Member Functions

 ControlElement ()
 
virtual ~ControlElement ()
 
void setDisplayName (std::string)
 
void setCorrespondingComponentNameOfControl (std::string)
 
void setNominalTimeRequiredToActOnThisControl (double)
 
void setValueForOnOrFullyOpen (double)
 
void setValueForOffOrFullyClose (double)
 
void setValueForNeutralState (double)
 
std::string getDisplayName ()
 
std::string getCorrespondingComponentNameOfControl ()
 
double getNominalTimeRequiredToActOnThisControl ()
 
double getValueForOnOrFullyOpen ()
 
double getValueForOffOrFullyClose ()
 
double getValueForNeutralState ()
 
void readInfoFromFile (std::ifstream &)
 
void setTimeAtWhichThisControlIsActivated (double)
 
double getTimeAtWhichThisControlIsActivated ()
 
void copyControlElement (ControlElement &)
 
void setControlValue (double)
 
double getControlValue ()
 
void saveControlElementToFile (std::ofstream &)
 
void retrieveControlElementFromFile (std::ifstream &)
 
bool checkIfIsIdenticalControlElement (ControlElement &)
 
void setTimeRatioForAction (double)
 
double getTimeRatioForAction ()
 
double getAdjustedTimeRequiredToPerformTheAction ()
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

std::string display_name
 
std::string corresponding_component_name_of_control
 
double nominal_time_required_to_act_on_this_control
 
double time_ratio_for_action
 
double value_for_on_or_fully_open
 
double value_for_off_or_fully_close
 
double value_for_neutral_state
 
double time_at_which_this_control_is_activated
 
double control_value
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 19 of file ControlElement.h.

Constructor & Destructor Documentation

◆ ControlElement()

ControlElement::ControlElement ( )

Definition at line 17 of file ControlElement.cpp.

References control_value, corresponding_component_name_of_control, display_name, nominal_time_required_to_act_on_this_control, r5pars_, time_at_which_this_control_is_activated, time_ratio_for_action, value_for_neutral_state, value_for_off_or_fully_close, and value_for_on_or_fully_open.

◆ ~ControlElement()

ControlElement::~ControlElement ( )
virtual

Definition at line 30 of file ControlElement.cpp.

Member Function Documentation

◆ checkIfIsIdenticalControlElement()

bool ControlElement::checkIfIsIdenticalControlElement ( ControlElement &  _ce)

Definition at line 76 of file ControlElement.cpp.

References control_value, display_name, getControlValue(), getDisplayName(), getTimeAtWhichThisControlIsActivated(), and time_at_which_this_control_is_activated.

Referenced by MentalControl::checkIfIsIdenticalMentalControl().

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

◆ copyControlElement()

void ControlElement::copyControlElement ( ControlElement &  _ce)

Definition at line 52 of file ControlElement.cpp.

References control_value, corresponding_component_name_of_control, display_name, getControlValue(), getCorrespondingComponentNameOfControl(), getDisplayName(), getNominalTimeRequiredToActOnThisControl(), getTimeAtWhichThisControlIsActivated(), getTimeRatioForAction(), getValueForNeutralState(), getValueForOffOrFullyClose(), getValueForOnOrFullyOpen(), nominal_time_required_to_act_on_this_control, time_at_which_this_control_is_activated, time_ratio_for_action, value_for_neutral_state, value_for_off_or_fully_close, and value_for_on_or_fully_open.

Referenced by BranchSupportSystemAction::copyBranchSupportSystemAction(), BranchSystemAction::copyBranchSystemAction(), CommunicationControlCommand::copyCommunicationControlCommand(), CommunicationControlReport::copyCommunicationControlReport(), MentalControl::copyMentalControl(), SystemControl::copySystemControl(), and MentalControl::MentalControl().

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

◆ getAdjustedTimeRequiredToPerformTheAction()

double ControlElement::getAdjustedTimeRequiredToPerformTheAction ( )

Definition at line 86 of file ControlElement.cpp.

References nominal_time_required_to_act_on_this_control, and time_ratio_for_action.

Referenced by BranchSupportSystemAction::saveInfoToFile(), and BranchSystemAction::saveInfoToFile().

Here is the caller graph for this function:

◆ getControlValue()

double ControlElement::getControlValue ( )

Definition at line 64 of file ControlElement.cpp.

References control_value.

Referenced by checkIfIsIdenticalControlElement(), copyControlElement(), ProcedureStepUnit::executeAction(), ManeuverActionUnit::executeManeuverControl(), ProcedureStepUnit::executeNonResponseAction(), ControlPanel::executeRequestToPlant(), OperatorAT::infoChunking(), OperatorDM::infoChunking(), DiagnosisActionModule::onceThroughProcessForReasoningStrategy(), BranchAction::saveInfoToFile(), BranchSupportSystemAction::saveInfoToFile(), BranchSystemAction::saveInfoToFile(), DiagnosisActionUnit::setPtrToHighPriorityAction(), and BranchAction::translateMessage().

Here is the caller graph for this function:

◆ getCorrespondingComponentNameOfControl()

string ControlElement::getCorrespondingComponentNameOfControl ( )

Definition at line 41 of file ControlElement.cpp.

References corresponding_component_name_of_control.

Referenced by copyControlElement(), ControlState::initiateDisplayedControlState(), ControlValue::performControl(), ControlState::performDisplayedControlState(), ControlState::performValueControl(), BranchSupportSystemAction::translateMessage(), BranchSystemAction::translateMessage(), ControlState::updateDisplayedControlState(), and ControlValue::updateDisplayedControlValue().

Here is the caller graph for this function:

◆ getDisplayName()

string ControlElement::getDisplayName ( )

Definition at line 40 of file ControlElement.cpp.

References display_name.

Referenced by ShortTermMemory::checkAndGenerateInfoChunkMentalForRelatedAction(), checkIfIsIdenticalControlElement(), copyControlElement(), ControlState::readInfoFromFile(), BranchSupportSystemAction::saveInfoToFile(), BranchSystemAction::saveInfoToFile(), SupportSystemReliabilityUnit::saveSupportSystemUnitToFile(), BranchSupportSystemAction::translateMessage(), and BranchSystemAction::translateMessage().

Here is the caller graph for this function:

◆ getNominalTimeRequiredToActOnThisControl()

double ControlElement::getNominalTimeRequiredToActOnThisControl ( )

Definition at line 42 of file ControlElement.cpp.

References nominal_time_required_to_act_on_this_control.

Referenced by copyControlElement().

Here is the caller graph for this function:

◆ getTimeAtWhichThisControlIsActivated()

double ControlElement::getTimeAtWhichThisControlIsActivated ( )

Definition at line 51 of file ControlElement.cpp.

References time_at_which_this_control_is_activated.

Referenced by checkIfIsIdenticalControlElement(), and copyControlElement().

Here is the caller graph for this function:

◆ getTimeRatioForAction()

double ControlElement::getTimeRatioForAction ( )

Definition at line 85 of file ControlElement.cpp.

References time_ratio_for_action.

Referenced by copyControlElement().

Here is the caller graph for this function:

◆ getValueForNeutralState()

double ControlElement::getValueForNeutralState ( )

Definition at line 45 of file ControlElement.cpp.

References value_for_neutral_state.

Referenced by copyControlElement(), HWReliabilityModule::readSystemOperationReliabilityInfoFromFile(), HWReliabilityModule::readSystemReliabilityFTInfoFromFile(), and HWReliabilityModule::readSystemReliabilityInfoFromFile().

Here is the caller graph for this function:

◆ getValueForOffOrFullyClose()

double ControlElement::getValueForOffOrFullyClose ( )

Definition at line 44 of file ControlElement.cpp.

References value_for_off_or_fully_close.

Referenced by copyControlElement(), ProcedureStepUnit::executeAction(), ProcedureStepUnit::executeNonResponseAction(), ControlState::initiateDisplayedControlState(), DiagnosisActionModule::onceThroughProcessForReasoningStrategy(), ControlState::performDisplayedControlState(), HWReliabilityModule::readSystemOperationReliabilityInfoFromFile(), HWReliabilityModule::readSystemReliabilityFTInfoFromFile(), HWReliabilityModule::readSystemReliabilityInfoFromFile(), and ControlState::updateDisplayedControlState().

Here is the caller graph for this function:

◆ getValueForOnOrFullyOpen()

double ControlElement::getValueForOnOrFullyOpen ( )

Definition at line 43 of file ControlElement.cpp.

References value_for_on_or_fully_open.

Referenced by copyControlElement(), ProcedureStepUnit::executeAction(), ProcedureStepUnit::executeNonResponseAction(), ControlState::initiateDisplayedControlState(), DiagnosisActionModule::onceThroughProcessForReasoningStrategy(), ControlState::performDisplayedControlState(), HWReliabilityModule::readSystemOperationReliabilityInfoFromFile(), HWReliabilityModule::readSystemReliabilityFTInfoFromFile(), HWReliabilityModule::readSystemReliabilityInfoFromFile(), and ControlState::updateDisplayedControlState().

Here is the caller graph for this function:

◆ readInfoFromFile()

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

Definition at line 46 of file ControlElement.cpp.

References corresponding_component_name_of_control, display_name, nominal_time_required_to_act_on_this_control, value_for_neutral_state, value_for_off_or_fully_close, and value_for_on_or_fully_open.

Referenced by ControlState::readInfoFromFile(), and ControlValue::readInfoFromFile().

Here is the caller graph for this function:

◆ retrieveControlElementFromFile()

void ControlElement::retrieveControlElementFromFile ( std::ifstream &  )

Definition at line 70 of file ControlElement.cpp.

References control_value, corresponding_component_name_of_control, display_name, nominal_time_required_to_act_on_this_control, time_at_which_this_control_is_activated, time_ratio_for_action, value_for_neutral_state, value_for_off_or_fully_close, and value_for_on_or_fully_open.

Referenced by BranchSupportSystemAction::retrieveBranchSupportSystemActionFromFile(), BranchSystemAction::retrieveBranchSystemActionFromFile(), CommunicationControlCommand::retrieveCommunicationControlCommandFromFile(), CommunicationControlReport::retrieveCommunicationControlReportFromFile(), MentalControl::retrieveMentalControlFromFile(), and SystemControl::retrieveSystemControlFromFile().

Here is the caller graph for this function:

◆ saveControlElementToFile()

void ControlElement::saveControlElementToFile ( std::ofstream &  )

Definition at line 65 of file ControlElement.cpp.

References control_value, corresponding_component_name_of_control, display_name, nominal_time_required_to_act_on_this_control, time_at_which_this_control_is_activated, time_ratio_for_action, value_for_neutral_state, value_for_off_or_fully_close, and value_for_on_or_fully_open.

Referenced by BranchSupportSystemAction::saveBranchSupportSystemActionToFile(), BranchSystemAction::saveBranchSystemActionToFile(), CommunicationControlCommand::saveCommunicationControlCommandToFile(), CommunicationControlReport::saveCommunicationControlReportToFile(), MentalControl::saveMentalControlToFile(), and SystemControl::saveSystemControlToFile().

Here is the caller graph for this function:

◆ serialize()

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

Definition at line 50 of file ControlElement.h.

References control_value, corresponding_component_name_of_control, display_name, nominal_time_required_to_act_on_this_control, time_at_which_this_control_is_activated, time_ratio_for_action, value_for_neutral_state, value_for_off_or_fully_close, and value_for_on_or_fully_open.

◆ setControlValue()

void ControlElement::setControlValue ( double  x)

Definition at line 63 of file ControlElement.cpp.

References control_value.

Referenced by InitiatingEventController::checkAndExecuteInitiatingEvent(), ProcedureStepUnit::executeAction(), ManeuverActionUnit::executeManeuverControl(), ProcedureStepUnit::executeNonResponseAction(), SystemControl::initiateControlValue(), DiagnosisActionModule::onceThroughProcessForReasoningStrategy(), ControlValue::performControl(), and ControlState::performValueControl().

Here is the caller graph for this function:

◆ setCorrespondingComponentNameOfControl()

void ControlElement::setCorrespondingComponentNameOfControl ( std::string  )

Definition at line 35 of file ControlElement.cpp.

References corresponding_component_name_of_control.

Referenced by InitiatingEventController::checkAndExecuteInitiatingEvent().

Here is the caller graph for this function:

◆ setDisplayName()

void ControlElement::setDisplayName ( std::string  )

Definition at line 34 of file ControlElement.cpp.

References display_name.

Referenced by InitiatingEventController::checkAndExecuteInitiatingEvent(), ManeuverActionUnit::executeManeuverControl(), and ControlPanel::executeRequestToPlant().

Here is the caller graph for this function:

◆ setNominalTimeRequiredToActOnThisControl()

void ControlElement::setNominalTimeRequiredToActOnThisControl ( double  x)

Definition at line 36 of file ControlElement.cpp.

References nominal_time_required_to_act_on_this_control.

◆ setTimeAtWhichThisControlIsActivated()

void ControlElement::setTimeAtWhichThisControlIsActivated ( double  x)

Definition at line 50 of file ControlElement.cpp.

References time_at_which_this_control_is_activated.

◆ setTimeRatioForAction()

void ControlElement::setTimeRatioForAction ( double  x)

Definition at line 84 of file ControlElement.cpp.

References time_ratio_for_action.

◆ setValueForNeutralState()

void ControlElement::setValueForNeutralState ( double  x)

Definition at line 39 of file ControlElement.cpp.

References value_for_neutral_state.

◆ setValueForOffOrFullyClose()

void ControlElement::setValueForOffOrFullyClose ( double  x)

Definition at line 38 of file ControlElement.cpp.

References value_for_off_or_fully_close.

◆ setValueForOnOrFullyOpen()

void ControlElement::setValueForOnOrFullyOpen ( double  x)

Definition at line 37 of file ControlElement.cpp.

References value_for_on_or_fully_open.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 48 of file ControlElement.h.

Member Data Documentation

◆ control_value

double ControlElement::control_value
private

Definition at line 71 of file ControlElement.h.

Referenced by DecisionAction::checkForMatch(), checkIfIsIdenticalControlElement(), ControlElement(), copyControlElement(), getControlValue(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setControlValue().

◆ corresponding_component_name_of_control

std::string ControlElement::corresponding_component_name_of_control
private

Definition at line 64 of file ControlElement.h.

Referenced by ControlElement(), copyControlElement(), getCorrespondingComponentNameOfControl(), readInfoFromFile(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setCorrespondingComponentNameOfControl().

◆ display_name

std::string ControlElement::display_name
private

Definition at line 64 of file ControlElement.h.

Referenced by checkIfIsIdenticalControlElement(), ControlElement(), copyControlElement(), getDisplayName(), readInfoFromFile(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setDisplayName().

◆ nominal_time_required_to_act_on_this_control

double ControlElement::nominal_time_required_to_act_on_this_control
private

Definition at line 65 of file ControlElement.h.

Referenced by ControlElement(), copyControlElement(), getAdjustedTimeRequiredToPerformTheAction(), getNominalTimeRequiredToActOnThisControl(), readInfoFromFile(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setNominalTimeRequiredToActOnThisControl().

◆ time_at_which_this_control_is_activated

double ControlElement::time_at_which_this_control_is_activated
private

Definition at line 70 of file ControlElement.h.

Referenced by checkIfIsIdenticalControlElement(), ControlElement(), copyControlElement(), getTimeAtWhichThisControlIsActivated(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setTimeAtWhichThisControlIsActivated().

◆ time_ratio_for_action

double ControlElement::time_ratio_for_action
private

Definition at line 66 of file ControlElement.h.

Referenced by ControlElement(), copyControlElement(), getAdjustedTimeRequiredToPerformTheAction(), getTimeRatioForAction(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setTimeRatioForAction().

◆ value_for_neutral_state

double ControlElement::value_for_neutral_state
private

Definition at line 69 of file ControlElement.h.

Referenced by ControlElement(), copyControlElement(), getValueForNeutralState(), readInfoFromFile(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setValueForNeutralState().

◆ value_for_off_or_fully_close

double ControlElement::value_for_off_or_fully_close
private

Definition at line 68 of file ControlElement.h.

Referenced by ControlElement(), copyControlElement(), getValueForOffOrFullyClose(), readInfoFromFile(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setValueForOffOrFullyClose().

◆ value_for_on_or_fully_open

double ControlElement::value_for_on_or_fully_open
private

Definition at line 67 of file ControlElement.h.

Referenced by ControlElement(), copyControlElement(), getValueForOnOrFullyOpen(), readInfoFromFile(), retrieveControlElementFromFile(), saveControlElementToFile(), serialize(), and setValueForOnOrFullyOpen().

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