DataType.h

#pragma once
 
#include <iolink/IOLinkAPI.h>
#include <iolink/Vector.h>
 
#include <iostream>
 
namespace iolink
{
 
enum class PrimitiveTypeId : uint16_t
{
  UNKNOWN = 0x0000,
 
  UNSIGNED_INTEGER = 0x0001,
 
  SIGNED_INTEGER = 0x0002,
 
  FLOATING_POINT = 0x0003,
 
  UNICODE_STRING = 0x0004,
};
 
enum class DataTypeInterpretation : uint32_t
{
  RAW = 0,
 
  COMPLEX,
 
  SQUARE_MATRIX,
 
  SYMMETRIC_MATRIX,
};
 
enum class DataTypeId : uint64_t
{
  UNKNOWN = 0x0000000000000000,            
  UINT8 = 0x0000000000010108,              
  UINT16 = 0x0000000000010110,             
  UINT32 = 0x0000000000010120,             
  UINT64 = 0x0000000000010140,             
  INT8 = 0x0000000000020108,               
  INT16 = 0x0000000000020110,              
  INT32 = 0x0000000000020120,              
  INT64 = 0x0000000000020140,              
  FLOAT = 0x0000000000030120,              
  DOUBLE = 0x0000000000030140,             
  UTF8_STRING = 0x0000000000040108,        
  UTF16_STRING = 0x0000000000040110,       
  UTF32_STRING = 0x0000000000040120,       
  VEC2_UINT8 = 0x0000000000010208,         
  VEC2_UINT16 = 0x0000000000010210,        
  VEC2_UINT32 = 0x0000000000010220,        
  VEC2_UINT64 = 0x0000000000010240,        
  VEC2_INT8 = 0x0000000000020208,          
  VEC2_INT16 = 0x0000000000020210,         
  VEC2_INT32 = 0x0000000000020220,         
  VEC2_INT64 = 0x0000000000020240,         
  VEC2_FLOAT = 0x0000000000030220,         
  VEC2_DOUBLE = 0x0000000000030240,        
  VEC3_UINT8 = 0x0000000000010308,         
  VEC3_UINT16 = 0x0000000000010310,        
  VEC3_UINT32 = 0x0000000000010320,        
  VEC3_UINT64 = 0x0000000000010340,        
  VEC3_INT8 = 0x0000000000020308,          
  VEC3_INT16 = 0x0000000000020310,         
  VEC3_INT32 = 0x0000000000020320,         
  VEC3_INT64 = 0x0000000000020340,         
  VEC3_FLOAT = 0x0000000000030320,         
  VEC3_DOUBLE = 0x0000000000030340,        
  VEC4_UINT8 = 0x0000000000010408,         
  VEC4_UINT16 = 0x0000000000010410,        
  VEC4_UINT32 = 0x0000000000010420,        
  VEC4_UINT64 = 0x0000000000010440,        
  VEC4_INT8 = 0x0000000000020408,          
  VEC4_INT16 = 0x0000000000020410,         
  VEC4_INT32 = 0x0000000000020420,         
  VEC4_INT64 = 0x0000000000020440,         
  VEC4_FLOAT = 0x0000000000030420,         
  VEC4_DOUBLE = 0x0000000000030440,        
  COMPLEX_FLOAT = 0x0000000100030220,      
  COMPLEX_DOUBLE = 0x0000000100030240,     
  MATRIX2_FLOAT = 0x0000000200030420,      
  MATRIX2_DOUBLE = 0x0000000200030440,     
  MATRIX3_FLOAT = 0x0000000200030920,      
  MATRIX3_DOUBLE = 0x0000000200030940,     
  MATRIX4_FLOAT = 0x0000000200031020,      
  MATRIX4_DOUBLE = 0x0000000200031040,     
  SYM_MATRIX2_FLOAT = 0x0000000300030320,  
  SYM_MATRIX2_DOUBLE = 0x0000000300030340, 
  SYM_MATRIX3_FLOAT = 0x0000000300030620,  
  SYM_MATRIX3_DOUBLE = 0x0000000300030640  
};
 
class IOLINK_API DataType
{
 
public:
  static DataType extractScalarType(DataType dtype);
 
  static Vector2d standardRange(DataType dtype);
 
  DataType() noexcept;
 
  explicit DataType(uint64_t value) noexcept;
 
  DataType(DataTypeId value) noexcept;
 
  DataType(PrimitiveTypeId primitiveType,
           size_t dimension,
           size_t bitDepth,
           DataTypeInterpretation interpretation) noexcept;
 
  DataType(PrimitiveTypeId primitiveType, size_t dimension, size_t bitDepth) noexcept;
 
  bool isNumeric() const;
 
  bool isScalar() const;
 
  bool isVector() const;
 
  bool isConvertibleTo(DataType other) const;
 
  uint64_t id() const noexcept;
 
  inline size_t bitDepth() const noexcept { return m_bitDepth; }
 
  inline size_t elementCount() const noexcept { return m_dimension; }
 
  inline PrimitiveTypeId primitiveType() const noexcept { return m_primitiveType; }
 
  inline DataTypeInterpretation interpretation() const noexcept { return m_interpretation; }
 
  inline size_t bitCount() const { return m_bitDepth * m_dimension; }
 
  size_t byteCount() const { return (m_bitDepth * m_dimension - 1) / 8 + 1; }
 
  std::string toString() const;
 
  bool operator==(DataType other) const;
  bool operator!=(DataType other) const;
 
private:
  uint8_t m_bitDepth;
  uint8_t m_dimension;
  PrimitiveTypeId m_primitiveType;
  DataTypeInterpretation m_interpretation;
};
 
inline std::ostream&
operator<<(std::ostream& os, const DataType datatype)
{
  os << datatype.toString().c_str();
  return os;
}
 
} // end namespace iolink