Module.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 "EntityOwner.h"
 
#include <ChimeraTK/ReadAnyGroup.h>
#include <ChimeraTK/TransferElement.h>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  class ApplicationModule;
  class ConfigReader;
 
  /********************************************************************************************************************/
 
  class Module : public EntityOwner {
   public:
    Module(EntityOwner* owner, const std::string& name, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
 
    Module() = default;
 
    ~Module() override;
 
    Module(Module&& other) noexcept { operator=(std::move(other)); }
 
    Module& operator=(Module&& other) noexcept;
 
    virtual void postConstruct() {}
 
    virtual void prepare() {}
 
    virtual void run();
 
    virtual void terminate() {}
 
    ChimeraTK::ReadAnyGroup readAnyGroup();
 
    void readAll(bool includeReturnChannels = false);
 
    void readAllNonBlocking(bool includeReturnChannels = false);
 
    void readAllLatest(bool includeReturnChannels = false);
 
    void writeAll(bool includeReturnChannels = false);
 
    void writeAllDestructively(bool includeReturnChannels = false);
 
    std::string getQualifiedName() const override;
 
    virtual std::string getVirtualQualifiedName() const = 0;
 
    std::string getFullDescription() const override;
 
    void setOwner(EntityOwner* newOwner) { _owner = newOwner; }
 
    EntityOwner* getOwner() const { return _owner; }
 
    VersionNumber getCurrentVersionNumber() const override { return _owner->getCurrentVersionNumber(); }
 
    void setCurrentVersionNumber(VersionNumber version) override { _owner->setCurrentVersionNumber(version); }
 
    DataValidity getDataValidity() const override { return _owner->getDataValidity(); }
 
    void incrementDataFaultCounter() override { _owner->incrementDataFaultCounter(); }
 
    void decrementDataFaultCounter() override { _owner->decrementDataFaultCounter(); }
 
    std::list<EntityOwner*> getInputModulesRecursively(std::list<EntityOwner*> startList) override;
 
    size_t getCircularNetworkHash() const override { return _owner->getCircularNetworkHash(); }
 
    Module* findApplicationModule();
 
    static ConfigReader& appConfig();
 
    void disable();
 
   protected:
    EntityOwner* _owner{nullptr};
  };
 
  /********************************************************************************************************************/
 
} /* namespace ChimeraTK */