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

The firmware version on the camera. More...

#include <Zivid/CameraInfo.h>

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

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

Friends

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

Detailed Description

The firmware version on the camera.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ FirmwareVersion() [1/2]

Zivid::CameraInfo::FirmwareVersion::FirmwareVersion ( )
default

Default constructor.

◆ FirmwareVersion() [2/2]

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

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

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

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

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

Comparison operator.

◆ operator>()

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

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ toString()

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

Get the value as string.

◆ validSize()

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

The valid sizes for FirmwareVersion.

◆ value()

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

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< FirmwareVersion >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraInfo::FirmwareVersion::description { R"description(The firmware version on the camera)description" }
staticconstexpr

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.


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