Zivid C++ API 2.13.1+18e79e79-1
Zivid::CameraInfo::Revision Class Reference

Major/Minor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead. More...

#include <Zivid/CameraInfo.h>

Classes

class  Major
 Major hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead. More...
 
class  Minor
 Minor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead. More...
 

Public Types

using Descendants = std::tuple<CameraInfo::Revision::Major, CameraInfo::Revision::Minor>
 

Public Member Functions

 Revision ()
 Default constructor.
 
template<typename... Args>
 Revision (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Revision copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const Majormajor () const
 Get Major.
 
Majormajor ()
 Get Major.
 
Revisionset (const Major &value)
 Set Major.
 
const Minorminor () const
 Get Minor.
 
Minorminor ()
 Get Minor.
 
Revisionset (const Minor &value)
 Set Minor.
 
template<typename T , typename std::enable_if< std::is_same< T, CameraInfo::Revision::Major >::value, int >::type = 0>
const CameraInfo::Revision::Majorget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraInfo::Revision::Minor >::value, int >::type = 0>
const CameraInfo::Revision::Minorget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraInfo::Revision::Majorget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraInfo::Revision::Minorget () 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 Revision &other) const
 Equality operator.
 
bool operator!= (const Revision &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 { "Revision" }
 The full path for this value.
 
static constexpr const char * name { "Revision" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 

Friends

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

Detailed Description

Major/Minor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead.

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Revision() [1/2]

Zivid::CameraInfo::Revision::Revision ( )

Default constructor.

◆ Revision() [2/2]

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

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

Member Function Documentation

◆ copyWith()

template<typename... Args>
Revision Zivid::CameraInfo::Revision::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 Revision 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 Revision. These types can be provided:

◆ forEach() [1/2]

template<typename F >
void Zivid::CameraInfo::Revision::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::CameraInfo::Revision::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, CameraInfo::Revision::Major >::value, int >::type = 0>
const CameraInfo::Revision::Major & Zivid::CameraInfo::Revision::get ( ) const
inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, CameraInfo::Revision::Minor >::value, int >::type = 0>
const CameraInfo::Revision::Minor & Zivid::CameraInfo::Revision::get ( ) const
inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraInfo::Revision::Major & Zivid::CameraInfo::Revision::get ( ) const
inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraInfo::Revision::Minor & Zivid::CameraInfo::Revision::get ( ) const
inline

◆ major() [1/2]

Major & Zivid::CameraInfo::Revision::major ( )
inline

Get Major.

◆ major() [2/2]

const Major & Zivid::CameraInfo::Revision::major ( ) const
inline

Get Major.

◆ minor() [1/2]

Minor & Zivid::CameraInfo::Revision::minor ( )
inline

Get Minor.

◆ minor() [2/2]

const Minor & Zivid::CameraInfo::Revision::minor ( ) const
inline

Get Minor.

◆ operator!=()

bool Zivid::CameraInfo::Revision::operator!= ( const Revision & other) const

Inequality operator.

◆ operator==()

bool Zivid::CameraInfo::Revision::operator== ( const Revision & other) const

Equality operator.

◆ set() [1/3]

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

◆ set() [2/3]

Revision & Zivid::CameraInfo::Revision::set ( const Major & value)
inline

Set Major.

◆ set() [3/3]

Revision & Zivid::CameraInfo::Revision::set ( const Minor & value)
inline

Set Minor.

◆ toString()

std::string Zivid::CameraInfo::Revision::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Revision >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraInfo::Revision::description
staticconstexpr
Initial value:
{
R"description(Major/Minor hardware revision number. This field is deprecated and may be removed in a future version
of the SDK. Please use HardwareRevision instead.
)description"
}

The description for this value.

◆ name

const char* Zivid::CameraInfo::Revision::name { "Revision" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraInfo::Revision::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraInfo::Revision::path { "Revision" }
staticconstexpr

The full path for this value.


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