DataDescriptor.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 "SupportedUserTypes.h"
 
#include <cassert>
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  class DataDescriptor {
   public:
    enum class FundamentalType { numeric, string, boolean, nodata, undefined };
 
    explicit DataDescriptor(FundamentalType fundamentalType_, bool isIntegral_ = false, bool isSigned_ = false,
        size_t nDigits_ = 0, size_t nFractionalDigits_ = 0, DataType rawDataType_ = DataType::none,
        DataType transportLayerDataType_ = DataType::none);
 
    explicit DataDescriptor(DataType type);
 
    DataDescriptor();
 
    [[nodiscard]] FundamentalType fundamentalType() const;
 
    [[nodiscard]] bool isSigned() const;
 
    [[nodiscard]] bool isIntegral() const;
 
    [[nodiscard]] size_t nDigits() const;
 
    [[nodiscard]] size_t nFractionalDigits() const;
 
    [[nodiscard]] DataType rawDataType() const;
 
    void setRawDataType(const DataType& d);
 
    [[nodiscard]] DataType transportLayerDataType() const;
 
    [[nodiscard]] DataType minimumDataType() const;
 
    bool operator==(const DataDescriptor& other) const;
    bool operator!=(const DataDescriptor& other) const;
 
   private:
    FundamentalType _fundamentalType;
 
    DataType _rawDataType;
 
    DataType _transportLayerDataType;
 
    bool _isIntegral;
 
    bool _isSigned;
 
    size_t _nDigits;
 
    size_t _nFractionalDigits;
  };
 
  /********************************************************************************************************************/
 
  std::ostream& operator<<(std::ostream& stream, const DataDescriptor::FundamentalType& fundamentalType);
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK