Zivid::CameraState::InaccessibleReason Class Reference

If the camera status is inaccessible, then this enum value will give you the reason. More...

#include <Zivid/CameraState.h>

Public Types
enum class	ValueType { ipConflictWithAnotherCamera , ipConflictWithLocalNetworkAdapter , ipNotInLocalSubnet , ipInMultipleLocalSubnets }
	The type of the underlying value. More...

Public Member Functions
	InaccessibleReason ()=default
	Default constructor.
constexpr	InaccessibleReason (ValueType value)
	Constructor.
ValueType	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const InaccessibleReason &other) const
	Comparison operator.
bool	operator!= (const InaccessibleReason &other) const
	Comparison operator.

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of InaccessibleReason.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "InaccessibleReason" }
	The full path for this value.
static constexpr const char *	name { "InaccessibleReason" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static const InaccessibleReason	ipConflictWithAnotherCamera
	ipConflictWithAnotherCamera
static const InaccessibleReason	ipConflictWithLocalNetworkAdapter
	ipConflictWithLocalNetworkAdapter
static const InaccessibleReason	ipNotInLocalSubnet
	ipNotInLocalSubnet
static const InaccessibleReason	ipInMultipleLocalSubnets
	ipInMultipleLocalSubnets

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

Detailed Description

If the camera status is inaccessible, then this enum value will give you the reason.

Member Enumeration Documentation

ValueType

enum class Zivid::CameraState::InaccessibleReason::ValueType

strong

The type of the underlying value.

Enumerator
ipConflictWithAnotherCamera
ipConflictWithLocalNetworkAdapter
ipNotInLocalSubnet
ipInMultipleLocalSubnets

Constructor & Destructor Documentation

InaccessibleReason() [1/2]

Zivid::CameraState::InaccessibleReason::InaccessibleReason ( )

default

Default constructor.

InaccessibleReason() [2/2]

Zivid::CameraState::InaccessibleReason::InaccessibleReason ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::CameraState::InaccessibleReason::hasValue

(

)

const

Check if the value is set.

operator!=()

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

inline

Comparison operator.

operator==()

bool Zivid::CameraState::InaccessibleReason::operator== ( const InaccessibleReason & other ) const

inline

Comparison operator.

reset()

void Zivid::CameraState::InaccessibleReason::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::CameraState::InaccessibleReason::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::CameraState::InaccessibleReason::validValues ( )

inlinestatic

All valid values of InaccessibleReason.

value()

ValueType Zivid::CameraState::InaccessibleReason::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< InaccessibleReason >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

description

const char* Zivid::CameraState::InaccessibleReason::description

staticconstexpr

Initial value:

{
                R"description(If the camera status is `inaccessible`, then this enum value will give you the reason.)description"
            }

The description for this value.

ipConflictWithAnotherCamera

const InaccessibleReason Zivid::CameraState::InaccessibleReason::ipConflictWithAnotherCamera

static

ipConflictWithAnotherCamera

ipConflictWithLocalNetworkAdapter

const InaccessibleReason Zivid::CameraState::InaccessibleReason::ipConflictWithLocalNetworkAdapter

static

ipConflictWithLocalNetworkAdapter

ipInMultipleLocalSubnets

const InaccessibleReason Zivid::CameraState::InaccessibleReason::ipInMultipleLocalSubnets

static

ipInMultipleLocalSubnets

ipNotInLocalSubnet

const InaccessibleReason Zivid::CameraState::InaccessibleReason::ipNotInLocalSubnet

static

ipNotInLocalSubnet

name

const char* Zivid::CameraState::InaccessibleReason::name { "InaccessibleReason" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::CameraState::InaccessibleReason::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::CameraState::InaccessibleReason::path { "InaccessibleReason" }

staticconstexpr

The full path for this value.

---

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

• Zivid/CameraState.h