Zivid C++ API 2.6.1+6cec8609-3
Defining the Future of 3D Machine Vision
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraState Class Reference

Information about camera connection state, temperatures, etc. More...

#include <Zivid/CameraState.h>

Classes

class  Available
 Flag if camera is physically connected to the computer, but not connected in software. When the camera is in this state, you can call connect(). More...
 
class  Connected
 Flag if camera is connected in software More...
 
class  Temperature
 Current temperature(s) More...
 

Public Types

using Descendants = std::tuple< CameraState::Available, CameraState::Connected, CameraState::Temperature, CameraState::Temperature::DMD, CameraState::Temperature::General, CameraState::Temperature::LED, CameraState::Temperature::Lens, CameraState::Temperature::PCB >
 

Public Member Functions

 CameraState ()
 Default constructor More...
 
 CameraState (const std::string &fileName)
 Construct CameraState by loading from file More...
 
template<typename... Args>
 CameraState (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
template<typename... Args>
CameraState copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s) More...
 
const AvailableisAvailable () const
 Get Available More...
 
AvailableisAvailable ()
 Get Available More...
 
CameraStateset (const Available &value)
 Set Available More...
 
const ConnectedisConnected () const
 Get Connected More...
 
ConnectedisConnected ()
 Get Connected More...
 
CameraStateset (const Connected &value)
 Set Connected More...
 
const Temperaturetemperature () const
 Get Temperature More...
 
Temperaturetemperature ()
 Get Temperature More...
 
CameraStateset (const Temperature &value)
 Set Temperature More...
 
CameraStateset (const Temperature::DMD &value)
 Set Temperature::DMD More...
 
CameraStateset (const Temperature::General &value)
 Set Temperature::General More...
 
CameraStateset (const Temperature::LED &value)
 Set Temperature::LED More...
 
CameraStateset (const Temperature::Lens &value)
 Set Temperature::Lens More...
 
CameraStateset (const Temperature::PCB &value)
 Set Temperature::PCB More...
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Available >::value, int >::type = 0>
const CameraState::Availableget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Connected >::value, int >::type = 0>
const CameraState::Connectedget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature >::value, int >::type = 0>
const CameraState::Temperatureget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::DMD >::value, int >::type = 0>
const CameraState::Temperature::DMDget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::General >::value, int >::type = 0>
const CameraState::Temperature::Generalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::LED >::value, int >::type = 0>
const CameraState::Temperature::LEDget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::Lens >::value, int >::type = 0>
const CameraState::Temperature::Lensget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::PCB >::value, int >::type = 0>
const CameraState::Temperature::PCBget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraState::Availableget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraState::Connectedget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraState::Temperatureget () 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 More...
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter More...
 
bool operator== (const CameraState &other) const
 Equality operator More...
 
bool operator!= (const CameraState &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 
void save (const std::string &fileName) const
 Save to the given file More...
 
void load (const std::string &fileName)
 Load from the given file More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node More...
 
static constexpr const char * path { "" }
 The full path for this value More...
 
static constexpr const char * name { "CameraState" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 
static constexpr size_t version { 2 }
 

Friends

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

Detailed Description

Information about camera connection state, temperatures, etc.

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ CameraState() [1/3]

Zivid::CameraState::CameraState ( )

Default constructor

◆ CameraState() [2/3]

Zivid::CameraState::CameraState ( const std::string &  fileName)
explicit

Construct CameraState by loading from file

◆ CameraState() [3/3]

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

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

Member Function Documentation

◆ copyWith()

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

◆ forEach() [1/2]

template<typename F >
void Zivid::CameraState::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::CameraState::forEach ( const F &  f) const
inline

Run the given function on each direct member with the value of the member as parameter

◆ get() [1/11]

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

◆ get() [2/11]

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

◆ get() [3/11]

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

◆ get() [4/11]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::DMD >::value, int >::type = 0>
const CameraState::Temperature::DMD & Zivid::CameraState::get ( ) const
inline

◆ get() [5/11]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::General >::value, int >::type = 0>
const CameraState::Temperature::General & Zivid::CameraState::get ( ) const
inline

◆ get() [6/11]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::LED >::value, int >::type = 0>
const CameraState::Temperature::LED & Zivid::CameraState::get ( ) const
inline

◆ get() [7/11]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::Lens >::value, int >::type = 0>
const CameraState::Temperature::Lens & Zivid::CameraState::get ( ) const
inline

◆ get() [8/11]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::PCB >::value, int >::type = 0>
const CameraState::Temperature::PCB & Zivid::CameraState::get ( ) const
inline

◆ get() [9/11]

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

◆ get() [10/11]

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

◆ get() [11/11]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraState::Temperature & Zivid::CameraState::get ( ) const
inline

◆ isAvailable() [1/2]

Available & Zivid::CameraState::isAvailable ( )
inline

Get Available

◆ isAvailable() [2/2]

const Available & Zivid::CameraState::isAvailable ( ) const
inline

Get Available

◆ isConnected() [1/2]

Connected & Zivid::CameraState::isConnected ( )
inline

Get Connected

◆ isConnected() [2/2]

const Connected & Zivid::CameraState::isConnected ( ) const
inline

Get Connected

◆ load()

void Zivid::CameraState::load ( const std::string &  fileName)

Load from the given file

◆ operator!=()

bool Zivid::CameraState::operator!= ( const CameraState other) const

Inequality operator

◆ operator==()

bool Zivid::CameraState::operator== ( const CameraState other) const

Equality operator

◆ save()

void Zivid::CameraState::save ( const std::string &  fileName) const

Save to the given file

◆ set() [1/9]

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

◆ set() [2/9]

CameraState & Zivid::CameraState::set ( const Available value)
inline

Set Available

◆ set() [3/9]

CameraState & Zivid::CameraState::set ( const Connected value)
inline

Set Connected

◆ set() [4/9]

CameraState & Zivid::CameraState::set ( const Temperature value)
inline

◆ set() [5/9]

CameraState & Zivid::CameraState::set ( const Temperature::DMD value)
inline

◆ set() [6/9]

CameraState & Zivid::CameraState::set ( const Temperature::General value)
inline

◆ set() [7/9]

CameraState & Zivid::CameraState::set ( const Temperature::LED value)
inline

◆ set() [8/9]

CameraState & Zivid::CameraState::set ( const Temperature::Lens value)
inline

◆ set() [9/9]

CameraState & Zivid::CameraState::set ( const Temperature::PCB value)
inline

◆ temperature() [1/2]

Temperature & Zivid::CameraState::temperature ( )
inline

◆ temperature() [2/2]

const Temperature & Zivid::CameraState::temperature ( ) const
inline

◆ toString()

std::string Zivid::CameraState::toString ( ) const

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< CameraState >

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

◆ operator<<

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

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraState::description
staticconstexpr
Initial value:
{
R"description(Information about camera connection state, temperatures, etc.)description"
}

The description for this value

◆ name

constexpr const char* Zivid::CameraState::name { "CameraState" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraState::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::CameraState::path { "" }
staticconstexpr

The full path for this value

◆ version

constexpr size_t Zivid::CameraState::version { 2 }
staticconstexpr

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