Zivid C++ API 2.13.1+18e79e79-1
Zivid::FrameInfo::SystemInfo::ComputeDevice Class Reference

Compute device. More...

#include <Zivid/FrameInfo.h>

Classes

class  Model
 Compute device model. More...
 
class  Vendor
 Compute device vendor. More...
 

Public Types

using Descendants
 

Public Member Functions

 ComputeDevice ()
 Default constructor.
 
template<typename... Args>
 ComputeDevice (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
ComputeDevice 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.
 
ComputeDeviceset (const Model &value)
 Set Model.
 
const Vendorvendor () const
 Get Vendor.
 
Vendorvendor ()
 Get Vendor.
 
ComputeDeviceset (const Vendor &value)
 Set Vendor.
 
template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::ComputeDevice::Model >::value, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Modelget () const
 
template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::ComputeDevice::Vendor >::value, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Vendorget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Modelget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Vendorget () 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 ComputeDevice &other) const
 Equality operator.
 
bool operator!= (const ComputeDevice &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 { "SystemInfo/ComputeDevice" }
 The full path for this value.
 
static constexpr const char * name { "ComputeDevice" }
 The name of this value.
 
static constexpr const char * description { R"description(Compute device)description" }
 The description for this value.
 

Friends

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

Detailed Description

Compute device.

Member Typedef Documentation

◆ Descendants

Initial value:
std::
tuple<FrameInfo::SystemInfo::ComputeDevice::Model, FrameInfo::SystemInfo::ComputeDevice::Vendor>

Constructor & Destructor Documentation

◆ ComputeDevice() [1/2]

Zivid::FrameInfo::SystemInfo::ComputeDevice::ComputeDevice ( )

Default constructor.

◆ ComputeDevice() [2/2]

template<typename... Args>
Zivid::FrameInfo::SystemInfo::ComputeDevice::ComputeDevice ( 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 ComputeDevice then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>
ComputeDevice Zivid::FrameInfo::SystemInfo::ComputeDevice::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 ComputeDevice 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 ComputeDevice. These types can be provided:

◆ forEach() [1/2]

template<typename F >
void Zivid::FrameInfo::SystemInfo::ComputeDevice::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::ComputeDevice::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, FrameInfo::SystemInfo::ComputeDevice::Model >::value, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Model & Zivid::FrameInfo::SystemInfo::ComputeDevice::get ( ) const
inline

◆ get() [2/4]

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

◆ get() [3/4]

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

◆ get() [4/4]

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

◆ model() [1/2]

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

Get Model.

◆ model() [2/2]

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

Get Model.

◆ operator!=()

bool Zivid::FrameInfo::SystemInfo::ComputeDevice::operator!= ( const ComputeDevice & other) const

Inequality operator.

◆ operator==()

bool Zivid::FrameInfo::SystemInfo::ComputeDevice::operator== ( const ComputeDevice & other) const

Equality operator.

◆ set() [1/3]

template<typename... Args>
void Zivid::FrameInfo::SystemInfo::ComputeDevice::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 ComputeDevice. These types can be provided:

◆ set() [2/3]

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

Set Model.

◆ set() [3/3]

ComputeDevice & Zivid::FrameInfo::SystemInfo::ComputeDevice::set ( const Vendor & value)
inline

Set Vendor.

◆ toString()

std::string Zivid::FrameInfo::SystemInfo::ComputeDevice::toString ( ) const

Get the value as string.

◆ vendor() [1/2]

Vendor & Zivid::FrameInfo::SystemInfo::ComputeDevice::vendor ( )
inline

Get Vendor.

◆ vendor() [2/2]

const Vendor & Zivid::FrameInfo::SystemInfo::ComputeDevice::vendor ( ) const
inline

Get Vendor.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< ComputeDevice >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::FrameInfo::SystemInfo::ComputeDevice::description { R"description(Compute device)description" }
staticconstexpr

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::FrameInfo::SystemInfo::ComputeDevice::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

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

The full path for this value.


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