Zivid C++ API 2.13.1+18e79e79-1
Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID Class Reference

The name of the compiler. More...

#include <Zivid/Detail/EnvironmentInfo.h>

Public Types

enum class  ValueType {
  unknown , msvc , clang , gcc ,
  intel , mingwGcc , mingwClang , mingwUnknown
}
 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< ValueTypevalidValues ()
 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 { "UserToolchain/Compiler/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(The name of the compiler)description" }
 The description for this value.
 
static const ID unknown
 unknown
 
static const ID msvc
 msvc
 
static const ID clang
 clang
 
static const ID gcc
 gcc
 
static const ID intel
 intel
 
static const ID mingwGcc
 mingwGcc
 
static const ID mingwClang
 mingwClang
 
static const ID mingwUnknown
 mingwUnknown
 

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

The name of the compiler.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value.

Enumerator
unknown 
msvc 
clang 
gcc 
intel 
mingwGcc 
mingwClang 
mingwUnknown 

Constructor & Destructor Documentation

◆ ID() [1/2]

Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::ID ( )
default

Default constructor.

◆ ID() [2/2]

Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::ID ( ValueType value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::operator!= ( const ID & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::operator== ( const ID & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::toString ( ) const

Get the value as string.

◆ validValues()

static std::set< ValueType > Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::validValues ( )
inlinestatic

All valid values of ID.

◆ value()

ValueType Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::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

◆ clang

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::clang
static

clang

◆ description

const char* Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::description { R"description(The name of the compiler)description" }
staticconstexpr

The description for this value.

◆ gcc

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::gcc
static

gcc

◆ intel

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::intel
static

intel

◆ mingwClang

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::mingwClang
static

mingwClang

◆ mingwGcc

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::mingwGcc
static

mingwGcc

◆ mingwUnknown

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::mingwUnknown
static

mingwUnknown

◆ msvc

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::msvc
static

msvc

◆ name

const char* Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::name { "ID" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::path { "UserToolchain/Compiler/ID" }
staticconstexpr

The full path for this value.

◆ unknown

const ID Zivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID::unknown
static

unknown


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