Zivid::CameraState::Network::LocalInterfaces Class Reference

List of the computer's local network interfaces that discovered the camera. In the most common scenario with the camera connected to the computer with an Ethernet cable, this list will contain only the network interface for that Ethernet port. In more complex network scenarios it can be the case that the camera is discovered by multiple interfaces, and in that case this list will contain multiple network interfaces. However, when CameraState::Status is connected, only the one network interface that has the active TCP/IP connection to the camera will be listed. More...

#include <Zivid/CameraState.h>

Public Types
using	ValueType = std::vector<CameraState::Network::LocalInterface>
	The type of the underlying value.
using	Iterator = std::vector<CameraState::Network::LocalInterface>::iterator
	Iterator type for LocalInterfaces.
using	ConstIterator = std::vector<CameraState::Network::LocalInterface>::const_iterator
	Constant iterator type for LocalInterfaces.

Public Member Functions
	LocalInterfaces ()=default
	Default constructor.
	LocalInterfaces (std::vector< CameraState::Network::LocalInterface > value)
	Constructor.
	LocalInterfaces (std::initializer_list< CameraState::Network::LocalInterface > value)
	Constructor.
const std::vector< CameraState::Network::LocalInterface > &	value () const
	Get the value.
std::string	toString () const
	Get the value as string.
std::size_t	size () const noexcept
	Get the size of the list.
bool	isEmpty () const noexcept
	Check if the list is empty.
template<typename... Args>
void	emplaceBack (Args &&...args)
	Appends a new element to the end of the list.
CameraState::Network::LocalInterface &	at (std::size_t pos)
	Returns a reference to the element at position pos in the list.
const CameraState::Network::LocalInterface &	at (std::size_t pos) const
	Returns a const reference to the element at position pos in the list.
CameraState::Network::LocalInterface &	operator[] (std::size_t pos)
	Returns a reference to the element at position pos in the list.
const CameraState::Network::LocalInterface &	operator[] (std::size_t pos) const
	Returns a const reference to the element at position pos in the list.
template<typename F >
void	forEach (const F &f)
	Run the given function on each element in the list.
template<typename F >
void	forEach (const F &f) const
	Run the given function on each element in the list.
Iterator	begin () noexcept
	Returns an iterator to the first element of the list.
Iterator	end () noexcept
	Returns an iterator to the element following the last element of the list.
ConstIterator	begin () const noexcept
	Returns a constant iterator to the first element of the list.
ConstIterator	end () const noexcept
	Returns a constant iterator to the element following the last element of the list.
ConstIterator	cbegin () const noexcept
	Returns a constant iterator to the first element of the list.
ConstIterator	cend () const noexcept
	Returns a constant iterator to the element following the last element of the list.
bool	operator== (const LocalInterfaces &other) const
	Comparison operator.
bool	operator!= (const LocalInterfaces &other) const
	Comparison operator.

Static Public Member Functions
static constexpr Range< ValueType::size_type >	validSize ()
	The valid sizes for LocalInterfaces.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafDataModelList
	The type of this node.
static constexpr const char *	path { "Network/LocalInterfaces" }
	The full path for this value.
static constexpr const char *	name { "LocalInterfaces" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< LocalInterfaces >
std::ostream &	operator<< (std::ostream &stream, const LocalInterfaces &value)
	Operator to serialize the value to a stream.

Detailed Description

List of the computer's local network interfaces that discovered the camera. In the most common scenario with the camera connected to the computer with an Ethernet cable, this list will contain only the network interface for that Ethernet port. In more complex network scenarios it can be the case that the camera is discovered by multiple interfaces, and in that case this list will contain multiple network interfaces. However, when CameraState::Status is connected, only the one network interface that has the active TCP/IP connection to the camera will be listed.

Member Typedef Documentation

ConstIterator

using Zivid::CameraState::Network::LocalInterfaces::ConstIterator = std::vector<CameraState::Network::LocalInterface>::const_iterator

Constant iterator type for LocalInterfaces.

Iterator

using Zivid::CameraState::Network::LocalInterfaces::Iterator = std::vector<CameraState::Network::LocalInterface>::iterator

Iterator type for LocalInterfaces.

ValueType

using Zivid::CameraState::Network::LocalInterfaces::ValueType = std::vector<CameraState::Network::LocalInterface>

The type of the underlying value.

Constructor & Destructor Documentation

LocalInterfaces() [1/3]

Zivid::CameraState::Network::LocalInterfaces::LocalInterfaces ( )

default

Default constructor.

LocalInterfaces() [2/3]

Zivid::CameraState::Network::LocalInterfaces::LocalInterfaces ( std::vector< CameraState::Network::LocalInterface > value )

inlineexplicit

Constructor.

LocalInterfaces() [3/3]

Zivid::CameraState::Network::LocalInterfaces::LocalInterfaces ( std::initializer_list< CameraState::Network::LocalInterface > value )

inlineexplicit

Constructor.

Member Function Documentation

at() [1/2]

CameraState::Network::LocalInterface & Zivid::CameraState::Network::LocalInterfaces::at

(

std::size_t

pos

)

Returns a reference to the element at position pos in the list.

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

at() [2/2]

const CameraState::Network::LocalInterface & Zivid::CameraState::Network::LocalInterfaces::at

(

std::size_t

pos

)

const

Returns a const reference to the element at position pos in the list.

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

begin() [1/2]

ConstIterator Zivid::CameraState::Network::LocalInterfaces::begin ( ) const

noexcept

Returns a constant iterator to the first element of the list.

begin() [2/2]

Iterator Zivid::CameraState::Network::LocalInterfaces::begin ( )

noexcept

Returns an iterator to the first element of the list.

cbegin()

ConstIterator Zivid::CameraState::Network::LocalInterfaces::cbegin ( ) const

noexcept

Returns a constant iterator to the first element of the list.

cend()

ConstIterator Zivid::CameraState::Network::LocalInterfaces::cend ( ) const

noexcept

Returns a constant iterator to the element following the last element of the list.

emplaceBack()

template<typename... Args>

void Zivid::CameraState::Network::LocalInterfaces::emplaceBack ( Args &&... args )

inline

Appends a new element to the end of the list.

The new element is constructed in-place. The provided arguments Args are forwarded to the constructor of CameraState::Network::LocalInterface. Invoking this method may invalidate all references to elements in the list.

end() [1/2]

ConstIterator Zivid::CameraState::Network::LocalInterfaces::end ( ) const

noexcept

Returns a constant iterator to the element following the last element of the list.

end() [2/2]

Iterator Zivid::CameraState::Network::LocalInterfaces::end ( )

noexcept

Returns an iterator to the element following the last element of the list.

forEach() [1/2]

template<typename F >

void Zivid::CameraState::Network::LocalInterfaces::forEach ( const F & f )

inline

Run the given function on each element in the list.

forEach() [2/2]

template<typename F >

void Zivid::CameraState::Network::LocalInterfaces::forEach ( const F & f ) const

inline

Run the given function on each element in the list.

isEmpty()

bool Zivid::CameraState::Network::LocalInterfaces::isEmpty ( ) const

noexcept

Check if the list is empty.

operator!=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator[]() [1/2]

CameraState::Network::LocalInterface & Zivid::CameraState::Network::LocalInterfaces::operator[]

(

std::size_t

pos

)

Returns a reference to the element at position pos in the list.

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) will check the bounds and throw an exception if pos it out of bounds.

operator[]() [2/2]

const CameraState::Network::LocalInterface & Zivid::CameraState::Network::LocalInterfaces::operator[]

(

std::size_t

pos

)

const

Returns a const reference to the element at position pos in the list.

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) const will check the bounds and throw an exception if pos it out of bounds.

size()

std::size_t Zivid::CameraState::Network::LocalInterfaces::size ( ) const

noexcept

Get the size of the list.

toString()

std::string Zivid::CameraState::Network::LocalInterfaces::toString

(

)

const

Get the value as string.

validSize()

static constexpr Range< ValueType::size_type > Zivid::CameraState::Network::LocalInterfaces::validSize ( )

inlinestaticconstexpr

The valid sizes for LocalInterfaces.

value()

const std::vector< CameraState::Network::LocalInterface > & Zivid::CameraState::Network::LocalInterfaces::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< LocalInterfaces >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                    R"description(List of the computer's local network interfaces that discovered the camera. In the most common scenario
with the camera connected to the computer with an Ethernet cable, this list will contain only the
network interface for that Ethernet port. In more complex network scenarios it can be the case that the
camera is discovered by multiple interfaces, and in that case this list will contain multiple network
interfaces. However, when `CameraState::Status` is `connected`, only the one network interface that has
the active TCP/IP connection to the camera will be listed.
)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::CameraState::Network::LocalInterfaces::nodeType = DataModel::NodeType::leafDataModelList

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/CameraState.h