Zivid C++ API 2.14.0+e4a0c4a9-1
Zivid::DataModel Namespace Reference

Classes

struct  HasValidRange
 Check if T has a ValidRange constraint. More...
 
struct  HasValidSize
 Check if T has a ValidSize constraint. More...
 
struct  HasValidValues
 Check if data model type T has a ValidValues constraint. More...
 
struct  IsOptional
 

Typedefs

template<typename T >
using IsDataModelType = typename Detail::IsDataModelType<T>::type
 Check if T is a data model type.
 
template<typename T >
using IsDataModelLeaf = typename Detail::IsDataModelLeaf<T>::Type
 Check if T is a data model leaf type.
 
template<typename T >
using IsNestedDataModelLeaf = typename Detail::IsNestedDataModelLeaf<T>
 Check if T is a nested data model leaf type (a leaf with ValueType being another data model)
 
template<typename T >
using IsDataModelRoot = typename Detail::IsDataModelRoot<T>::type
 Check if T is the root of a data model.
 

Enumerations

enum class  NodeType { group , leafDataModelList , leafValue }
 

Functions

ZIVID_UTILS_EXPORT std::ostream & operator<< (std::ostream &stream, NodeType nodeType)
 

Typedef Documentation

◆ IsDataModelLeaf

template<typename T >
using Zivid::DataModel::IsDataModelLeaf = typename Detail::IsDataModelLeaf<T>::Type

Check if T is a data model leaf type.

If T is a data model leaf type (T::nodeType equal to either Zivid::DataModel::NodeType::leafValue or Zivid::DataModel::NodeType::leafDataModelList), provides the member constant value equal to true. Otherwise, value is equal to false.

◆ IsDataModelRoot

template<typename T >
using Zivid::DataModel::IsDataModelRoot = typename Detail::IsDataModelRoot<T>::type

Check if T is the root of a data model.

If T is the root of a data model, provides the member constant value equal to true. Otherwise, value is equal to false.

◆ IsDataModelType

template<typename T >
using Zivid::DataModel::IsDataModelType = typename Detail::IsDataModelType<T>::type

Check if T is a data model type.

If T is a data model type (either a group or leaf type), provides the member constant value equal to true. Otherwise, value is equal to false.

◆ IsNestedDataModelLeaf

template<typename T >
using Zivid::DataModel::IsNestedDataModelLeaf = typename Detail::IsNestedDataModelLeaf<T>

Check if T is a nested data model leaf type (a leaf with ValueType being another data model)

If T is a nested data model leaf type, provides the member constant value equal to true. Otherwise, value is equal to false.

Enumeration Type Documentation

◆ NodeType

enum class Zivid::DataModel::NodeType
strong
Enumerator
group 
leafDataModelList 
leafValue 

Function Documentation

◆ operator<<()

ZIVID_UTILS_EXPORT std::ostream & Zivid::DataModel::operator<< ( std::ostream & stream,
NodeType nodeType )