Zivid::Detail::EnvironmentInfo::Platform::CPU Class Reference

Information about the CPU. More...

#include <Zivid/Detail/EnvironmentInfo.h>

Classes
class	Architecture
	CPU architecture. More...
class	ModelName
	CPU model name. More...

Public Types
using	Descendants

Public Member Functions
	CPU ()
	Default constructor.
template<typename... Args>
	CPU (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
CPU	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const Architecture &	architecture () const
	Get Architecture.
Architecture &	architecture ()
	Get Architecture.
CPU &	set (const Architecture &value)
	Set Architecture.
const ModelName &	modelName () const
	Get ModelName.
ModelName &	modelName ()
	Get ModelName.
CPU &	set (const ModelName &value)
	Set ModelName.
template<typename T , typename std::enable_if< std::is_same< T, EnvironmentInfo::Platform::CPU::Architecture >::value, int >::type = 0>
const EnvironmentInfo::Platform::CPU::Architecture &	get () const
template<typename T , typename std::enable_if< std::is_same< T, EnvironmentInfo::Platform::CPU::ModelName >::value, int >::type = 0>
const EnvironmentInfo::Platform::CPU::ModelName &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const EnvironmentInfo::Platform::CPU::Architecture &	get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const EnvironmentInfo::Platform::CPU::ModelName &	get () const
template<typename F >
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter.
template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const CPU &other) const
	Equality operator.
bool	operator!= (const CPU &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "Platform/CPU" }
	The full path for this value.
static constexpr const char *	name { "CPU" }
	The name of this value.
static constexpr const char *	description { R"description(Information about the CPU)description" }
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< CPU >
std::ostream &	operator<< (std::ostream &stream, const CPU &value)
	Operator to send the value as string to a stream.

Detailed Description

Information about the CPU.

Member Typedef Documentation

Descendants

using Zivid::Detail::EnvironmentInfo::Platform::CPU::Descendants

Initial value:

 std::
                        tuple<EnvironmentInfo::Platform::CPU::Architecture, EnvironmentInfo::Platform::CPU::ModelName>

Constructor & Destructor Documentation

CPU() [1/2]

Zivid::Detail::EnvironmentInfo::Platform::CPU::CPU

(

)

Default constructor.

CPU() [2/2]

template<typename... Args>

Zivid::Detail::EnvironmentInfo::Platform::CPU::CPU ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing CPU then invoking set(args).

The provided arguments must be descendants of CPU. These types can be provided:

• EnvironmentInfo::Platform::CPU::Architecture
• EnvironmentInfo::Platform::CPU::ModelName

Member Function Documentation

architecture() [1/2]

Architecture & Zivid::Detail::EnvironmentInfo::Platform::CPU::architecture ( )

inline

Get Architecture.

architecture() [2/2]

const Architecture & Zivid::Detail::EnvironmentInfo::Platform::CPU::architecture ( ) const

inline

Get Architecture.

copyWith()

template<typename... Args>

CPU Zivid::Detail::EnvironmentInfo::Platform::CPU::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this CPU object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of CPU. These types can be provided:

• EnvironmentInfo::Platform::CPU::Architecture
• EnvironmentInfo::Platform::CPU::ModelName

forEach() [1/2]

template<typename F >

void Zivid::Detail::EnvironmentInfo::Platform::CPU::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter.

forEach() [2/2]

template<typename F >

void Zivid::Detail::EnvironmentInfo::Platform::CPU::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter.

get() [1/4]

template<typename T , typename std::enable_if< std::is_same< T, EnvironmentInfo::Platform::CPU::Architecture >::value, int >::type = 0>

const EnvironmentInfo::Platform::CPU::Architecture & Zivid::Detail::EnvironmentInfo::Platform::CPU::get ( ) const

inline

get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, EnvironmentInfo::Platform::CPU::ModelName >::value, int >::type = 0>

const EnvironmentInfo::Platform::CPU::ModelName & Zivid::Detail::EnvironmentInfo::Platform::CPU::get ( ) const

inline

get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const EnvironmentInfo::Platform::CPU::Architecture & Zivid::Detail::EnvironmentInfo::Platform::CPU::get ( ) const

inline

get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const EnvironmentInfo::Platform::CPU::ModelName & Zivid::Detail::EnvironmentInfo::Platform::CPU::get ( ) const

inline

modelName() [1/2]

ModelName & Zivid::Detail::EnvironmentInfo::Platform::CPU::modelName ( )

inline

Get ModelName.

modelName() [2/2]

const ModelName & Zivid::Detail::EnvironmentInfo::Platform::CPU::modelName ( ) const

inline

Get ModelName.

operator!=()

bool Zivid::Detail::EnvironmentInfo::Platform::CPU::operator!=

(

const CPU &

other

)

const

Inequality operator.

operator==()

bool Zivid::Detail::EnvironmentInfo::Platform::CPU::operator==

(

const CPU &

other

)

const

Equality operator.

set() [1/3]

template<typename... Args>

void Zivid::Detail::EnvironmentInfo::Platform::CPU::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of CPU. These types can be provided:

• EnvironmentInfo::Platform::CPU::Architecture
• EnvironmentInfo::Platform::CPU::ModelName

set() [2/3]

CPU & Zivid::Detail::EnvironmentInfo::Platform::CPU::set ( const Architecture & value )

inline

Set Architecture.

set() [3/3]

CPU & Zivid::Detail::EnvironmentInfo::Platform::CPU::set ( const ModelName & value )

inline

Set ModelName.

toString()

std::string Zivid::Detail::EnvironmentInfo::Platform::CPU::toString

(

)

const

Get the value as string.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< CPU >

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

friend

operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

description

const char* Zivid::Detail::EnvironmentInfo::Platform::CPU::description { R"description(Information about the CPU)description" }

staticconstexpr

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Detail::EnvironmentInfo::Platform::CPU::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/Detail/EnvironmentInfo.h