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

#include <InformationLoadModule.h>

Public Member Functions

 InformationLoadModule ()
 
virtual ~InformationLoadModule ()
 
void clearInformationLoadData ()
 
void setInfoLoadPIFValue (double)
 
double getInfoLoadPIFValue ()
 
void setMaxHistorySize (int)
 
int getMaxHistorySize ()
 
void setLowerInfoLoadThreshold (double)
 
double getLowerInfoLoadThreshold ()
 
void setUpperInfoLoadThreshold (double)
 
double getUpperInfoLoadThreshold ()
 
void addInformationLoadData (double, double)
 
double calculateAverageInformationLoadPIFValue ()
 
void copyInformationLoadModule (InformationLoadModule &)
 
void saveInformationLoadModuleToFile (std::ofstream &)
 
void retreiveInformationLoadModuleFromFile (std::ifstream &)
 
void outputInformationLoadModuleLabelToFile (std::string, std::ofstream &)
 
void outputInformationLoadModuleUnitsToFile (std::ofstream &)
 

Public Attributes

std::deque< double > info_load_history
 
std::deque< double > time_history
 

Private Member Functions

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

Private Attributes

int max_history_size
 
double info_load_pif_value
 
double lower_info_load_threshold
 
double upper_info_load_threshold
 

Friends

class boost::serialization::access
 

Detailed Description

Definition at line 13 of file InformationLoadModule.h.

Constructor & Destructor Documentation

◆ InformationLoadModule()

InformationLoadModule::InformationLoadModule ( )

Definition at line 16 of file InformationLoadModule.cpp.

References info_load_pif_value, and max_history_size.

◆ ~InformationLoadModule()

InformationLoadModule::~InformationLoadModule ( )
virtual

Definition at line 22 of file InformationLoadModule.cpp.

Member Function Documentation

◆ addInformationLoadData()

void InformationLoadModule::addInformationLoadData ( double  _time,
double  _load 
)

Definition at line 41 of file InformationLoadModule.cpp.

References info_load_history, and time_history.

Referenced by OperatorAT::oneThroughProcessForBlockI(), and OperatorDM::oneThroughProcessForBlockI().

Here is the caller graph for this function:

◆ calculateAverageInformationLoadPIFValue()

double InformationLoadModule::calculateAverageInformationLoadPIFValue ( )

Definition at line 49 of file InformationLoadModule.cpp.

References info_load_history, info_load_pif_value, lower_info_load_threshold, PG::size, time_history, and upper_info_load_threshold.

Referenced by OperatorAT::oneThroughProcessForBlockI(), and OperatorDM::oneThroughProcessForBlockI().

Here is the caller graph for this function:

◆ clearInformationLoadData()

void InformationLoadModule::clearInformationLoadData ( )

Definition at line 27 of file InformationLoadModule.cpp.

References info_load_history, and time_history.

Referenced by Operator::clearOperatorFinal(), Operator::clearOperatorForRestart(), Operator::clearOperatorFromRestartInfo(), and Operator::clearOperatorFromRestartNodeInfoMultiProcessors().

Here is the caller graph for this function:

◆ copyInformationLoadModule()

void InformationLoadModule::copyInformationLoadModule ( InformationLoadModule &  _ilm)

Definition at line 92 of file InformationLoadModule.cpp.

References getInfoLoadPIFValue(), getLowerInfoLoadThreshold(), getMaxHistorySize(), getUpperInfoLoadThreshold(), info_load_history, info_load_pif_value, lower_info_load_threshold, max_history_size, time_history, and upper_info_load_threshold.

Referenced by Operator::copyOperatorFromRestartInfo(), Operator::copyOperatorFromRestartInfoMultiProcessor(), and Operator::copyOperatorToRestartInfo().

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

◆ getInfoLoadPIFValue()

double InformationLoadModule::getInfoLoadPIFValue ( )

Definition at line 33 of file InformationLoadModule.cpp.

References info_load_pif_value.

Referenced by KeyParameterHistoryUnit::addDataSet(), copyInformationLoadModule(), and Operator::quantificationFilter().

Here is the caller graph for this function:

◆ getLowerInfoLoadThreshold()

double InformationLoadModule::getLowerInfoLoadThreshold ( )

Definition at line 37 of file InformationLoadModule.cpp.

References lower_info_load_threshold.

Referenced by copyInformationLoadModule().

Here is the caller graph for this function:

◆ getMaxHistorySize()

int InformationLoadModule::getMaxHistorySize ( )

Definition at line 35 of file InformationLoadModule.cpp.

References max_history_size.

Referenced by copyInformationLoadModule().

Here is the caller graph for this function:

◆ getUpperInfoLoadThreshold()

double InformationLoadModule::getUpperInfoLoadThreshold ( )

Definition at line 39 of file InformationLoadModule.cpp.

References upper_info_load_threshold.

Referenced by copyInformationLoadModule().

Here is the caller graph for this function:

◆ outputInformationLoadModuleLabelToFile()

void InformationLoadModule::outputInformationLoadModuleLabelToFile ( std::string  _str,
std::ofstream &  fout 
)

Definition at line 85 of file InformationLoadModule.cpp.

Referenced by KeyParameterHistoryUnit::outputPIFLabelToFile().

Here is the caller graph for this function:

◆ outputInformationLoadModuleUnitsToFile()

void InformationLoadModule::outputInformationLoadModuleUnitsToFile ( std::ofstream &  fout)

Definition at line 88 of file InformationLoadModule.cpp.

Referenced by KeyParameterHistoryUnit::outputPIFUnitToFile().

Here is the caller graph for this function:

◆ retreiveInformationLoadModuleFromFile()

void InformationLoadModule::retreiveInformationLoadModuleFromFile ( std::ifstream &  fin)

Definition at line 111 of file InformationLoadModule.cpp.

References info_load_history, info_load_pif_value, lower_info_load_threshold, max_history_size, time_history, and upper_info_load_threshold.

Referenced by Operator::retrieveOperatorFromFile().

Here is the caller graph for this function:

◆ saveInformationLoadModuleToFile()

void InformationLoadModule::saveInformationLoadModuleToFile ( std::ofstream &  fout)

Definition at line 102 of file InformationLoadModule.cpp.

References info_load_history, info_load_pif_value, lower_info_load_threshold, max_history_size, time_history, and upper_info_load_threshold.

Referenced by Operator::saveOperatorToFile().

Here is the caller graph for this function:

◆ serialize()

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

Definition at line 44 of file InformationLoadModule.h.

References info_load_history, info_load_pif_value, lower_info_load_threshold, max_history_size, time_history, and upper_info_load_threshold.

◆ setInfoLoadPIFValue()

void InformationLoadModule::setInfoLoadPIFValue ( double  x)

Definition at line 32 of file InformationLoadModule.cpp.

References info_load_pif_value.

◆ setLowerInfoLoadThreshold()

void InformationLoadModule::setLowerInfoLoadThreshold ( double  x)

Definition at line 36 of file InformationLoadModule.cpp.

References lower_info_load_threshold.

Referenced by Operator::initiationForSimulation().

Here is the caller graph for this function:

◆ setMaxHistorySize()

void InformationLoadModule::setMaxHistorySize ( int  n)

Definition at line 34 of file InformationLoadModule.cpp.

References max_history_size.

◆ setUpperInfoLoadThreshold()

void InformationLoadModule::setUpperInfoLoadThreshold ( double  x)

Definition at line 38 of file InformationLoadModule.cpp.

References upper_info_load_threshold.

Referenced by Operator::initiationForSimulation().

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 42 of file InformationLoadModule.h.

Member Data Documentation

◆ info_load_history

std::deque<double> InformationLoadModule::info_load_history

Definition at line 33 of file InformationLoadModule.h.

Referenced by addInformationLoadData(), calculateAverageInformationLoadPIFValue(), clearInformationLoadData(), copyInformationLoadModule(), retreiveInformationLoadModuleFromFile(), saveInformationLoadModuleToFile(), and serialize().

◆ info_load_pif_value

double InformationLoadModule::info_load_pif_value
private

Definition at line 38 of file InformationLoadModule.h.

Referenced by calculateAverageInformationLoadPIFValue(), copyInformationLoadModule(), getInfoLoadPIFValue(), InformationLoadModule(), retreiveInformationLoadModuleFromFile(), saveInformationLoadModuleToFile(), serialize(), and setInfoLoadPIFValue().

◆ lower_info_load_threshold

double InformationLoadModule::lower_info_load_threshold
private

Definition at line 39 of file InformationLoadModule.h.

Referenced by calculateAverageInformationLoadPIFValue(), copyInformationLoadModule(), getLowerInfoLoadThreshold(), retreiveInformationLoadModuleFromFile(), saveInformationLoadModuleToFile(), serialize(), and setLowerInfoLoadThreshold().

◆ max_history_size

int InformationLoadModule::max_history_size
private

Definition at line 37 of file InformationLoadModule.h.

Referenced by copyInformationLoadModule(), getMaxHistorySize(), InformationLoadModule(), retreiveInformationLoadModuleFromFile(), saveInformationLoadModuleToFile(), serialize(), and setMaxHistorySize().

◆ time_history

std::deque<double> InformationLoadModule::time_history

Definition at line 34 of file InformationLoadModule.h.

Referenced by addInformationLoadData(), calculateAverageInformationLoadPIFValue(), clearInformationLoadData(), copyInformationLoadModule(), retreiveInformationLoadModuleFromFile(), saveInformationLoadModuleToFile(), and serialize().

◆ upper_info_load_threshold

double InformationLoadModule::upper_info_load_threshold
private

Definition at line 40 of file InformationLoadModule.h.

Referenced by calculateAverageInformationLoadPIFValue(), copyInformationLoadModule(), getUpperInfoLoadThreshold(), retreiveInformationLoadModuleFromFile(), saveInformationLoadModuleToFile(), serialize(), and setUpperInfoLoadThreshold().

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