Zivid C++ API 2.13.1+18e79e79-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraState::Network::IPV4 Class Reference

Current IPv4 protocol state. More...

#include <Zivid/CameraState.h>

Classes

class  Address
 Current IPv4 address. More...
 

Public Types

using Descendants = std::tuple<CameraState::Network::IPV4::Address>
 

Public Member Functions

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

Friends

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

Detailed Description

Current IPv4 protocol state.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraState::Network::IPV4::Descendants = std::tuple<CameraState::Network::IPV4::Address>

Constructor & Destructor Documentation

◆ IPV4() [1/2]

Zivid::CameraState::Network::IPV4::IPV4 ( )

Default constructor.

◆ IPV4() [2/2]

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

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

Member Function Documentation

◆ address() [1/2]

Address & Zivid::CameraState::Network::IPV4::address ( )
inline

Get Address.

◆ address() [2/2]

const Address & Zivid::CameraState::Network::IPV4::address ( ) const
inline

Get Address.

◆ copyWith()

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

◆ forEach() [1/2]

template<typename F >
void Zivid::CameraState::Network::IPV4::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::IPV4::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::IPV4::Address >::value, int >::type = 0>
const CameraState::Network::IPV4::Address & Zivid::CameraState::Network::IPV4::get ( ) const
inline

◆ get() [2/2]

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

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ set() [1/2]

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

◆ set() [2/2]

IPV4 & Zivid::CameraState::Network::IPV4::set ( const Address & value)
inline

Set Address.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< IPV4 >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraState::Network::IPV4::description { R"description(Current IPv4 protocol state)description" }
staticconstexpr

The description for this value.

◆ name

const char* Zivid::CameraState::Network::IPV4::name { "IPV4" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraState::Network::IPV4::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

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

The full path for this value.

The documentation for this class was generated from the following file:
Generated by doxygen 1.11.0