ControlState.cpp

Go to the documentation of this file.

// ControlState.cpp: implementation of the ControlState class.
//
 
#include "ControlState.h"
#include "../Global/TermConversions.h"
#include "../Branch/BranchRecord.h"
#include <boost/serialization/export.hpp>
#include "../Global/SimulationContext.h"
#include <boost/archive/binary_oarchive.hpp>
#include <boost/archive/binary_iarchive.hpp>
BOOST_CLASS_EXPORT_IMPLEMENT(ControlState)
using namespace std;
 
// Construction/Destruction
 
ControlState::ControlState()
{
    displyed_control_state = sim::State::Auto;
    displyed_control_state_when_fail = sim::State::Auto; // deterministic default, overwritten by readInfoFromFile
    SystemControl::setTypeOfControl(DisplayType::ControlState);
}
 
ControlState::~ControlState()
{
 
}
void ControlState::setDisplayedControlStateWhenFail(int n){displyed_control_state_when_fail = n;}
int ControlState::getDisplayedControlStateWhenFail(){return displyed_control_state_when_fail;}
void ControlState::setDisplayedControlState(int n){displyed_control_state = n;}
int ControlState::getDisplayedControlState(){return displyed_control_state;}
void ControlState::readInfoFromFile(ifstream &fin){
    string str;
    SystemControl::readInfoFromFile(fin);
    fin >> str;
    if (str == "ON"){
        displyed_control_state_when_fail = sim::State::On;}
    else if (str == "OFF"){
        displyed_control_state_when_fail = sim::State::Off;}
    else if (str == "OPEN"){
        displyed_control_state_when_fail = sim::State::Open;}
    else if(str == "CLOSE"){
        displyed_control_state_when_fail = sim::State::Close;}
    else if (str == "NONE"){
        displyed_control_state_when_fail = sim::None;
    }
    else{
        ofstream fout("err messages.txt", ios::app);
        cout << "ControlState::readInfoFromFile  Control " << SystemControl::getDisplayName() << " whose displayed_control_state_when_fail "
            << displyed_control_state_when_fail << " can not be recognized." << endl;
        fout << r5pars_.timesno << "  ControlState::readInfoFromFile  Control " << SystemControl::getDisplayName() << " whose displayed_control_state_when_fail "
            << displyed_control_state_when_fail << " can not be recognized.\n";
        fout.close();
        r5pars_.sim_err = true;
        g_sim.Branch_center.setTempESMessage("ControlState::readInfoFromFile err.");
        g_sim.Branch_center.setTempTypeOfConsequence(Consequence::NoKB);
    }
}
void ControlState::updateDisplayedControlState(SystemModule &_th, int _control_state){
    InteractiveVariable *iv_ptr;
    iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    if(iv_ptr == 0){ 
        SystemControl::setPtrToCorrespondingInteractiveVariable((InteractiveVariable *) _th.getComponentFromSystemMap(SystemControl::getCorrespondingComponentNameOfControl()));
        iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    }
    if(iv_ptr != 0){
        if(SystemControl::getFunctionalState() == sim::State::Succeed){
            switch (_control_state){
            case sim::State::Open:
                iv_ptr->setInputValue(SystemControl::getValueForOnOrFullyOpen());
                this->setDisplayedControlState(sim::State::Open);
                break;
            case sim::State::Close:
                iv_ptr->setInputValue(SystemControl::getValueForOffOrFullyClose());
                this->setDisplayedControlState(sim::State::Close);
                break;
            case sim::State::On:
                iv_ptr->setInputValue(SystemControl::getValueForOnOrFullyOpen());
                this->setDisplayedControlState(sim::State::On);
                break;
            case sim::State::Off:
                iv_ptr->setInputValue(SystemControl::getValueForOffOrFullyClose());
                this->setDisplayedControlState(sim::State::Off);
                break;
            default:
                break;
                ofstream fout("err messages.txt", ios::app);
                cout << " ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
                    << "whose control state " << _control_state << " can not be recognized." << endl;
                fout << r5pars_.timesno << "  ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
                    << "whose control state " << _control_state << " can not be recognized.\n";
                fout.close();
                r5pars_.sim_err = true;
                g_sim.Branch_center.setTempESMessage("ControlState::updateDisplayedControlState err.");
                g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
            }
        }
        else{//control fails
            if(displyed_control_state_when_fail != sim::None){
                this->setDisplayedControlState(displyed_control_state_when_fail);
            }
        }
    }
    else{
        ofstream fout("err messages.txt", ios::app);
        cout << " ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
            << " can not be located." << endl;
        fout << r5pars_.timesno << "  ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
            << " can not be located.\n";
        fout.close();
        r5pars_.sim_err = true;
        g_sim.Branch_center.setTempESMessage("ControlState::updateDisplayedControlState err.");
        g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
    }
}
void ControlState::performValueControl(SystemModule &_th, double _control_value){
    InteractiveVariable *iv_ptr;
    iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    if(iv_ptr == 0){ 
        SystemControl::setPtrToCorrespondingInteractiveVariable((InteractiveVariable *) _th.getComponentFromSystemMap(SystemControl::getCorrespondingComponentNameOfControl()));
        iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    }
    if(iv_ptr != 0){
        iv_ptr->setInputValue(_control_value);
        iv_ptr->setNeedToInteract(true);
        // update control value
        this->setControlValue(_control_value);
        this->setDisplayedControlState(_control_value);
        //
    }
    else{
        ofstream fout("err messages.txt", ios::app);
        cout << " ControlState::performValueControl InteractiveVariable: " << this->getCorrespondingComponentNameOfControl() << " could not be found" << endl;
        fout << r5pars_.timesno << "  ControlState::performValueControl InteractiveVariable: " << this->getCorrespondingComponentNameOfControl() << " could not be found.\n";
        fout.close();
        r5pars_.sim_err = true;
        g_sim.Branch_center.setTempESMessage("ControlState::performValueControl err.");
        g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
    }
}
 
void ControlState::performDisplayedControlState(SystemModule &_th, int _control_state){
    InteractiveVariable *iv_ptr;
    iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    if(iv_ptr == 0){ 
        SystemControl::setPtrToCorrespondingInteractiveVariable((InteractiveVariable *) _th.getComponentFromSystemMap(SystemControl::getCorrespondingComponentNameOfControl()));
        iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    }
    if(iv_ptr != 0){
        if(SystemControl::getFunctionalState() == sim::State::Succeed){
            switch (_control_state){
            case sim::State::Open:
                iv_ptr->setInputValue(SystemControl::getValueForOnOrFullyOpen());
                iv_ptr->setNeedToInteract(true);
                this->setDisplayedControlState(sim::State::Open);
                break;
            case sim::State::Close:
                iv_ptr->setInputValue(SystemControl::getValueForOffOrFullyClose());
                iv_ptr->setNeedToInteract(true);
                this->setDisplayedControlState(sim::State::Close);
                break;
            case sim::State::On:
                iv_ptr->setInputValue(SystemControl::getValueForOnOrFullyOpen());
                iv_ptr->setNeedToInteract(true);
                this->setDisplayedControlState(sim::State::On);
                break;
            case sim::State::Off:
                iv_ptr->setInputValue(SystemControl::getValueForOffOrFullyClose());
                iv_ptr->setNeedToInteract(true);
                this->setDisplayedControlState(sim::State::Off);
                break;
            default:
                break;
                ofstream fout("err messages.txt", ios::app);
                cout << " ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
                    << "whose control state " << _control_state << " can not be recognized." << endl;
                fout << r5pars_.timesno << "  ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
                    << "whose control state " << _control_state << " can not be recognized.\n";
                fout.close();
                r5pars_.sim_err = true;
                g_sim.Branch_center.setTempESMessage("ControlState::performDisplayedControlState err.");
                g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
            }
        }
        else{//control fails
            if(displyed_control_state_when_fail != sim::None){
                this->setDisplayedControlState(displyed_control_state_when_fail);
            }
        }
    }
    else{
        ofstream fout("err messages.txt", ios::app);
        cout << " ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
            << " can not be located." << endl;
        fout << r5pars_.timesno << "  ControlState::updateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
            << " can not be located.\n";
        fout.close();
        r5pars_.sim_err = true;
        g_sim.Branch_center.setTempESMessage("ControlState::performDisplayedControlState err.");
        g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
    }
}
void ControlState::initiateDisplayedControlState(SystemModule &_th){
    InteractiveVariable *iv_ptr;
    double iv_value;
    iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    if(iv_ptr == 0){ 
        SystemControl::setPtrToCorrespondingInteractiveVariable((InteractiveVariable *) _th.getComponentFromSystemMap(SystemControl::getCorrespondingComponentNameOfControl()));
        iv_ptr = SystemControl::getPtrToCorrespondingInteractiveVariable();
    }
    if(iv_ptr != 0){
        iv_value = iv_ptr->getDisplayValue();
        switch (displyed_control_state_when_fail){
        case sim::State::Open: case sim::State::Close:
            if (fabs(iv_value - SystemControl::getValueForOnOrFullyOpen()) < 1.0E-6) {
                this->setDisplayedControlState(sim::State::Open);
            }
            else if (fabs(iv_value - SystemControl::getValueForOffOrFullyClose()) < 1.0E-6){
                this->setDisplayedControlState(sim::State::Close);
            }
            else{
                this->setDisplayedControlState(sim::State::Auto);
            }
            break;
        case sim::State::On: case sim::State::Off:
            if (fabs(iv_value - SystemControl::getValueForOnOrFullyOpen()) < 1.0E-6) {
                this->setDisplayedControlState(sim::State::On);
            }
            else if (fabs(iv_value - SystemControl::getValueForOffOrFullyClose()) < 1.0E-6){
                this->setDisplayedControlState(sim::State::Off);
            }
            else{
                this->setDisplayedControlState(sim::State::Auto);
            }
            break;
        default:
            break;
            ofstream fout("err messages.txt", ios::app);
            cout << " ControlState::initiateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
                << "whose displyed_control_state_when_fail " << displyed_control_state_when_fail << " can not be recognized." << endl;
            fout << r5pars_.timesno << "  ControlState::initiateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
                << "whose displyed_control_state_when_fail " << displyed_control_state_when_fail << " can not be recognized.\n";
            fout.close();
            r5pars_.sim_err = true;
            g_sim.Branch_center.setTempESMessage("ControlState::initiateDisplayedControlState err.");
            g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
        }
    }
    else{
        ofstream fout("err messages.txt", ios::app);
        cout << " ControlState::initiateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
            << " can not be located." << endl;
        fout << r5pars_.timesno << "  ControlState::initiateDisplayedControlState Component " << SystemControl::getCorrespondingComponentNameOfControl()
            << " can not be located.\n";
        fout.close();
        r5pars_.sim_err = true;
        g_sim.Branch_center.setTempESMessage("ControlState::initiateDisplayedControlState err.");
        g_sim.Branch_center.setTempTypeOfConsequence(Consequence::AdsSimErr);
    }
}
string ControlState::getDisplayedControlStateString(){
    string c_state;
    switch (displyed_control_state){
    case sim::State::Open:
        c_state = "OPEN";
        break;
    case sim::State::Close:
        c_state = "CLOSE";
        break;
    case sim::State::On: 
        c_state = "ON";
        break;
    case sim::State::Off:
        c_state = "OFF";
        break;
    default:
        c_state = "UNKNOWN";
        break;
    }
    return c_state;
}
 
void ControlState::copyControlState(ControlState &_cs){
    displyed_control_state = _cs.getDisplayedControlState();
    displyed_control_state_when_fail = _cs.getDisplayedControlStateWhenFail();
    SystemControl::copySystemControl(_cs);
}
void ControlState::saveControlStateToFile(ofstream &fout){
    this->saveSystemControlToFile(fout);
    fout << displyed_control_state << ' ' << displyed_control_state_when_fail << '\n';
}
void ControlState::retrieveControlStateFromFile(ifstream &fin){
    this->retrieveSystemControlFromFile(fin);
    fin >> displyed_control_state >> displyed_control_state_when_fail;
}