Zivid::FrameInfo::SoftwareVersion Class Reference

The version information for installed software at the time of image capture. More...

#include <Zivid/FrameInfo.h>

Classes
class	Core
	Core version. More...

Public Types
using	Descendants = std::tuple<FrameInfo::SoftwareVersion::Core>

Public Member Functions
	SoftwareVersion ()
	Default constructor.
template<typename... Args>
	SoftwareVersion (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
SoftwareVersion	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const Core &	core () const
	Get Core.
Core &	core ()
	Get Core.
SoftwareVersion &	set (const Core &value)
	Set Core.
template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SoftwareVersion::Core >::value, int >::type = 0>
const FrameInfo::SoftwareVersion::Core &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::SoftwareVersion::Core &	get () const
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.
template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const SoftwareVersion &other) const
	Equality operator.
bool	operator!= (const SoftwareVersion &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "SoftwareVersion" }
	The full path for this value.
static constexpr const char *	name { "SoftwareVersion" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< SoftwareVersion >
std::ostream &	operator<< (std::ostream &stream, const SoftwareVersion &value)
	Operator to send the value as string to a stream.

Detailed Description

The version information for installed software at the time of image capture.

Member Typedef Documentation

Descendants

using Zivid::FrameInfo::SoftwareVersion::Descendants = std::tuple<FrameInfo::SoftwareVersion::Core>

Constructor & Destructor Documentation

SoftwareVersion() [1/2]

Zivid::FrameInfo::SoftwareVersion::SoftwareVersion

(

)

Default constructor.

SoftwareVersion() [2/2]

template<typename... Args>

Zivid::FrameInfo::SoftwareVersion::SoftwareVersion ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing SoftwareVersion then invoking set(args).

The provided arguments must be descendants of SoftwareVersion. These types can be provided:

• FrameInfo::SoftwareVersion::Core

Member Function Documentation

copyWith()

template<typename... Args>

SoftwareVersion Zivid::FrameInfo::SoftwareVersion::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this SoftwareVersion object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of SoftwareVersion. These types can be provided:

• FrameInfo::SoftwareVersion::Core

core() [1/2]

Core & Zivid::FrameInfo::SoftwareVersion::core ( )

inline

Get Core.

core() [2/2]

const Core & Zivid::FrameInfo::SoftwareVersion::core ( ) const

inline

Get Core.

forEach() [1/2]

template<typename F >

void Zivid::FrameInfo::SoftwareVersion::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::forEach ( const F & f ) const

inline

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

get() [1/2]

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

const FrameInfo::SoftwareVersion::Core & Zivid::FrameInfo::SoftwareVersion::get ( ) const

inline

get() [2/2]

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

const FrameInfo::SoftwareVersion::Core & Zivid::FrameInfo::SoftwareVersion::get ( ) const

inline

operator!=()

bool Zivid::FrameInfo::SoftwareVersion::operator!=

(

const SoftwareVersion &

other

)

const

Inequality operator.

operator==()

bool Zivid::FrameInfo::SoftwareVersion::operator==

(

const SoftwareVersion &

other

)

const

Equality operator.

set() [1/2]

template<typename... Args>

void Zivid::FrameInfo::SoftwareVersion::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of SoftwareVersion. These types can be provided:

• FrameInfo::SoftwareVersion::Core

set() [2/2]

SoftwareVersion & Zivid::FrameInfo::SoftwareVersion::set ( const Core & value )

inline

Set Core.

toString()

std::string Zivid::FrameInfo::SoftwareVersion::toString

(

)

const

Get the value as string.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< SoftwareVersion >

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

friend

operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                R"description(The version information for installed software at the time of image capture)description"
            }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::FrameInfo::SoftwareVersion::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

path

const char* Zivid::FrameInfo::SoftwareVersion::path { "SoftwareVersion" }

staticconstexpr

The full path for this value.

---

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

• Zivid/FrameInfo.h