ControlElement.h

Go to the documentation of this file.

#pragma once
 
#include <iostream>
#include <typeinfo>
// ControlElement.h: interface for the ControlElement class.
//
 
#include <math.h>
#include <boost/serialization/export.hpp>
 
#include "../System/InteractiveVariable.h"
#include "../System/SystemModule.h"
#include <boost/archive/text_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/string.hpp>
 
class ControlElement  
{
public:
    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();
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & ar, const unsigned int version) {
//     std::cout << "Serializing class: " << typeid(*this).name() << std::endl;
        // Serialize members
        ar & display_name;
        ar & corresponding_component_name_of_control;
        ar & nominal_time_required_to_act_on_this_control;
        ar & time_ratio_for_action;
        ar & value_for_on_or_fully_open;
        ar & value_for_off_or_fully_close;
        ar & value_for_neutral_state;
        ar & time_at_which_this_control_is_activated;
        ar & control_value;
    }
private:
    std::string display_name, corresponding_component_name_of_control;
    double nominal_time_required_to_act_on_this_control;//a constant value read in from the input
    double time_ratio_for_action;//a value to adjust the actual time required for execute the 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;
};
 
 
BOOST_CLASS_EXPORT_KEY(ControlElement)