Application.h

Go to the documentation of this file.

// $Id: Application.h 4781 2021-07-14 12:28:15Z linev $
 
/************************************************************
 * The Data Acquisition Backbone Core (DABC)                *
 ************************************************************
 * Copyright (C) 2009 -                                     *
 * GSI Helmholtzzentrum fuer Schwerionenforschung GmbH      *
 * Planckstr. 1, 64291 Darmstadt, Germany                   *
 * Contact:  http://dabc.gsi.de                             *
 ************************************************************
 * This software can be used under the GPL license          *
 * agreements as stated in LICENSE.txt file                 *
 * which is part of the distribution.                       *
 ************************************************************/
 
#ifndef DABC_Application
#define DABC_Application
 
#ifndef DABC_Worker
#include "dabc/Worker.h"
#endif
 
namespace dabc {
 
   class CmdStateTransition : public Command {
      DABC_COMMAND(CmdStateTransition, "CmdStateTransition");
 
      CmdStateTransition(const std::string &state) :
         dabc::Command(CmdName())
      {
         SetStr("State", state);
      }
   };
 
 
   class Manager;
   class ApplicationRef;
 
   class Application : public Worker {
 
      friend class Manager;
      friend class ApplicationRef;
 
      public:
 
         typedef void* ExternalFunction();
 
         // these are states in default state machine
         static const char* stHalted()  { return "Halted"; }
         static const char* stReady()   { return "Ready"; }
         static const char* stRunning() { return "Running"; }
         static const char* stFailure() { return "Failure"; }
         static const char* stTransition() { return "Transition"; }
 
         // these are commands provided by state machine
         static const char* stcmdDoConfigure() { return "DoConfigure"; }
         static const char* stcmdDoStart() { return "DoStart"; }
         static const char* stcmdDoStop()  { return "DoStop"; }
         static const char* stcmdDoHalt()  { return "DoHalt"; }
 
      private:
 
         int CallInitFunc(Command statecmd, const std::string &tgtstate);
 
      protected:
 
         std::string        fAppClass;
 
         ExternalFunction*  fInitFunc;
 
         bool               fAnyModuleWasRunning; 
 
         bool               fSelfControl;   
 
         double             fConnTimeout;   
 
         std::vector<std::string> fAppDevices;   
         std::vector<std::string> fAppPools;     
         std::vector<std::string> fAppModules;   
 
         virtual int ExecuteCommand(Command cmd);
         virtual bool ReplyCommand(Command cmd);
 
         virtual void OnThreadAssigned();
 
         virtual void ObjectCleanup();
 
         void SetAppState(const std::string &name);
 
         void SetInitFunc(ExternalFunction* initfunc);
 
         virtual bool IsModulesRunning();
 
         virtual bool CreateAppModules() { return false; }
 
         virtual bool StartModules();
 
         virtual bool StopModules();
 
         virtual bool CleanupApplication();
 
         virtual int DoTransition(const std::string &state, Command cmd);
 
         virtual int SMCommandTimeout() const { return 10; }
 
         virtual void BuildFieldsMap(RecordFieldsMap* cont);
 
         virtual double ProcessTimeout(double);
 
      public:
 
         Application(const char* classname = 0);
         virtual ~Application();
 
         static const char* StateParName() { return "State"; }
 
         std::string GetState() const { return Par(StateParName()).Value().AsStr(); }
 
         virtual bool Find(ConfigIO &cfg);
 
         virtual const char* ClassName() const { return fAppClass.c_str(); }
   };
 
   // ________________________________________________________________________________
 
 
   class ApplicationRef : public WorkerRef {
 
      DABC_REFERENCE(ApplicationRef, WorkerRef, Application)
 
      bool ChangeState(const std::string &state)
      { return Execute(CmdStateTransition(state)); }
 
      bool StartAllModules()
      { return Execute("StartAllModules"); }
 
      bool StopAllModules()
      { return Execute("StopAllModules"); }
 
      bool AddObject(const std::string &kind, const std::string &name);
 
   };
 
 
 
}
 
#endif