ScriptedInitialisationHandler.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include "ApplicationModule.h"
#include "ScalarAccessor.h"
 
namespace ChimeraTK {
 
  class DeviceModule;
 
  struct ScriptedInitHandler : ApplicationModule {
    ScriptedInitHandler(ModuleGroup* owner, const std::string& name, const std::string& description,
        std::string command, DeviceModule& deviceModule, std::string outputName = "initScriptOutput",
        std::string exitCodeName = "initScriptExitCode", unsigned int errorGracePeriod = 10);
 
    // Alternative constructor signature for backwards compatibility
    ScriptedInitHandler(ModuleGroup* owner, const std::string& name, const std::string& description,
        std::string command, DeviceModule& deviceModule, std::string outputName, unsigned int errorGracePeriod);
 
    void mainLoop() override {
    } // no main loop needed. doInit() is called from the DeviceModule thread as initialisation handler
    void doInit();
 
   protected:
    bool _lastFailed{false};
    std::string _command;
    std::string _deviceAlias;
    std::string _outputName;
    std::string _exitCodeName;
    unsigned int _errorGracePeriod; // additional sleep time before a retry after an error
 
    ScalarOutput<std::string> _scriptOutput{this,
        RegisterPath("/Devices") / Utilities::escapeName(_deviceAlias, false) / _outputName, "",
        "stdout+stderr of init script"};
 
    ScalarOutput<int> _scriptExitCode{this,
        RegisterPath("/Devices") / Utilities::escapeName(_deviceAlias, false) / _exitCodeName, "",
        "exit code of init script"};
  };
 
} // namespace ChimeraTK