Zivid C++ API 2.13.1+18e79e79-1
Zivid::NetworkConfiguration::IPV4::Mode Class Reference

DHCP or manual configuration. More...

#include <Zivid/NetworkConfiguration.h>

Public Types

enum class  ValueType { dhcp , manual }
 The type of the underlying value. More...
 

Public Member Functions

 Mode ()=default
 Default constructor.
 
constexpr Mode (ValueType value)
 Constructor.
 
ValueType value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const Mode &other) const
 Comparison operator.
 
bool operator!= (const Mode &other) const
 Comparison operator.
 

Static Public Member Functions

static std::set< ValueTypevalidValues ()
 All valid values of Mode.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "IPV4/Mode" }
 The full path for this value.
 
static constexpr const char * name { "Mode" }
 The name of this value.
 
static constexpr const char * description { R"description(DHCP or manual configuration)description" }
 The description for this value.
 
static const Mode dhcp
 dhcp
 
static const Mode manual
 manual
 

Friends

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

Detailed Description

DHCP or manual configuration.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value.

Enumerator
dhcp 
manual 

Constructor & Destructor Documentation

◆ Mode() [1/2]

Zivid::NetworkConfiguration::IPV4::Mode::Mode ( )
default

Default constructor.

◆ Mode() [2/2]

Zivid::NetworkConfiguration::IPV4::Mode::Mode ( ValueType value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::NetworkConfiguration::IPV4::Mode::operator!= ( const Mode & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::NetworkConfiguration::IPV4::Mode::operator== ( const Mode & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::NetworkConfiguration::IPV4::Mode::toString ( ) const

Get the value as string.

◆ validValues()

static std::set< ValueType > Zivid::NetworkConfiguration::IPV4::Mode::validValues ( )
inlinestatic

All valid values of Mode.

◆ value()

ValueType Zivid::NetworkConfiguration::IPV4::Mode::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Mode >

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

◆ operator<< [1/2]

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

Operator to serialize the value to a stream.

◆ operator<< [2/2]

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

Operator to serialize ValueType to a stream.

Member Data Documentation

◆ description

const char* Zivid::NetworkConfiguration::IPV4::Mode::description { R"description(DHCP or manual configuration)description" }
staticconstexpr

The description for this value.

◆ dhcp

const Mode Zivid::NetworkConfiguration::IPV4::Mode::dhcp
static

dhcp

◆ manual

const Mode Zivid::NetworkConfiguration::IPV4::Mode::manual
static

manual

◆ name

const char* Zivid::NetworkConfiguration::IPV4::Mode::name { "Mode" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::NetworkConfiguration::IPV4::Mode::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::NetworkConfiguration::IPV4::Mode::path { "IPV4/Mode" }
staticconstexpr

The full path for this value.


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