The end-to-end link speed between the camera and the host computer, defined as the minimum of the camera's link speed and the PC's link speed. More...

#include <Zivid/CameraHealth.h>

Classes
class	Status
	Severity of the max transfer speed check. More...
class	Value
	Max transfer speed in megabits per second (Mbps). More...

Public Types
using	Descendants

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

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

Detailed Description

The end-to-end link speed between the camera and the host computer, defined as the minimum of the camera's link speed and the PC's link speed.

OK: Max transfer speed > 1 Gbps
Suboptimal: Max transfer speed = 1 Gbps
Error: Max transfer speed < 1 Gbps
Unknown: Max transfer speed could not be determined

Member Typedef Documentation

◆ Descendants

using Zivid::CameraHealth::MaxTransferSpeed::Descendants

Initial value:

std::tuple<CameraHealth::MaxTransferSpeed::Status, CameraHealth::MaxTransferSpeed::Value>

Constructor & Destructor Documentation

◆ MaxTransferSpeed() [1/2]

Zivid::CameraHealth::MaxTransferSpeed::MaxTransferSpeed ( )

Default constructor.

◆ MaxTransferSpeed() [2/2]

template<typename... Args>

Zivid::CameraHealth::MaxTransferSpeed::MaxTransferSpeed ( 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 MaxTransferSpeed then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

MaxTransferSpeed Zivid::CameraHealth::MaxTransferSpeed::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 MaxTransferSpeed 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 MaxTransferSpeed. These types can be provided:

◆ forEach() [1/2]

template<typename F>

void Zivid::CameraHealth::MaxTransferSpeed::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::CameraHealth::MaxTransferSpeed::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, CameraHealth::MaxTransferSpeed::Status >::value, int >::type = 0>

const CameraHealth::MaxTransferSpeed::Status & Zivid::CameraHealth::MaxTransferSpeed::get ( ) const

inline

◆ get() [2/4]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::MaxTransferSpeed::Value >::value, int >::type = 0>

const CameraHealth::MaxTransferSpeed::Value & Zivid::CameraHealth::MaxTransferSpeed::get ( ) const

inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const CameraHealth::MaxTransferSpeed::Status & Zivid::CameraHealth::MaxTransferSpeed::get ( ) const

inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const CameraHealth::MaxTransferSpeed::Value & Zivid::CameraHealth::MaxTransferSpeed::get ( ) const

inline

◆ operator!=()

bool Zivid::CameraHealth::MaxTransferSpeed::operator!= ( const MaxTransferSpeed & other ) const

Inequality operator.

◆ operator==()

bool Zivid::CameraHealth::MaxTransferSpeed::operator== ( const MaxTransferSpeed & other ) const

Equality operator.

◆ set() [1/3]

template<typename... Args>

void Zivid::CameraHealth::MaxTransferSpeed::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 MaxTransferSpeed. These types can be provided:

◆ set() [2/3]

MaxTransferSpeed & Zivid::CameraHealth::MaxTransferSpeed::set ( const Status & value )

inline

Set Status.

◆ set() [3/3]

MaxTransferSpeed & Zivid::CameraHealth::MaxTransferSpeed::set ( const Value & value )

inline

Set Value.

◆ status() [1/2]

Status & Zivid::CameraHealth::MaxTransferSpeed::status ( )

inline

Get Status.

◆ status() [2/2]

const Status & Zivid::CameraHealth::MaxTransferSpeed::status ( ) const

inline

Get Status.

◆ toString()

std::string Zivid::CameraHealth::MaxTransferSpeed::toString ( ) const

Get the value as string.

◆ value() [1/2]

Value & Zivid::CameraHealth::MaxTransferSpeed::value ( )

inline

Get Value.

◆ value() [2/2]

const Value & Zivid::CameraHealth::MaxTransferSpeed::value ( ) const

inline

Get Value.

◆ DataModel::Detail::Befriend< MaxTransferSpeed >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraHealth::MaxTransferSpeed::description

staticconstexpr

Initial value:

{
                R"description(The end-to-end link speed between the camera and the host
computer, defined as the minimum of the camera's link speed
and the PC's link speed.
 
  - OK: Max transfer speed > 1 Gbps
  - Suboptimal: Max transfer speed = 1 Gbps
  - Error: Max transfer speed < 1 Gbps
  - Unknown: Max transfer speed could not be determined
)description"
            }

The description for this value.

◆ name

const char* Zivid::CameraHealth::MaxTransferSpeed::name { "MaxTransferSpeed" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraHealth::MaxTransferSpeed::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraHealth::MaxTransferSpeed::path { "MaxTransferSpeed" }

staticconstexpr

The full path for this value.

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

Zivid/CameraHealth.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ MaxTransferSpeed() [1/2]

◆ MaxTransferSpeed() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ operator!=()

◆ operator==()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ status() [1/2]

◆ status() [2/2]

◆ toString()

◆ value() [1/2]

◆ value() [2/2]

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< MaxTransferSpeed >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path