RegisterInfo.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 <iostream>
#include <memory>
 
namespace ChimeraTK {
 
  class RegisterInfo {
   public:
    explicit RegisterInfo(std::unique_ptr<BackendRegisterInfoBase>&& impl);
 
    RegisterInfo(const RegisterInfo& other);
    RegisterInfo(RegisterInfo&& other) = default;
 
    RegisterInfo& operator=(const RegisterInfo& other);
    RegisterInfo& operator=(RegisterInfo&& other) = default;
 
    [[nodiscard]] RegisterPath getRegisterName() const;
 
    [[nodiscard]] unsigned int getNumberOfElements() const;
 
    [[nodiscard]] unsigned int getNumberOfChannels() const;
 
    [[nodiscard]] unsigned int getNumberOfDimensions() const;
 
    [[nodiscard]] const DataDescriptor& getDataDescriptor() const;
 
    [[nodiscard]] bool isReadable() const;
 
    [[nodiscard]] bool isWriteable() const;
 
    [[nodiscard]] AccessModeFlags getSupportedAccessModes() const;
 
    [[nodiscard]] bool isValid() const;
 
    [[nodiscard]] BackendRegisterInfoBase& getImpl();
 
    [[nodiscard]] const BackendRegisterInfoBase& getImpl() const;
 
    [[nodiscard]] std::vector<size_t> getQualifiedAsyncId() const;
 
    [[nodiscard]] std::set<std::string> getTags() const;
 
   protected:
    std::unique_ptr<BackendRegisterInfoBase> _impl;
  };
 
} /* namespace ChimeraTK */