Current Ethernet state. More...

#include <Zivid/CameraState.h>

Classes
class	LinkSpeed
	The link speed between the camera and the network device it is connected to, not the transfer speed between the camera and the host computer. Suppose the camera is connected to a 10Gbps network switch that is connected to a 1Gbps network card on the host computer. This value will indicate speed of 10Gbps even if the end-to-end link speed is limited to 1Gbps. The value will be unknown if the link is down or if the camera cannot determine the link speed. More...

Public Types
using	Descendants = std::tuple<CameraState::Network::Ethernet::LinkSpeed>

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

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

Detailed Description

Current Ethernet state.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraState::Network::Ethernet::Descendants = std::tuple<CameraState::Network::Ethernet::LinkSpeed>

Constructor & Destructor Documentation

◆ Ethernet() [1/2]

Zivid::CameraState::Network::Ethernet::Ethernet ( )

Default constructor.

◆ Ethernet() [2/2]

template<typename... Args>

Zivid::CameraState::Network::Ethernet::Ethernet ( 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 Ethernet then invoking set(args).

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

CameraState::Network::Ethernet::LinkSpeed

Member Function Documentation

◆ copyWith()

template<typename... Args>

Ethernet Zivid::CameraState::Network::Ethernet::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 Ethernet 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 Ethernet. These types can be provided:

CameraState::Network::Ethernet::LinkSpeed

◆ forEach() [1/2]

template<typename F>

void Zivid::CameraState::Network::Ethernet::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::Network::Ethernet::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, CameraState::Network::Ethernet::LinkSpeed >::value, int >::type = 0>

const CameraState::Network::Ethernet::LinkSpeed & Zivid::CameraState::Network::Ethernet::get ( ) const

inline

◆ get() [2/2]

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

const CameraState::Network::Ethernet::LinkSpeed & Zivid::CameraState::Network::Ethernet::get ( ) const

inline

◆ linkSpeed() [1/2]

LinkSpeed & Zivid::CameraState::Network::Ethernet::linkSpeed ( )

inline

Get LinkSpeed.

◆ linkSpeed() [2/2]

const LinkSpeed & Zivid::CameraState::Network::Ethernet::linkSpeed ( ) const

inline

Get LinkSpeed.

◆ operator!=()

bool Zivid::CameraState::Network::Ethernet::operator!= ( const Ethernet & other ) const

Inequality operator.

◆ operator==()

bool Zivid::CameraState::Network::Ethernet::operator== ( const Ethernet & other ) const

Equality operator.

◆ set() [1/2]

template<typename... Args>

void Zivid::CameraState::Network::Ethernet::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 Ethernet. These types can be provided:

CameraState::Network::Ethernet::LinkSpeed

◆ set() [2/2]

Ethernet & Zivid::CameraState::Network::Ethernet::set ( const LinkSpeed & value )

inline

Set LinkSpeed.

◆ toString()

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

Get the value as string.

◆ DataModel::Detail::Befriend< Ethernet >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraState::Network::Ethernet::description { R"description(Current Ethernet state)description" }

staticconstexpr

The description for this value.

◆ name

const char* Zivid::CameraState::Network::Ethernet::name { "Ethernet" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraState::Network::Ethernet::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraState::Network::Ethernet::path { "Network/Ethernet" }

staticconstexpr

The full path for this value.

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

Zivid/CameraState.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Ethernet() [1/2]

◆ Ethernet() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ linkSpeed() [1/2]

◆ linkSpeed() [2/2]

◆ operator!=()

◆ operator==()

◆ set() [1/2]

◆ set() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Ethernet >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path