Zivid::Detail::EnvironmentInfo::Platform::OS::ID Class Reference

Operating system name. More...

#include <Zivid/Detail/EnvironmentInfo.h>

Public Types
enum class	ValueType { unknown , windows , gnulinux }
	The type of the underlying value. More...

Public Member Functions
	ID ()=default
	Default constructor.
constexpr	ID (ValueType value)
	Constructor.
ValueType	value () const
	Get the value.
std::string	toString () const
	Get the value as string.
bool	operator== (const ID &other) const
	Comparison operator.
bool	operator!= (const ID &other) const
	Comparison operator.

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of ID.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Platform/OS/ID" }
	The full path for this value.
static constexpr const char *	name { "ID" }
	The name of this value.
static constexpr const char *	description { R"description(Operating system name)description" }
	The description for this value.
static const ID	unknown
	unknown
static const ID	windows
	windows
static const ID	gnulinux
	gnulinux

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

Detailed Description

Operating system name.

Member Enumeration Documentation

ValueType

enum class Zivid::Detail::EnvironmentInfo::Platform::OS::ID::ValueType

strong

The type of the underlying value.

Enumerator
unknown
windows
gnulinux

Constructor & Destructor Documentation

ID() [1/2]

Zivid::Detail::EnvironmentInfo::Platform::OS::ID::ID ( )

default

Default constructor.

ID() [2/2]

Zivid::Detail::EnvironmentInfo::Platform::OS::ID::ID ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::Detail::EnvironmentInfo::Platform::OS::ID::operator!= ( const ID & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Detail::EnvironmentInfo::Platform::OS::ID::operator== ( const ID & other ) const

inline

Comparison operator.

toString()

std::string Zivid::Detail::EnvironmentInfo::Platform::OS::ID::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::Detail::EnvironmentInfo::Platform::OS::ID::validValues ( )

inlinestatic

All valid values of ID.

value()

ValueType Zivid::Detail::EnvironmentInfo::Platform::OS::ID::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< ID >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

std::ostream & operator<< ( std::ostream & stream, const ID::ValueType & value )

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

description

const char* Zivid::Detail::EnvironmentInfo::Platform::OS::ID::description { R"description(Operating system name)description" }

staticconstexpr

The description for this value.

gnulinux

const ID Zivid::Detail::EnvironmentInfo::Platform::OS::ID::gnulinux

static

gnulinux

name

const char* Zivid::Detail::EnvironmentInfo::Platform::OS::ID::name { "ID" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Detail::EnvironmentInfo::Platform::OS::ID::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::Detail::EnvironmentInfo::Platform::OS::ID::path { "Platform/OS/ID" }

staticconstexpr

The full path for this value.

unknown

const ID Zivid::Detail::EnvironmentInfo::Platform::OS::ID::unknown

static

unknown

windows

const ID Zivid::Detail::EnvironmentInfo::Platform::OS::ID::windows

static

windows

---

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

• Zivid/Detail/EnvironmentInfo.h