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

IPv4 address. Only used in manual mode. More...

#include <Zivid/NetworkConfiguration.h>

Public Types

using ValueType = std::string
 The type of the underlying value.
 

Public Member Functions

 Address ()=default
 Default constructor.
 
 Address (std::string value)
 Constructor.
 
const std::string & value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const Address &other) const
 Comparison operator.
 
bool operator!= (const Address &other) const
 Comparison operator.
 
bool operator< (const Address &other) const
 Comparison operator.
 
bool operator> (const Address &other) const
 Comparison operator.
 
bool operator<= (const Address &other) const
 Comparison operator.
 
bool operator>= (const Address &other) const
 Comparison operator.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "IPV4/Address" }
 The full path for this value.
 
static constexpr const char * name { "Address" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 

Friends

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

Detailed Description

IPv4 address. Only used in manual mode.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ Address() [1/2]

Zivid::NetworkConfiguration::IPV4::Address::Address ( )
default

Default constructor.

◆ Address() [2/2]

Zivid::NetworkConfiguration::IPV4::Address::Address ( std::string value)
inlineexplicit

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

bool Zivid::NetworkConfiguration::IPV4::Address::operator< ( const Address & other) const
inline

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

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

Comparison operator.

◆ operator>()

bool Zivid::NetworkConfiguration::IPV4::Address::operator> ( const Address & other) const
inline

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ toString()

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

Get the value as string.

◆ value()

const std::string & Zivid::NetworkConfiguration::IPV4::Address::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Address >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::NetworkConfiguration::IPV4::Address::description
staticconstexpr
Initial value:
{
R"description(IPv4 address. Only used in manual mode.)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.


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