Zivid C++ API 2.14.0+e4a0c4a9-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraInfo::UserData Class Reference

Information about user data capabilities of the camera. More...

#include <Zivid/CameraInfo.h>

Classes

class  MaxSizeBytes
 The maximum number of bytes of user data that can be stored in the camera. More...
 

Public Types

using Descendants = std::tuple<CameraInfo::UserData::MaxSizeBytes>
 

Public Member Functions

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

Friends

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

Detailed Description

Information about user data capabilities of the camera.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraInfo::UserData::Descendants = std::tuple<CameraInfo::UserData::MaxSizeBytes>

Constructor & Destructor Documentation

◆ UserData() [1/2]

Zivid::CameraInfo::UserData::UserData ( )

Default constructor.

◆ UserData() [2/2]

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

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

Member Function Documentation

◆ copyWith()

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

◆ forEach() [1/2]

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

◆ get() [2/2]

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

◆ maxSizeBytes() [1/2]

MaxSizeBytes & Zivid::CameraInfo::UserData::maxSizeBytes ( )
inline

Get MaxSizeBytes.

◆ maxSizeBytes() [2/2]

const MaxSizeBytes & Zivid::CameraInfo::UserData::maxSizeBytes ( ) const
inline

Get MaxSizeBytes.

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ set() [1/2]

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

◆ set() [2/2]

UserData & Zivid::CameraInfo::UserData::set ( const MaxSizeBytes & value)
inline

Set MaxSizeBytes.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< UserData >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraInfo::UserData::description
staticconstexpr
Initial value:
{
R"description(Information about user data capabilities of the camera)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0