RunInfoVInterface.h

#ifndef _ots_RunInfoVInterface_h_
#define _ots_RunInfoVInterface_h_
 
#include <string>
#include "otsdaq/Configurable/Configurable.h"
#include "otsdaq/Macros/CoutMacros.h"
#include "otsdaq/Macros/StringMacros.h"
 
namespace ots
{
 
// clang-format off
 
class RunInfoVInterface  
{
  public:
    enum class RunTransitionType
    {
        HALT,
        STOP,
        ERROR,
        PAUSE,
        RESUME,
        START,
        STOP_COMPLETE,
        HALT_COMPLETE
    };
 
    RunInfoVInterface                           (const std::string& runInfoPluginClassName,
                                                const std::string& activeStateMachineName)
        :
        mfSubject_(runInfoPluginClassName),
        activeStateMachineName_(activeStateMachineName)
    {;}
    virtual ~RunInfoVInterface                      (void) { ; }
 
 
 
 
    virtual unsigned int    insertConfigureCondition    (const std::string&  /*blob*/,
                                                         const std::string&  /*comment*/)                   { __SS__ << "insertConfigureCondition() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!"; __SS_THROW__; };
    virtual unsigned int    claimNextRunNumber          (unsigned int        /* configureConditionID */,
                                                         const std::string&  /* comment */)                 { __SS__ << "claimNextRunNumber() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!"; __SS_THROW__; };
    virtual unsigned int    insertRunCondition          (unsigned int        /* runNumber */,
                                                         const std::map<std::string /* subsystem */,
                                                            std::map<std::string /*type/name/field */,
                                                                std::string  /* value */>>&
                                                                             /* runConditionMap */,
                                                         unsigned int        /* configureConditionID */,
                                                         const std::string&  /* comment */)                 { __SS__ << "insertRunCondition() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!"; __SS_THROW__; };
 
    virtual void            updateRunInfo               (unsigned int        /* runConditionID */,
                                                         RunTransitionType   /* runTransitionType */,
                                                         const std::string&  /* comment */,
                                                         const std::string&  /* metadata */ = "")       { __SS__ << "updateRunInfo() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!"; __SS_THROW__; };
 
 
 
    const std::string&      getActiveStateMachineName   (void) const { return activeStateMachineName_; }
 
    //start queryFilter with 'AND' to fiter more the selection
    virtual std::vector<std::vector<std::string>>
                            getRunRecords               (unsigned int        /* startTime */,
                                                         unsigned int        /* endTime */,
                                                 const std::string&  queryFilter = "",
                                                 const std::string&  runType = "")              { __SS__ << "getRunRecords() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!" << (queryFilter == "" && runType == ""/* use variables */?"":""); __SS_THROW__;};
 
    virtual std::vector<std::vector<std::string>>
                            getRunConditionByID         (uint64_t            /* conditionID*/)              { __SS__ << "getRunConditionByID() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!"; __SS_THROW__; };
 
    virtual std::vector<std::vector<std::string>>
                            getRunConfigSubsystemInfo   (uint64_t            /* configID */)                { __SS__ << "getRunConfigSubsystemInfo() Not implemented by the Run Info Plugin (" << mfSubject_ << ")!!"; __SS_THROW__; };
 
  protected:
    const std::string       mfSubject_; 
    const std::string       activeStateMachineName_;
};
// clang-format on
 
}  // namespace ots
 
#endif