Zivid C++ API 2.13.1+18e79e79-1
Zivid::CameraInfo::ModelName Class Reference

The model name of the camera. This is a user-friendly display name that may contain spaces and special characters. We recommend to use Model instead if you want to programmatically check for camera model. More...

#include <Zivid/CameraInfo.h>

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "ModelName" }
 The full path for this value.
 
static constexpr const char * name { "ModelName" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 

Friends

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

Detailed Description

The model name of the camera. This is a user-friendly display name that may contain spaces and special characters. We recommend to use Model instead if you want to programmatically check for camera model.

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.

◆ 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 Symbol 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

const char* Zivid::CameraInfo::ModelName::description
staticconstexpr
Initial value:
{
R"description(The model name of the camera. This is a user-friendly display name that may contain spaces and special
characters. We recommend to use `Model` instead if you want to programmatically check for camera model.
)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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: