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

#include <ControlVariable.h>

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

Public Member Functions

 ControlVariable ()
 
virtual ~ControlVariable ()
 
void setControlValue (double value)
 
void setMaximumControlValue (double value)
 
void setMinimumControlValue (double value)
 
double getControlValue ()
 
double getMaximumControlValue ()
 
double getMinimumControlValue ()
 
void setUnitOfControlValue (std::string unit)
 
std::string getUnitOfControlValue ()
 
void readInfoFromFile (std::ifstream &)
 
void copyControlVariable (ControlVariable &)
 
void saveControlVariableToFile (std::ofstream &)
 
void retrieveControlVariableFromFile (std::ifstream &)
 
- Public Member Functions inherited from THElement
 THElement ()
 
virtual ~THElement ()
 
std::string getName ()
 
void setName (std::string newName)
 
int getCardNumber ()
 
void setCardNumber (int newCardNumber)
 
void readInfoFromFile (std::ifstream &)
 
Relap5ComponentType getTypeOfCard ()
 
void setTypeOfCard (Relap5ComponentType newTypeOfCard)
 
void copyTHElement (THElement &)
 
void saveTHElementToFile (std::ofstream &)
 
void retrieveTHElementFromFile (std::ifstream &)
 

Private Member Functions

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

Private Attributes

double control_value
 
double maximum_control_value
 
double minimum_control_value
 
std::string unit_of_control_value
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 13 of file ControlVariable.h.

Constructor & Destructor Documentation

◆ ControlVariable()

ControlVariable::ControlVariable ( )

Definition at line 16 of file ControlVariable.cpp.

References control_value, ControlVariable, maximum_control_value, minimum_control_value, THElement::setTypeOfCard(), and unit_of_control_value.

Here is the call graph for this function:

◆ ~ControlVariable()

ControlVariable::~ControlVariable ( )
virtual

Definition at line 25 of file ControlVariable.cpp.

Member Function Documentation

◆ copyControlVariable()

void ControlVariable::copyControlVariable ( ControlVariable &  _cv)

Definition at line 68 of file ControlVariable.cpp.

References control_value, THElement::copyTHElement(), getControlValue(), getMaximumControlValue(), getMinimumControlValue(), getUnitOfControlValue(), maximum_control_value, minimum_control_value, and unit_of_control_value.

Here is the call graph for this function:

◆ getControlValue()

double ControlVariable::getControlValue ( )

Definition at line 38 of file ControlVariable.cpp.

References control_value.

Referenced by copyControlVariable(), and SystemDisplay::getCorrespondingSystemParameterValue().

Here is the caller graph for this function:

◆ getMaximumControlValue()

double ControlVariable::getMaximumControlValue ( )

Definition at line 39 of file ControlVariable.cpp.

References maximum_control_value.

Referenced by copyControlVariable().

Here is the caller graph for this function:

◆ getMinimumControlValue()

double ControlVariable::getMinimumControlValue ( )

Definition at line 40 of file ControlVariable.cpp.

References minimum_control_value.

Referenced by copyControlVariable().

Here is the caller graph for this function:

◆ getUnitOfControlValue()

string ControlVariable::getUnitOfControlValue ( )

Definition at line 44 of file ControlVariable.cpp.

References unit_of_control_value.

Referenced by copyControlVariable(), and SystemDisplay::setCorrespondingSystemParameterUnit().

Here is the caller graph for this function:

◆ readInfoFromFile()

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

Definition at line 45 of file ControlVariable.cpp.

References THElement::readInfoFromFile(), and unit_of_control_value.

Here is the call graph for this function:

◆ retrieveControlVariableFromFile()

void ControlVariable::retrieveControlVariableFromFile ( std::ifstream &  )

Definition at line 61 of file ControlVariable.cpp.

References control_value, maximum_control_value, minimum_control_value, THElement::retrieveTHElementFromFile(), and unit_of_control_value.

Here is the call graph for this function:

◆ saveControlVariableToFile()

void ControlVariable::saveControlVariableToFile ( std::ofstream &  )

Definition at line 49 of file ControlVariable.cpp.

References control_value, e, maximum_control_value, minimum_control_value, THElement::saveTHElementToFile(), and unit_of_control_value.

Here is the call graph for this function:

◆ serialize()

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

Definition at line 38 of file ControlVariable.h.

References control_value, maximum_control_value, minimum_control_value, and unit_of_control_value.

◆ setControlValue()

void ControlVariable::setControlValue ( double  value)

Definition at line 29 of file ControlVariable.cpp.

References control_value.

◆ setMaximumControlValue()

void ControlVariable::setMaximumControlValue ( double  value)

Definition at line 32 of file ControlVariable.cpp.

References maximum_control_value.

◆ setMinimumControlValue()

void ControlVariable::setMinimumControlValue ( double  value)

Definition at line 35 of file ControlVariable.cpp.

References minimum_control_value.

◆ setUnitOfControlValue()

void ControlVariable::setUnitOfControlValue ( std::string  unit)

Definition at line 41 of file ControlVariable.cpp.

References unit_of_control_value.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 36 of file ControlVariable.h.

Member Data Documentation

◆ control_value

double ControlVariable::control_value
private

Definition at line 31 of file ControlVariable.h.

Referenced by ControlVariable(), copyControlVariable(), getControlValue(), retrieveControlVariableFromFile(), saveControlVariableToFile(), serialize(), and setControlValue().

◆ maximum_control_value

double ControlVariable::maximum_control_value
private

Definition at line 32 of file ControlVariable.h.

Referenced by ControlVariable(), copyControlVariable(), getMaximumControlValue(), retrieveControlVariableFromFile(), saveControlVariableToFile(), serialize(), and setMaximumControlValue().

◆ minimum_control_value

double ControlVariable::minimum_control_value
private

Definition at line 33 of file ControlVariable.h.

Referenced by ControlVariable(), copyControlVariable(), getMinimumControlValue(), retrieveControlVariableFromFile(), saveControlVariableToFile(), serialize(), and setMinimumControlValue().

◆ unit_of_control_value

std::string ControlVariable::unit_of_control_value
private

Definition at line 34 of file ControlVariable.h.

Referenced by ControlVariable(), copyControlVariable(), getUnitOfControlValue(), readInfoFromFile(), retrieveControlVariableFromFile(), saveControlVariableToFile(), serialize(), and setUnitOfControlValue().

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