ScalarAccessor.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 "Application.h"
#include "InversionOfControlAccessor.h"
 
#include <ChimeraTK/ScalarRegisterAccessor.h>
#include <ChimeraTK/SystemTags.h>
 
#include <boost/smart_ptr/shared_ptr.hpp>
#include <boost/thread.hpp>
 
#include <string>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarAccessor : public ChimeraTK::ScalarRegisterAccessor<UserType>,
                         public InversionOfControlAccessor<ScalarAccessor<UserType>> {
   public:
    using InversionOfControlAccessor<ScalarAccessor<UserType>>::operator VariableNetworkNode;
    void replace(const ChimeraTK::NDRegisterAccessorAbstractor<UserType>& newAccessor) = delete;
    using InversionOfControlAccessor<ScalarAccessor<UserType>>::replace;
    ScalarAccessor<UserType>& operator=(ScalarAccessor<UserType>& other) = delete;
    using ChimeraTK::ScalarRegisterAccessor<UserType>::operator=;
 
    ScalarAccessor(ScalarAccessor<UserType>&& other) noexcept;
 
    ScalarAccessor<UserType>& operator=(ScalarAccessor<UserType>&& other) noexcept;
 
    bool write(ChimeraTK::VersionNumber versionNumber) = delete;
    bool writeDestructively(ChimeraTK::VersionNumber versionNumber) = delete;
    void writeIfDifferent(UserType newValue, VersionNumber versionNumber, DataValidity validity) = delete;
    void setAndWrite(UserType newValue, VersionNumber versionNumber) = delete;
 
    bool write();
 
    bool writeDestructively();
 
    void writeIfDifferent(UserType newValue);
 
    void setAndWrite(UserType newValue);
 
    using value_type = UserType;
 
    ~ScalarAccessor() { InversionOfControlAccessor<ScalarAccessor<UserType>>::deinit(); }
 
   protected:
    friend class InversionOfControlAccessor<ScalarAccessor<UserType>>;
 
    ScalarAccessor(Module* owner, const std::string& name, VariableDirection direction, std::string unit,
        UpdateMode mode, const std::string& description, const std::unordered_set<std::string>& tags = {});
 
    ScalarAccessor() = default;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarPushInput : public ScalarAccessor<UserType> {
   public:
    ScalarPushInput(Module* owner, const std::string& name, std::string unit, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
    ScalarPushInput() : ScalarAccessor<UserType>() {}
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarPollInput : public ScalarAccessor<UserType> {
   public:
    ScalarPollInput(Module* owner, const std::string& name, std::string unit, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
    ScalarPollInput() : ScalarAccessor<UserType>() {}
    void read() { this->readLatest(); }
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarOutput : public ScalarAccessor<UserType> {
   public:
    ScalarOutput(Module* owner, const std::string& name, std::string unit, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
    ScalarOutput() : ScalarAccessor<UserType>() {}
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarPushInputWB : public ScalarAccessor<UserType> {
   public:
    ScalarPushInputWB(Module* owner, const std::string& name, std::string unit, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
    ScalarPushInputWB() : ScalarAccessor<UserType>() {}
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarOutputPushRB : public ScalarAccessor<UserType> {
   public:
    ScalarOutputPushRB(Module* owner, const std::string& name, std::string unit, const std::string& description,
        const std::unordered_set<std::string>& tags = {});
    ScalarOutputPushRB() : ScalarAccessor<UserType>() {}
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarOutputReverseRecovery : public ScalarAccessor<UserType> {
   public:
    ScalarOutputReverseRecovery(Module* owner, const std::string& name, std::string unit,
        const std::string& description, const std::unordered_set<std::string>& tags = {});
    ScalarOutputReverseRecovery() : ScalarAccessor<UserType>() {}
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarPushInputNoInitialValue : public ScalarAccessor<UserType> {
   public:
    ScalarPushInputNoInitialValue(Module* owner, const std::string& name, std::string unit,
        const std::string& description, const std::unordered_set<std::string>& tags = {});
    ScalarPushInputNoInitialValue() : ScalarAccessor<UserType>() {}
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  class ScalarPollInputNoInitialValue : public ScalarAccessor<UserType> {
   public:
    ScalarPollInputNoInitialValue(Module* owner, const std::string& name, std::string unit,
        const std::string& description, const std::unordered_set<std::string>& tags = {});
    ScalarPollInputNoInitialValue() : ScalarAccessor<UserType>() {}
    void read() { this->readLatest(); }
    using ScalarAccessor<UserType>::operator=;
  };
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
  /* Implementations below this point                                                                                 */
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarAccessor<UserType>::ScalarAccessor(ScalarAccessor<UserType>&& other) noexcept {
    InversionOfControlAccessor<ScalarAccessor<UserType>>::replace(std::move(other));
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarAccessor<UserType>& ScalarAccessor<UserType>::operator=(ScalarAccessor<UserType>&& other) noexcept {
    // Having a move-assignment operator is required to use the move-assignment
    // operator of a module containing an accessor.
    InversionOfControlAccessor<ScalarAccessor<UserType>>::replace(std::move(other));
    return *this;
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  bool ScalarAccessor<UserType>::write() {
    auto versionNumber = this->getOwner()->getCurrentVersionNumber();
    bool dataLoss = ChimeraTK::ScalarRegisterAccessor<UserType>::write(versionNumber);
    if(dataLoss) {
      Application::incrementDataLossCounter(this->_node.getQualifiedName());
    }
    return dataLoss;
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  bool ScalarAccessor<UserType>::writeDestructively() {
    auto versionNumber = this->getOwner()->getCurrentVersionNumber();
    bool dataLoss = ChimeraTK::ScalarRegisterAccessor<UserType>::writeDestructively(versionNumber);
    if(dataLoss) {
      Application::incrementDataLossCounter(this->_node.getQualifiedName());
    }
    return dataLoss;
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  void ScalarAccessor<UserType>::writeIfDifferent(UserType newValue) {
    if(this->get()->accessData(0, 0) != newValue || this->template checkMetadataWriteDifference<UserType>()) {
      setAndWrite(newValue);
    }
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  void ScalarAccessor<UserType>::setAndWrite(UserType newValue) {
    operator=(newValue);
    this->write();
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarAccessor<UserType>::ScalarAccessor(Module* owner, const std::string& name, VariableDirection direction,
      std::string unit, UpdateMode mode, const std::string& description, const std::unordered_set<std::string>& tags)
  : InversionOfControlAccessor<ScalarAccessor<UserType>>(
        owner, name, direction, unit, 1, mode, description, &typeid(UserType), tags) {
    InversionOfControlAccessor<ScalarAccessor<UserType>>::init();
  }
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarPushInput<UserType>::ScalarPushInput(Module* owner, const std::string& name, std::string unit,
      const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::consuming, false}, unit, UpdateMode::push, description, tags) {}
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarPollInput<UserType>::ScalarPollInput(Module* owner, const std::string& name, std::string unit,
      const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::consuming, false}, unit, UpdateMode::poll, description, tags) {}
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarOutput<UserType>::ScalarOutput(Module* owner, const std::string& name, std::string unit,
      const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::feeding, false}, unit, UpdateMode::push, description, tags) {}
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarPushInputWB<UserType>::ScalarPushInputWB(Module* owner, const std::string& name, std::string unit,
      const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::consuming, true}, unit, UpdateMode::push, description, tags) {}
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarOutputPushRB<UserType>::ScalarOutputPushRB(Module* owner, const std::string& name, std::string unit,
      const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::feeding, true}, unit, UpdateMode::push, description, tags) {}
 
  /********************************************************************************************************************/
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarOutputReverseRecovery<UserType>::ScalarOutputReverseRecovery(Module* owner, const std::string& name,
      std::string unit, const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::feeding, true}, unit, UpdateMode::push, description, tags) {
    this->addTag(ChimeraTK::SystemTags::reverseRecovery);
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarPushInputNoInitialValue<UserType>::ScalarPushInputNoInitialValue(Module* owner, const std::string& name,
      std::string unit, const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::consuming, false}, unit, UpdateMode::push, description, tags) {
    this->addTag(ChimeraTK::noInitialValueReadTag);
  }
 
  /********************************************************************************************************************/
 
  template<typename UserType>
  ScalarPollInputNoInitialValue<UserType>::ScalarPollInputNoInitialValue(Module* owner, const std::string& name,
      std::string unit, const std::string& description, const std::unordered_set<std::string>& tags)
  : ScalarAccessor<UserType>(
        owner, name, {VariableDirection::consuming, false}, unit, UpdateMode::poll, description, tags) {
    this->addTag(ChimeraTK::noInitialValueReadTag);
  }
 
  /********************************************************************************************************************/
 
} /* namespace ChimeraTK */