Zivid C++ API 2.11.1+de9b5dae-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::FrameInfo::SystemInfo::CPU Class Reference

CPU. More...

#include <Zivid/FrameInfo.h>

Classes

class  Model
 CPU model. More...
 

Public Types

using Descendants = std::tuple< FrameInfo::SystemInfo::CPU::Model >
 

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 Modelmodel () const
 Get Model.
 
Modelmodel ()
 Get Model.
 
CPUset (const Model &value)
 Set Model.
 
template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::CPU::Model >::value, int >::type = 0>
const FrameInfo::SystemInfo::CPU::Modelget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::SystemInfo::CPU::Modelget () 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 charpath { "SystemInfo/CPU" }
 The full path for this value.
 
static constexpr const charname { "CPU" }
 The name of this value.
 
static constexpr const chardescription { R"description(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

CPU.

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ CPU() [1/2]

Zivid::FrameInfo::SystemInfo::CPU::CPU ( )

Default constructor.

◆ CPU() [2/2]

template<typename... Args>
Zivid::FrameInfo::SystemInfo::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:

Member Function Documentation

◆ copyWith()

template<typename... Args>
CPU Zivid::FrameInfo::SystemInfo::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:

◆ forEach() [1/2]

template<typename F >
void Zivid::FrameInfo::SystemInfo::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::FrameInfo::SystemInfo::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/2]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::CPU::Model >::value, int >::type = 0>
const FrameInfo::SystemInfo::CPU::Model & Zivid::FrameInfo::SystemInfo::CPU::get ( ) const
inline

◆ get() [2/2]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::SystemInfo::CPU::Model & Zivid::FrameInfo::SystemInfo::CPU::get ( ) const
inline

◆ model() [1/2]

Model & Zivid::FrameInfo::SystemInfo::CPU::model ( )
inline

Get Model.

◆ model() [2/2]

const Model & Zivid::FrameInfo::SystemInfo::CPU::model ( ) const
inline

Get Model.

◆ operator!=()

Inequality operator.

◆ operator==()

Equality operator.

◆ set() [1/2]

template<typename... Args>
void Zivid::FrameInfo::SystemInfo::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:

◆ set() [2/2]

CPU & Zivid::FrameInfo::SystemInfo::CPU::set ( const Model value)
inline

Set Model.

◆ toString()

std::string Zivid::FrameInfo::SystemInfo::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

constexpr const char* Zivid::FrameInfo::SystemInfo::CPU::description { R"description(CPU)description" }
staticconstexpr

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::FrameInfo::SystemInfo::CPU::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

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

The full path for this value.


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