InformationServer.h

Go to the documentation of this file.

#pragma once
#include <gii/gen/ResultData.h>
#include <gii/gen/Variable.h>
#include <gii/global.h>
 
namespace sf
{
 
class _GII_CLASS InformationServer : public InformationTypes
{
  public:
    InformationServer();
 
    virtual ~InformationServer();
 
    void setup(const std::string& name, const std::string& namePrefix, long vid, long deviceMask, long serverMask);
 
    void flush();
 
    enum EState
    {
      issOff = 0,
      issRun,
      issRecord,
      issPause,
      issStop,
      issMaxState
    };
 
    [[nodiscard]] EState getState() const;
 
    [[nodiscard]] const char* getStateName(int state) const;
 
    void setState(EState);
 
    enum EClass
    {
      clA = 0,
      clB,
      clC,
      clMaxClass
    };
 
    [[nodiscard]] bool isServerId(id_type id) const;
 
    void attachVariable(Variable* var, EClass cls);
 
    // Removes a variable from the variable vector.
    void detachVariable(Variable* var);
 
    // Adds a result to the result vector.
    void attachResult(ResultData* res);
 
    // Removes a result from the result vector.
    void detachResult(ResultData* res);
 
    // Reports if this server generates results depending on its current state.
    bool isGeneratingResults();
 
    // To be overloaded by a derived class to handle a state change if necessary.
    virtual void onStateChange(EState prevState, EState nextState) = 0;
 
    // Clears the committed ranges of the attached results.
    // This one can be overloaded by the derived class.
    // When so this function must be called as well.
    virtual void clearValidations();
 
  private:
    void variableEventHandler(Variable::EEvent, const Variable&, Variable&, bool);
 
    void setWriteFlagForClass(EClass, bool write_enable);
 
    void setArchiveFlag(bool write_enable);
 
    void setRecycleFlag(bool recycle_enable);
 
    typedef void (InformationServer::*VoidFunction)();
 
    void stateChangeUnknown();
 
    void stateChangeIllegal();
 
    void stateChangeStopToRun();
 
    void stateChangeRunToStop();
 
    void stateChangeOffToRun();
 
    void stateChangeRunToRecord();
 
    void stateChangeRecordToPause();
 
    void stateChangePauseToStop();
 
    void stateChangeAnyToOff();
 
    Variable _vState;
    EState _prevState;
    EState _curState;
    id_type _serverDeviceMask;
    id_type _serverDeviceId;
    VoidFunction _jumpTable[issMaxState][issMaxState]{};
    Variable::PtrVector _variableList[clMaxClass];
    ResultData::PtrVector _resultList;
    TVariableHandler<InformationServer> _variableHandler;
};
 
}// namespace sf