Zivid C++ API 2.18.0+1b44dbef-1
Zivid::CameraHealth::InfieldVerification::Value Class Reference

Time of the most recent infield verification. More...

#include <Zivid/CameraHealth.h>

Public Types

using ValueType = std::chrono::system_clock::time_point
 The type of the underlying value.

Public Member Functions

 Value ()=default
 Default constructor.
constexpr Value (std::chrono::system_clock::time_point value)
 Constructor.
std::chrono::system_clock::time_point value () const
 Get the value.
bool hasValue () const
 Check if the value is set.
void reset ()
 Reset the node to unset state.
std::string toString () const
 Get the value as string.
bool operator== (const Value &other) const
 Comparison operator.
bool operator!= (const Value &other) const
 Comparison operator.
bool operator< (const Value &other) const
 Comparison operator.
bool operator> (const Value &other) const
 Comparison operator.
bool operator<= (const Value &other) const
 Comparison operator.
bool operator>= (const Value &other) const
 Comparison operator.

Static Public Member Functions

static constexpr Range< std::chrono::system_clock::time_point > validRange ()
 The range of valid values for Value.

Static Public Attributes

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

Friends

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

Detailed Description

Time of the most recent infield verification.

Member Typedef Documentation

◆ ValueType

using Zivid::CameraHealth::InfieldVerification::Value::ValueType = std::chrono::system_clock::time_point

The type of the underlying value.

Constructor & Destructor Documentation

◆ Value() [1/2]

Zivid::CameraHealth::InfieldVerification::Value::Value ( )
default

Default constructor.

◆ Value() [2/2]

Zivid::CameraHealth::InfieldVerification::Value::Value ( std::chrono::system_clock::time_point value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ hasValue()

bool Zivid::CameraHealth::InfieldVerification::Value::hasValue ( ) const

Check if the value is set.

◆ operator!=()

bool Zivid::CameraHealth::InfieldVerification::Value::operator!= ( const Value & other) const
inline

Comparison operator.

◆ operator<()

bool Zivid::CameraHealth::InfieldVerification::Value::operator< ( const Value & other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::CameraHealth::InfieldVerification::Value::operator<= ( const Value & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CameraHealth::InfieldVerification::Value::operator== ( const Value & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::CameraHealth::InfieldVerification::Value::operator> ( const Value & other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::CameraHealth::InfieldVerification::Value::operator>= ( const Value & other) const
inline

Comparison operator.

◆ reset()

void Zivid::CameraHealth::InfieldVerification::Value::reset ( )

Reset the node to unset state.

◆ toString()

std::string Zivid::CameraHealth::InfieldVerification::Value::toString ( ) const

Get the value as string.

◆ validRange()

constexpr Range< std::chrono::system_clock::time_point > Zivid::CameraHealth::InfieldVerification::Value::validRange ( )
inlinestaticconstexpr

The range of valid values for Value.

◆ value()

std::chrono::system_clock::time_point Zivid::CameraHealth::InfieldVerification::Value::value ( ) const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

◆ DataModel::Detail::Befriend< Value >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraHealth::InfieldVerification::Value::description
staticconstexpr
Initial value:
{
R"description(Time of the most recent infield verification.)description"
}

The description for this value.

◆ name

const char* Zivid::CameraHealth::InfieldVerification::Value::name { "Value" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraHealth::InfieldVerification::Value::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraHealth::InfieldVerification::Value::path { "InfieldVerification/Value" }
staticconstexpr

The full path for this value.


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