Zivid C++ API 2.14.0+e4a0c4a9-1
Zivid::NetworkConfiguration::IPV4::SubnetMask Class Reference

The camera's subnet mask (for example 255.255.255.0). 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

 SubnetMask ()=default
 Default constructor.
 
 SubnetMask (std::string value)
 Constructor.
 
const std::string & value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const SubnetMask &other) const
 Comparison operator.
 
bool operator!= (const SubnetMask &other) const
 Comparison operator.
 
bool operator< (const SubnetMask &other) const
 Comparison operator.
 
bool operator> (const SubnetMask &other) const
 Comparison operator.
 
bool operator<= (const SubnetMask &other) const
 Comparison operator.
 
bool operator>= (const SubnetMask &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/SubnetMask" }
 The full path for this value.
 
static constexpr const char * name { "SubnetMask" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 

Friends

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

Detailed Description

The camera's subnet mask (for example 255.255.255.0). Only used in manual mode.

To be able to connect to the camera, the camera's subnet mask must be the same as the subnet mask of the computer's local network interface.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ SubnetMask() [1/2]

Zivid::NetworkConfiguration::IPV4::SubnetMask::SubnetMask ( )
default

Default constructor.

◆ SubnetMask() [2/2]

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

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

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

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

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

Comparison operator.

◆ operator>()

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

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ toString()

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

Get the value as string.

◆ value()

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

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< SubnetMask >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::NetworkConfiguration::IPV4::SubnetMask::description
staticconstexpr
Initial value:
{
R"description(The camera's subnet mask (for example 255.255.255.0). Only used in manual mode.
To be able to connect to the camera, the camera's subnet mask must be the same as the subnet mask of the
computer's local network interface.
)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.


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