Zivid C++ API 2.14.0+e4a0c4a9-1
Zivid::CameraInfo::HardwareRevision Class Reference

Hardware revision of this camera. This corresponds to the revision string that is printed on the product label. More...

#include <Zivid/CameraInfo.h>

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

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

Friends

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

Detailed Description

Hardware revision of this camera. This corresponds to the revision string that is printed on the product label.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ HardwareRevision() [1/2]

Zivid::CameraInfo::HardwareRevision::HardwareRevision ( )
default

Default constructor.

◆ HardwareRevision() [2/2]

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

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

bool Zivid::CameraInfo::HardwareRevision::operator< ( const HardwareRevision & other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::CameraInfo::HardwareRevision::operator<= ( const HardwareRevision & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CameraInfo::HardwareRevision::operator== ( const HardwareRevision & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::CameraInfo::HardwareRevision::operator> ( const HardwareRevision & other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::CameraInfo::HardwareRevision::operator>= ( const HardwareRevision & other) const
inline

Comparison operator.

◆ toString()

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

Get the value as string.

◆ validSize()

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

The valid sizes for HardwareRevision.

◆ value()

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

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< HardwareRevision >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraInfo::HardwareRevision::description
staticconstexpr
Initial value:
{
R"description(Hardware revision of this camera. This corresponds to the revision string that is printed on the product
label.
)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

const char* Zivid::CameraInfo::HardwareRevision::path { "HardwareRevision" }
staticconstexpr

The full path for this value.


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