Zivid C++ API 2.17.1+7516d437-1
Zivid::FrameInfo::SystemInfo::OperatingSystem Class Reference

Operating system. More...

#include <Zivid/FrameInfo.h>

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
static constexpr const char * path { "SystemInfo/OperatingSystem" }
 The full path for this value.
static constexpr const char * name { "OperatingSystem" }
 The name of this value.
static constexpr const char * description { R"description(Operating system)description" }
 The description for this value.

Friends

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

Detailed Description

Operating system.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ OperatingSystem() [1/2]

Zivid::FrameInfo::SystemInfo::OperatingSystem::OperatingSystem ( )
default

Default constructor.

◆ OperatingSystem() [2/2]

Zivid::FrameInfo::SystemInfo::OperatingSystem::OperatingSystem ( std::string value)
inlineexplicit

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::FrameInfo::SystemInfo::OperatingSystem::operator!= ( const OperatingSystem & other) const
inline

Comparison operator.

◆ operator<()

bool Zivid::FrameInfo::SystemInfo::OperatingSystem::operator< ( const OperatingSystem & other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::FrameInfo::SystemInfo::OperatingSystem::operator<= ( const OperatingSystem & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::FrameInfo::SystemInfo::OperatingSystem::operator== ( const OperatingSystem & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::FrameInfo::SystemInfo::OperatingSystem::operator> ( const OperatingSystem & other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::FrameInfo::SystemInfo::OperatingSystem::operator>= ( const OperatingSystem & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::FrameInfo::SystemInfo::OperatingSystem::toString ( ) const

Get the value as string.

◆ validSize()

constexpr Range< ValueType::size_type > Zivid::FrameInfo::SystemInfo::OperatingSystem::validSize ( )
inlinestaticconstexpr

The valid sizes for OperatingSystem.

◆ value()

const std::string & Zivid::FrameInfo::SystemInfo::OperatingSystem::value ( ) const

Get the value.

◆ DataModel::Detail::Befriend< OperatingSystem >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::FrameInfo::SystemInfo::OperatingSystem::description { R"description(Operating system)description" }
staticconstexpr

The description for this value.

◆ name

const char* Zivid::FrameInfo::SystemInfo::OperatingSystem::name { "OperatingSystem" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::FrameInfo::SystemInfo::OperatingSystem::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::FrameInfo::SystemInfo::OperatingSystem::path { "SystemInfo/OperatingSystem" }
staticconstexpr

The full path for this value.


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