Zivid C++ API  2.4.2+1a2e8cfb-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraInfo::ModelName Class Reference

The model name of the camera More...

#include <Zivid/CameraInfo.h>

Public Types

using ValueType = std::string
 The type of the underlying value More...
 

Public Member Functions

 ModelName ()=default
 Default constructor More...
 
 ModelName (std::string value)
 Constructor More...
 
const std::string & value () const
 Get the value More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const ModelName &other) const
 Comparison operator More...
 
bool operator!= (const ModelName &other) const
 Comparison operator More...
 
bool operator< (const ModelName &other) const
 Comparison operator More...
 
bool operator> (const ModelName &other) const
 Comparison operator More...
 

Static Public Member Functions

static constexpr Range< ValueType::size_type > validSize ()
 The valid sizes for ModelName More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path { "ModelName" }
 The full path for this value More...
 
static constexpr const char * name { "ModelName" }
 The name of this value More...
 
static constexpr const char * description { R"description(The model name of the camera)description" }
 The description for this value More...
 

Friends

struct DataModel::Detail::Befriend< ModelName >
 
std::ostream & operator<< (std::ostream &stream, const ModelName &value)
 Operator to serialize the value to a stream More...
 

Detailed Description

The model name of the camera

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ ModelName() [1/2]

Zivid::CameraInfo::ModelName::ModelName ( )
default

Default constructor

◆ ModelName() [2/2]

Zivid::CameraInfo::ModelName::ModelName ( std::string  value)
inlineexplicit

Constructor

Member Function Documentation

◆ operator!=()

bool Zivid::CameraInfo::ModelName::operator!= ( const ModelName other) const
inline

Comparison operator

◆ operator<()

bool Zivid::CameraInfo::ModelName::operator< ( const ModelName other) const
inline

Comparison operator

◆ operator==()

bool Zivid::CameraInfo::ModelName::operator== ( const ModelName other) const
inline

Comparison operator

◆ operator>()

bool Zivid::CameraInfo::ModelName::operator> ( const ModelName other) const
inline

Comparison operator

◆ toString()

std::string Zivid::CameraInfo::ModelName::toString ( ) const

Get the value as string

◆ validSize()

static constexpr Range<ValueType::size_type> Zivid::CameraInfo::ModelName::validSize ( )
inlinestaticconstexpr

The valid sizes for ModelName

◆ value()

const std::string& Zivid::CameraInfo::ModelName::value ( ) const

Get the value

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< ModelName >

friend struct DataModel::Detail::Befriend< ModelName >
friend

◆ operator<<

std::ostream& operator<< ( std::ostream &  stream,
const ModelName value 
)
friend

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraInfo::ModelName::description { R"description(The model name of the camera)description" }
staticconstexpr

The description for this value

◆ name

constexpr const char* Zivid::CameraInfo::ModelName::name { "ModelName" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraInfo::ModelName::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::CameraInfo::ModelName::path { "ModelName" }
staticconstexpr

The full path for this value


The documentation for this class was generated from the following file: