The hardware revision of the camera. More...

#include <Zivid/CameraInfo.h>

Classes
class	Major
	Major hardware revision number. More...

class	Minor
	Minor hardware revision number. 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 Major &	major () const
	Get Major.

Major &	major ()
	Get Major.

Revision &	set (const Major &value)
	Set Major.

const Minor &	minor () const
	Get Minor.

Minor &	minor ()
	Get Minor.

Revision &	set (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::Major &	get () const

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

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

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraInfo::Revision::Minor &	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 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 { R"description(The hardware revision of the camera)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

The hardware revision of the camera.

Member Typedef Documentation

◆ Descendants

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

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

constexpr const char* Zivid::CameraInfo::Revision::description { R"description(The hardware revision of the camera)description" }

staticconstexpr

The description for this value.

◆ name

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

constexpr 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:

Zivid/CameraInfo.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Revision() [1/2]

◆ Revision() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ major() [1/2]

◆ major() [2/2]

◆ minor() [1/2]

◆ minor() [2/2]

◆ operator!=()

◆ operator==()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Revision >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path