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

#include <CommunicationControlCommand.h>

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

Public Member Functions

 CommunicationControlCommand ()
 
 CommunicationControlCommand (int, int)
 
virtual ~CommunicationControlCommand ()
 
void setCommunicatedControlValue (double)
 
double getCommunicatedControlValue ()
 
void copyCommunicationControlCommand (CommunicationControlCommand &)
 
void saveCommunicationControlCommandToFile (std::ofstream &)
 
void retrieveCommunicationControlCommandFromFile (std::ifstream &)
 
- Public Member Functions inherited from Communication
 Communication ()
 
 Communication (int, int)
 
virtual ~Communication ()
 
void setSender (int)
 
void setTypeOfCommunication (int)
 
void setTypeOfPauseActivity (int)
 
void setIntendedReceiver (int)
 
void setTimeOfCommunication (double)
 
void setSenderAndReceiver (int, int)
 
void setCommunicationPriority (int)
 
int getSender ()
 
int getIntendedReceiver ()
 
int getTypeOfCommunication ()
 
int getTypeOfPauseActivity ()
 
double getTimeOfCommunication ()
 
int getCommunicationPriority ()
 
void copyCommunication (Communication &)
 
void saveCommunicationToFile (std::ofstream &)
 
void retrieveCommunicationFromFile (std::ifstream &)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from ControlElement
 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

double communicated_control_value
 

Detailed Description

Definition at line 10 of file CommunicationControlCommand.h.

Constructor & Destructor Documentation

◆ CommunicationControlCommand() [1/2]

CommunicationControlCommand::CommunicationControlCommand ( )

Definition at line 12 of file CommunicationControlCommand.cpp.

References sim::Comm::ControlCommand, and Communication::setTypeOfCommunication().

Here is the call graph for this function:

◆ CommunicationControlCommand() [2/2]

CommunicationControlCommand::CommunicationControlCommand ( int  _sender,
int  _receiver 
)

Definition at line 16 of file CommunicationControlCommand.cpp.

References sim::Comm::ControlCommand, and Communication::setTypeOfCommunication().

Here is the call graph for this function:

◆ ~CommunicationControlCommand()

CommunicationControlCommand::~CommunicationControlCommand ( )
virtual

Definition at line 20 of file CommunicationControlCommand.cpp.

Member Function Documentation

◆ copyCommunicationControlCommand()

void CommunicationControlCommand::copyCommunicationControlCommand ( CommunicationControlCommand &  _cc)

Definition at line 26 of file CommunicationControlCommand.cpp.

References communicated_control_value, Communication::copyCommunication(), ControlElement::copyControlElement(), and getCommunicatedControlValue().

Here is the call graph for this function:

◆ getCommunicatedControlValue()

double CommunicationControlCommand::getCommunicatedControlValue ( )

Definition at line 25 of file CommunicationControlCommand.cpp.

References communicated_control_value.

Referenced by copyCommunicationControlCommand().

Here is the caller graph for this function:

◆ retrieveCommunicationControlCommandFromFile()

void CommunicationControlCommand::retrieveCommunicationControlCommandFromFile ( std::ifstream &  )

Definition at line 36 of file CommunicationControlCommand.cpp.

References communicated_control_value, Communication::retrieveCommunicationFromFile(), and ControlElement::retrieveControlElementFromFile().

Here is the call graph for this function:

◆ saveCommunicationControlCommandToFile()

void CommunicationControlCommand::saveCommunicationControlCommandToFile ( std::ofstream &  )

Definition at line 31 of file CommunicationControlCommand.cpp.

References communicated_control_value, Communication::saveCommunicationToFile(), and ControlElement::saveControlElementToFile().

Here is the call graph for this function:

◆ setCommunicatedControlValue()

void CommunicationControlCommand::setCommunicatedControlValue ( double  x)

Definition at line 24 of file CommunicationControlCommand.cpp.

References communicated_control_value.

Member Data Documentation

◆ communicated_control_value

double CommunicationControlCommand::communicated_control_value
private

Definition at line 24 of file CommunicationControlCommand.h.

Referenced by copyCommunicationControlCommand(), getCommunicatedControlValue(), retrieveCommunicationControlCommandFromFile(), saveCommunicationControlCommandToFile(), and setCommunicatedControlValue().

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