Zivid C++ API 2.13.1+18e79e79-1
Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture Class Reference

CPU architecture. More...

#include <Zivid/Detail/EnvironmentInfo.h>

Public Types

enum class  ValueType { unknown , amd64 , arm64 }
 The type of the underlying value. More...
 

Public Member Functions

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

Static Public Member Functions

static std::set< ValueTypevalidValues ()
 All valid values of Architecture.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "Platform/CPU/Architecture" }
 The full path for this value.
 
static constexpr const char * name { "Architecture" }
 The name of this value.
 
static constexpr const char * description { R"description(CPU architecture)description" }
 The description for this value.
 
static const Architecture unknown
 unknown
 
static const Architecture amd64
 amd64
 
static const Architecture arm64
 arm64
 

Friends

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

Detailed Description

CPU architecture.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value.

Enumerator
unknown 
amd64 
arm64 

Constructor & Destructor Documentation

◆ Architecture() [1/2]

Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::Architecture ( )
default

Default constructor.

◆ Architecture() [2/2]

Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::Architecture ( ValueType value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::operator!= ( const Architecture & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::operator== ( const Architecture & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::toString ( ) const

Get the value as string.

◆ validValues()

static std::set< ValueType > Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::validValues ( )
inlinestatic

All valid values of Architecture.

◆ value()

ValueType Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Architecture >

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

◆ operator<< [1/2]

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

Operator to serialize the value to a stream.

◆ operator<< [2/2]

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

Operator to serialize ValueType to a stream.

Member Data Documentation

◆ amd64

const Architecture Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::amd64
static

amd64

◆ arm64

const Architecture Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::arm64
static

arm64

◆ description

const char* Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::description { R"description(CPU architecture)description" }
staticconstexpr

The description for this value.

◆ name

const char* Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::name { "Architecture" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::path { "Platform/CPU/Architecture" }
staticconstexpr

The full path for this value.

◆ unknown

const Architecture Zivid::Detail::EnvironmentInfo::Platform::CPU::Architecture::unknown
static

unknown


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