Version information for the Zivid API library More...

#include <Zivid/FrameInfo.h>

Classes
class	Comments
	Comments More...

class	FileDescription
	File description More...

class	FileVersion
	File version More...

class	ProductVersion
	Product version More...

Public Member Functions
	ZividAPI ()=default
	Default constructor More...

void	set (const std::string &fullPath, const std::string &value)
	Set a value from string by specifying the path More...

std::string	getString (const std::string &fullPath) const
	Get a value as string by specifying the path More...

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::Comments >::value, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::Comments &	get () const

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::FileDescription >::value, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::FileDescription &	get () const

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::FileVersion >::value, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::FileVersion &	get () const

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::ProductVersion >::value, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::ProductVersion &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::Comments &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::FileDescription &	get () const

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::FileVersion &	get () const

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const FrameInfo::SoftwareVersion::ZividAPI::ProductVersion &	get () const

	ZividAPI (const Comments &comments, const FileDescription &fileDescription, const FileVersion &fileVersion, const ProductVersion &productVersion)
	Constructor More...

ZividAPI &	set (const Comments &value)
	Set Comments More...

const Comments &	comments () const
	Get Comments More...

ZividAPI &	set (const FileDescription &value)
	Set FileDescription More...

const FileDescription &	fileDescription () const
	Get FileDescription More...

ZividAPI &	set (const FileVersion &value)
	Set FileVersion More...

const FileVersion &	fileVersion () const
	Get FileVersion More...

ZividAPI &	set (const ProductVersion &value)
	Set ProductVersion More...

const ProductVersion &	productVersion () const
	Get ProductVersion More...

template<typename F >
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter More...

template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter More...

template<typename F >
void	traverseValues (const F &f) const
	Traverse the entire tree using the given function with the value of the member as parameter More...

template<typename F >
void	traverseValues (const F &f)
	Traverse all members using the given function with the value of the member as parameter More...

std::string	toString () const
	Get the value as string More...

void	setFromString (const std::string &value)
	Set from the given string More...

bool	operator== (const ZividAPI &other) const
	Equality operator More...

bool	operator!= (const ZividAPI &other) const
	Inequality operator More...

Static Public Attributes
static constexpr bool	isContainer { true }
	Whether this node contains child values More...

static constexpr const char *	path { "SoftwareVersion/ZividAPI" }
	The full path for this value More...

static constexpr const char *	name { "ZividAPI" }
	The name of this value More...

static constexpr const char *	description
	The description for this value More...

Friends
std::ostream &	operator<< (std::ostream &stream, const ZividAPI &value)
	Operator to send the value as string to a stream More...

std::istream &	operator>> (std::istream &stream, ZividAPI &value)
	Operator to set the value from a stream More...

Detailed Description

Version information for the Zivid API library

Constructor & Destructor Documentation

◆ ZividAPI() [1/2]

Zivid::FrameInfo::SoftwareVersion::ZividAPI::ZividAPI ( )

default

Default constructor

◆ ZividAPI() [2/2]

Zivid::FrameInfo::SoftwareVersion::ZividAPI::ZividAPI	(	const Comments &	comments,
		const FileDescription &	fileDescription,
		const FileVersion &	fileVersion,
		const ProductVersion &	productVersion
	)

explicit

Constructor

Member Function Documentation

◆ comments()

const Comments& Zivid::FrameInfo::SoftwareVersion::ZividAPI::comments ( ) const

inline

Get Comments

◆ fileDescription()

const FileDescription& Zivid::FrameInfo::SoftwareVersion::ZividAPI::fileDescription ( ) const

inline

Get FileDescription

◆ fileVersion()

const FileVersion& Zivid::FrameInfo::SoftwareVersion::ZividAPI::fileVersion ( ) const

inline

Get FileVersion

◆ forEach() [1/2]

template<typename F >

void Zivid::FrameInfo::SoftwareVersion::ZividAPI::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter

◆ forEach() [2/2]

template<typename F >

void Zivid::FrameInfo::SoftwareVersion::ZividAPI::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter

◆ get() [1/8]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::Comments >::value, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::Comments& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [2/8]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::FileDescription >::value, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::FileDescription& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [3/8]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::FileVersion >::value, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::FileVersion& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [4/8]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::ZividAPI::ProductVersion >::value, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::ProductVersion& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [5/8]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::Comments& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [6/8]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::FileDescription& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [7/8]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::FileVersion& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ get() [8/8]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>

const FrameInfo::SoftwareVersion::ZividAPI::ProductVersion& Zivid::FrameInfo::SoftwareVersion::ZividAPI::get ( ) const

inline

◆ getString()

std::string Zivid::FrameInfo::SoftwareVersion::ZividAPI::getString ( const std::string & fullPath ) const

Get a value as string by specifying the path

◆ operator!=()

bool Zivid::FrameInfo::SoftwareVersion::ZividAPI::operator!= ( const ZividAPI & other ) const

Inequality operator

◆ operator==()

bool Zivid::FrameInfo::SoftwareVersion::ZividAPI::operator== ( const ZividAPI & other ) const

Equality operator

◆ productVersion()

const ProductVersion& Zivid::FrameInfo::SoftwareVersion::ZividAPI::productVersion ( ) const

inline

Get ProductVersion

◆ set() [1/5]

ZividAPI& Zivid::FrameInfo::SoftwareVersion::ZividAPI::set ( const Comments & value )

inline

Set Comments

◆ set() [2/5]

ZividAPI& Zivid::FrameInfo::SoftwareVersion::ZividAPI::set ( const FileDescription & value )

inline

Set FileDescription

◆ set() [3/5]

ZividAPI& Zivid::FrameInfo::SoftwareVersion::ZividAPI::set ( const FileVersion & value )

inline

Set FileVersion

◆ set() [4/5]

ZividAPI& Zivid::FrameInfo::SoftwareVersion::ZividAPI::set ( const ProductVersion & value )

inline

Set ProductVersion

◆ set() [5/5]

void Zivid::FrameInfo::SoftwareVersion::ZividAPI::set	(	const std::string &	fullPath,
		const std::string &	value
	)

Set a value from string by specifying the path

◆ setFromString()

void Zivid::FrameInfo::SoftwareVersion::ZividAPI::setFromString ( const std::string & value )

Set from the given string

◆ toString()

std::string Zivid::FrameInfo::SoftwareVersion::ZividAPI::toString ( ) const

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

void Zivid::FrameInfo::SoftwareVersion::ZividAPI::traverseValues ( const F & f )

inline

Traverse all members using the given function with the value of the member as parameter

◆ traverseValues() [2/2]

template<typename F >

void Zivid::FrameInfo::SoftwareVersion::ZividAPI::traverseValues ( const F & f ) const

inline

Traverse the entire tree using the given function with the value of the member as parameter

Friends And Related Function Documentation

◆ operator<<

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

friend

Operator to send the value as string to a stream

◆ operator>>

std::istream& operator>>	(	std::istream &	stream,
		ZividAPI &	value
	)

friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividAPI::description

staticconstexpr

Initial value:

{
                    R"description(Version information for the Zivid API library)description"
                }

The description for this value

◆ isContainer

constexpr bool Zivid::FrameInfo::SoftwareVersion::ZividAPI::isContainer { true }

staticconstexpr

Whether this node contains child values

◆ name

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividAPI::name { "ZividAPI" }

staticconstexpr

The name of this value

◆ path

constexpr const char* Zivid::FrameInfo::SoftwareVersion::ZividAPI::path { "SoftwareVersion/ZividAPI" }

staticconstexpr

The full path for this value

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

Zivid/FrameInfo.h

Classes

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ZividAPI() [1/2]

◆ ZividAPI() [2/2]

Member Function Documentation

◆ comments()

◆ fileDescription()

◆ fileVersion()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/8]

◆ get() [2/8]

◆ get() [3/8]

◆ get() [4/8]

◆ get() [5/8]

◆ get() [6/8]

◆ get() [7/8]

◆ get() [8/8]

◆ getString()

◆ operator!=()

◆ operator==()

◆ productVersion()

◆ set() [1/5]

◆ set() [2/5]

◆ set() [3/5]

◆ set() [4/5]

◆ set() [5/5]

◆ setFromString()

◆ toString()

◆ traverseValues() [1/2]

◆ traverseValues() [2/2]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ description

◆ isContainer

◆ name

◆ path