Zivid C++ API 2.11.1+de9b5dae-1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraInfo::UserData::MaxSizeBytes Class Reference

The maximum number of bytes of user data that can be stored in the camera. More...

#include <Zivid/CameraInfo.h>

Public Types

using ValueType = uint64_t
 The type of the underlying value.
 

Public Member Functions

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

Static Public Member Functions

static constexpr Range< uint64_tvalidRange ()
 The range of valid values for MaxSizeBytes.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const charpath { "UserData/MaxSizeBytes" }
 The full path for this value.
 
static constexpr const charname { "MaxSizeBytes" }
 The name of this value.
 
static constexpr const chardescription
 The description for this value.
 

Friends

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

Detailed Description

The maximum number of bytes of user data that can be stored in the camera.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ MaxSizeBytes() [1/2]

Zivid::CameraInfo::UserData::MaxSizeBytes::MaxSizeBytes ( )
default

Default constructor.

◆ MaxSizeBytes() [2/2]

constexpr Zivid::CameraInfo::UserData::MaxSizeBytes::MaxSizeBytes ( uint64_t  value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

bool Zivid::CameraInfo::UserData::MaxSizeBytes::operator< ( const MaxSizeBytes other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::CameraInfo::UserData::MaxSizeBytes::operator<= ( const MaxSizeBytes other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CameraInfo::UserData::MaxSizeBytes::operator== ( const MaxSizeBytes other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::CameraInfo::UserData::MaxSizeBytes::operator> ( const MaxSizeBytes other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::CameraInfo::UserData::MaxSizeBytes::operator>= ( const MaxSizeBytes other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::CameraInfo::UserData::MaxSizeBytes::toString ( ) const

Get the value as string.

◆ validRange()

static constexpr Range< uint64_t > Zivid::CameraInfo::UserData::MaxSizeBytes::validRange ( )
inlinestaticconstexpr

The range of valid values for MaxSizeBytes.

◆ value()

uint64_t Zivid::CameraInfo::UserData::MaxSizeBytes::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< MaxSizeBytes >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraInfo::UserData::MaxSizeBytes::description
staticconstexpr
Initial value:
{
R"description(The maximum number of bytes of user data that can be stored in the camera)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraInfo::UserData::MaxSizeBytes::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::CameraInfo::UserData::MaxSizeBytes::path { "UserData/MaxSizeBytes" }
staticconstexpr

The full path for this value.


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