Current state of the computer's local network interface. More...

#include <Zivid/CameraState.h>

Classes
class	InterfaceName
	Name of the computer's local network interface. More...

class	IPV4
	Current IPv4 protocol state of the computer's local network interface. More...

Public Types
using	Descendants

Public Member Functions
	LocalInterface ()
	Default constructor.

template<typename... Args>
	LocalInterface (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
LocalInterface	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const IPV4 &	ipv4 () const
	Get IPV4.

IPV4 &	ipv4 ()
	Get IPV4.

LocalInterface &	set (const IPV4 &value)
	Set IPV4.

LocalInterface &	set (const IPV4::Subnets &value)
	Set IPV4::Subnets.

const InterfaceName &	interfaceName () const
	Get InterfaceName.

InterfaceName &	interfaceName ()
	Get InterfaceName.

LocalInterface &	set (const InterfaceName &value)
	Set InterfaceName.

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Network::LocalInterface::IPV4 >::value, int >::type = 0>
const CameraState::Network::LocalInterface::IPV4 &	get () const

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Network::LocalInterface::IPV4::Subnets >::value, int >::type = 0>
const CameraState::Network::LocalInterface::IPV4::Subnets &	get () const

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Network::LocalInterface::InterfaceName >::value, int >::type = 0>
const CameraState::Network::LocalInterface::InterfaceName &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraState::Network::LocalInterface::IPV4 &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraState::Network::LocalInterface::InterfaceName &	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 LocalInterface &other) const
	Equality operator.

bool	operator!= (const LocalInterface &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/LocalInterface" }
	The full path for this value.

static constexpr const char *	name { "LocalInterface" }
	The name of this value.

static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< LocalInterface >

std::ostream &	operator<< (std::ostream &stream, const LocalInterface &value)
	Operator to send the value as string to a stream.

Detailed Description

Current state of the computer's local network interface.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraState::Network::LocalInterface::Descendants

Initial value:

 std::tuple<
                    CameraState::Network::LocalInterface::IPV4,
                    CameraState::Network::LocalInterface::IPV4::Subnets,
                    CameraState::Network::LocalInterface::InterfaceName>

Constructor & Destructor Documentation

◆ LocalInterface() [1/2]

Zivid::CameraState::Network::LocalInterface::LocalInterface ( )

Default constructor.

◆ LocalInterface() [2/2]

template<typename... Args>

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

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

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

◆ forEach() [1/2]

template<typename F >

void Zivid::CameraState::Network::LocalInterface::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::LocalInterface::forEach ( const F & f ) const

inline

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

◆ get() [1/5]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Network::LocalInterface::IPV4 >::value, int >::type = 0>

const CameraState::Network::LocalInterface::IPV4 & Zivid::CameraState::Network::LocalInterface::get ( ) const

inline

◆ get() [2/5]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Network::LocalInterface::IPV4::Subnets >::value, int >::type = 0>

const CameraState::Network::LocalInterface::IPV4::Subnets & Zivid::CameraState::Network::LocalInterface::get ( ) const

inline

◆ get() [3/5]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Network::LocalInterface::InterfaceName >::value, int >::type = 0>

const CameraState::Network::LocalInterface::InterfaceName & Zivid::CameraState::Network::LocalInterface::get ( ) const

inline

◆ get() [4/5]

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

const CameraState::Network::LocalInterface::IPV4 & Zivid::CameraState::Network::LocalInterface::get ( ) const

inline

◆ get() [5/5]

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

const CameraState::Network::LocalInterface::InterfaceName & Zivid::CameraState::Network::LocalInterface::get ( ) const

inline

◆ interfaceName() [1/2]

InterfaceName & Zivid::CameraState::Network::LocalInterface::interfaceName ( )

inline

Get InterfaceName.

◆ interfaceName() [2/2]

const InterfaceName & Zivid::CameraState::Network::LocalInterface::interfaceName ( ) const

inline

Get InterfaceName.

◆ ipv4() [1/2]

IPV4 & Zivid::CameraState::Network::LocalInterface::ipv4 ( )

inline

Get IPV4.

◆ ipv4() [2/2]

const IPV4 & Zivid::CameraState::Network::LocalInterface::ipv4 ( ) const

inline

Get IPV4.

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ set() [1/4]

template<typename... Args>

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

◆ set() [2/4]

LocalInterface & Zivid::CameraState::Network::LocalInterface::set ( const InterfaceName & value )

inline

Set InterfaceName.

◆ set() [3/4]

LocalInterface & Zivid::CameraState::Network::LocalInterface::set ( const IPV4 & value )

inline

Set IPV4.

◆ set() [4/4]

LocalInterface & Zivid::CameraState::Network::LocalInterface::set ( const IPV4::Subnets & value )

inline

Set IPV4::Subnets.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< LocalInterface >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraState::Network::LocalInterface::description

staticconstexpr

Initial value:

{
                    R"description(Current state of the computer's local network interface.
)description"
                }

The description for this value.

◆ name

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

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

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

◆ LocalInterface() [1/2]

◆ LocalInterface() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/5]

◆ get() [2/5]

◆ get() [3/5]

◆ get() [4/5]

◆ get() [5/5]

◆ interfaceName() [1/2]

◆ interfaceName() [2/2]

◆ ipv4() [1/2]

◆ ipv4() [2/2]

◆ operator!=()

◆ operator==()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< LocalInterface >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path