StatusAccessor.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 "Module.h"
#include "ScalarAccessor.h"
 
#include <ChimeraTK/ControlSystemAdapter/StatusAccessorBase.h>
#include <ChimeraTK/SystemTags.h>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  template<typename ACCESSOR>
  struct StatusAccessor : ACCESSOR, StatusAccessorBase {
    StatusAccessor(Module* owner, const std::string& name, const std::string& description,
        const std::unordered_set<std::string>& tags = {})
    : ACCESSOR(owner, name, "", description, tags) {}
    StatusAccessor() = default;
 
    using ACCESSOR::ACCESSOR;
 
    // We want thhs to be implicit, disable the linting here, also need reinterpret cast for now
    // NOLINTNEXTLINE(google-explicit-constructor,cppcoreguidelines-pro-type-reinterpret-cast)
    operator Status&() { return *reinterpret_cast<Status*>(&ACCESSOR::get()->accessData(0, 0)); }
 
    // We want this to be implicit, disable the linting here, also need reinterpret cast for now
    // NOLINTNEXTLINE(google-explicit-constructor,cppcoreguidelines-pro-type-reinterpret-cast)
    operator const Status&() const { return *reinterpret_cast<Status*>(&ACCESSOR::get()->accessData(0, 0)); }
 
    StatusAccessor& operator=(Status rightHandSide) {
      ACCESSOR::get()->accessData(0, 0) = static_cast<int32_t>(rightHandSide);
      return *this;
    }
 
    /* Delete increment/decrement operators since they do not make much sense with a Status */
    void operator++() = delete;
    void operator++(int) = delete;
    void operator--() = delete;
    void operator--(int) = delete;
  };
 
  /********************************************************************************************************************/
 
  struct StatusOutput : StatusAccessor<ScalarOutput<int32_t>> {
    StatusOutput(Module* owner, const std::string& name, const std::string& description,
        const std::unordered_set<std::string>& tags = {})
    : StatusAccessor<ScalarOutput<int32_t>>(owner, name, "", description, tags) {
      addTag(ChimeraTK::SystemTags::statusOutput);
      addTag(explicitDataValidityTag);
    }
    StatusOutput() = default;
    using StatusAccessor<ScalarOutput<int32_t>>::operator=;
 
    void writeIfDifferent(Status newValue) { ScalarOutput<int32_t>::writeIfDifferent(static_cast<int32_t>(newValue)); };
  };
 
  /********************************************************************************************************************/
 
  struct StatusPushInput : StatusAccessor<ScalarPushInput<int32_t>> {
    using StatusAccessor<ScalarPushInput<int32_t>>::StatusAccessor;
    using StatusAccessor<ScalarPushInput<int32_t>>::operator=;
  };
 
  /********************************************************************************************************************/
 
  struct StatusPollInput : StatusAccessor<ScalarPollInput<int32_t>> {
    using StatusAccessor<ScalarPollInput<int32_t>>::StatusAccessor;
    using StatusAccessor<ScalarPollInput<int32_t>>::operator=;
  };
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK