LNMBackendRegisterInfo.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 "BackendRegisterInfoBase.h"
 
#include <boost/shared_ptr.hpp>
 
namespace ChimeraTK {
 
  namespace LNMBackend {
    class AccessorPluginBase;
  } // namespace LNMBackend
 
  class LNMBackendRegisterInfo : public BackendRegisterInfoBase {
   public:
    enum TargetType { INVALID, REGISTER, CHANNEL, BIT, CONSTANT, VARIABLE };
 
    LNMBackendRegisterInfo() = default;
    LNMBackendRegisterInfo(const LNMBackendRegisterInfo&) = default;
    LNMBackendRegisterInfo& operator=(const LNMBackendRegisterInfo& other) = default;
 
    [[nodiscard]] bool operator==(const LNMBackendRegisterInfo&) const = default;
 
    [[nodiscard]] RegisterPath getRegisterName() const override { return name; }
 
    [[nodiscard]] unsigned int getNumberOfElements() const override { return length; }
 
    [[nodiscard]] unsigned int getNumberOfChannels() const override { return nChannels; }
 
    [[nodiscard]] const DataDescriptor& getDataDescriptor() const override { return _dataDescriptor; }
 
    [[nodiscard]] bool isReadable() const override { return readable; }
 
    [[nodiscard]] bool isWriteable() const override { return writeable; }
 
    [[nodiscard]] AccessModeFlags getSupportedAccessModes() const override { return supportedFlags; }
 
    [[nodiscard]] std::set<std::string> getTags() const override { return tags; }
 
    RegisterPath name;
 
    TargetType targetType{TargetType::INVALID};
 
    std::string deviceName;
 
    std::string registerName;
 
    unsigned int firstIndex{};
 
    unsigned int length{};
 
    unsigned int channel{};
 
    unsigned int bit{};
 
    unsigned int nChannels{};
 
    DataType valueType;
 
    bool readable{};
 
    bool writeable{};
 
    AccessModeFlags supportedFlags;
 
    std::vector<boost::shared_ptr<LNMBackend::AccessorPluginBase>> plugins;
 
    DataDescriptor _dataDescriptor;
 
    std::set<std::string> tags;
 
    std::string engineeringUnit;
 
    std::string description;
 
    [[nodiscard]] std::string getUnit() const override { return engineeringUnit; }
 
    [[nodiscard]] std::string getDescription() const override { return description; }
 
    [[nodiscard]] std::unique_ptr<BackendRegisterInfoBase> clone() const override {
      return std::make_unique<LNMBackendRegisterInfo>(*this);
    }
  };
 
  /********************************************************************************************************************/
} /* namespace ChimeraTK */