Zivid::Detail::EnvironmentInfo::Wrapper Class Reference

The wrapper being used, if any. More...

#include <Zivid/Detail/EnvironmentInfo.h>

Public Types
enum class	ValueType {   none , python , dotnet , genicam ,   ros1 , ros2 , studio }
	The type of the underlying value. More...

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

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

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Wrapper" }
	The full path for this value.
static constexpr const char *	name { "Wrapper" }
	The name of this value.
static constexpr const char *	description { R"description(The wrapper being used, if any)description" }
	The description for this value.
static const Wrapper	none
	none
static const Wrapper	python
	python
static const Wrapper	dotnet
	dotnet
static const Wrapper	genicam
	genicam
static const Wrapper	ros1
	ros1
static const Wrapper	ros2
	ros2
static const Wrapper	studio
	studio

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

Detailed Description

The wrapper being used, if any.

Member Enumeration Documentation

ValueType

enum class Zivid::Detail::EnvironmentInfo::Wrapper::ValueType

strong

The type of the underlying value.

Enumerator
none
python
dotnet
genicam
ros1
ros2
studio

Constructor & Destructor Documentation

Wrapper() [1/2]

Zivid::Detail::EnvironmentInfo::Wrapper::Wrapper ( )

default

Default constructor.

Wrapper() [2/2]

Zivid::Detail::EnvironmentInfo::Wrapper::Wrapper ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::Detail::EnvironmentInfo::Wrapper::operator!= ( const Wrapper & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Detail::EnvironmentInfo::Wrapper::operator== ( const Wrapper & other ) const

inline

Comparison operator.

toString()

std::string Zivid::Detail::EnvironmentInfo::Wrapper::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::Detail::EnvironmentInfo::Wrapper::validValues ( )

inlinestatic

All valid values of Wrapper.

value()

ValueType Zivid::Detail::EnvironmentInfo::Wrapper::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Wrapper >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

description

const char* Zivid::Detail::EnvironmentInfo::Wrapper::description { R"description(The wrapper being used, if any)description" }

staticconstexpr

The description for this value.

dotnet

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::dotnet

static

dotnet

genicam

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::genicam

static

genicam

name

const char* Zivid::Detail::EnvironmentInfo::Wrapper::name { "Wrapper" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Detail::EnvironmentInfo::Wrapper::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

none

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::none

static

none

path

const char* Zivid::Detail::EnvironmentInfo::Wrapper::path { "Wrapper" }

staticconstexpr

The full path for this value.

python

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::python

static

python

ros1

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::ros1

static

ros1

ros2

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::ros2

static

ros2

studio

const Wrapper Zivid::Detail::EnvironmentInfo::Wrapper::studio

static

studio

---

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

• Zivid/Detail/EnvironmentInfo.h