BackendRegisterInfoBase.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 "AccessMode.h"
#include "DataDescriptor.h"
#include "RegisterPath.h"
 
#include <memory>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  class BackendRegisterInfoBase {
   public:
    virtual ~BackendRegisterInfoBase() = default;
 
    [[nodiscard]] virtual RegisterPath getRegisterName() const = 0;
 
    [[nodiscard]] virtual unsigned int getNumberOfElements() const = 0;
 
    [[nodiscard]] virtual unsigned int getNumberOfChannels() const = 0;
 
    [[nodiscard]] unsigned int getNumberOfDimensions() const;
 
    [[nodiscard]] virtual const DataDescriptor& getDataDescriptor() const = 0;
 
    [[nodiscard]] virtual bool isReadable() const = 0;
 
    [[nodiscard]] virtual bool isWriteable() const = 0;
 
    [[nodiscard]] virtual AccessModeFlags getSupportedAccessModes() const = 0;
 
    [[nodiscard]] virtual std::unique_ptr<BackendRegisterInfoBase> clone() const = 0;
 
    [[nodiscard]] virtual std::vector<size_t> getQualifiedAsyncId() const { return {}; }
 
    [[nodiscard]] virtual std::set<std::string> getTags() const { return {}; };
 
    [[nodiscard]] virtual bool isHidden() const { return false; }
  };
 
  /********************************************************************************************************************/
 
  inline unsigned int BackendRegisterInfoBase::getNumberOfDimensions() const {
    if(getNumberOfChannels() > 1) return 2;
    if(getNumberOfElements() > 1) return 1;
    return 0;
  }
 
} // namespace ChimeraTK