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

#include <FrameInfo.h>

Classes
class	ZividAPI
	Version information for the Zivid API library More...

class	ZividCameraFile
	Version information for the ZividCameraFile driver More...

class	ZividCameraToshibaTeli
	Version information for the ZividCameraToshibaTeli driver More...

class	ZividStudio
	Version information for the ZividStudio applicaton More...

Public Member Functions
	SoftwareVersion (const std::string &fileName)
	Construct object by loading from file 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...

SoftwareVersion &	set (const ZividStudio &value)
	Set ZividStudio More...

const ZividStudio &	zividStudio () const
	Get ZividStudio More...

SoftwareVersion &	set (const ZividStudio::FileDescription &value)
	Set ZividStudio::FileDescription More...

SoftwareVersion &	set (const ZividStudio::FileVersion &value)
	Set ZividStudio::FileVersion More...

SoftwareVersion &	set (const ZividStudio::ProductVersion &value)
	Set ZividStudio::ProductVersion More...

SoftwareVersion &	set (const ZividStudio::Comments &value)
	Set ZividStudio::Comments More...

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

const ZividAPI &	zividAPI () const
	Get ZividAPI More...

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

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

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

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

SoftwareVersion &	set (const ZividCameraToshibaTeli &value)
	Set ZividCameraToshibaTeli More...

const ZividCameraToshibaTeli &	zividCameraToshibaTeli () const
	Get ZividCameraToshibaTeli More...

SoftwareVersion &	set (const ZividCameraToshibaTeli::FileDescription &value)
	Set ZividCameraToshibaTeli::FileDescription More...

SoftwareVersion &	set (const ZividCameraToshibaTeli::FileVersion &value)
	Set ZividCameraToshibaTeli::FileVersion More...

SoftwareVersion &	set (const ZividCameraToshibaTeli::ProductVersion &value)
	Set ZividCameraToshibaTeli::ProductVersion More...

SoftwareVersion &	set (const ZividCameraToshibaTeli::Comments &value)
	Set ZividCameraToshibaTeli::Comments More...

SoftwareVersion &	set (const ZividCameraFile &value)
	Set ZividCameraFile More...

const ZividCameraFile &	zividCameraFile () const
	Get ZividCameraFile More...

SoftwareVersion &	set (const ZividCameraFile::FileDescription &value)
	Set ZividCameraFile::FileDescription More...

SoftwareVersion &	set (const ZividCameraFile::FileVersion &value)
	Set ZividCameraFile::FileVersion More...

SoftwareVersion &	set (const ZividCameraFile::ProductVersion &value)
	Set ZividCameraFile::ProductVersion More...

SoftwareVersion &	set (const ZividCameraFile::Comments &value)
	Set ZividCameraFile::Comments 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	save (const std::string &fileName) const
	Save to the given file More...

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

void	load (const std::string &fileName)
	Load from the given file More...

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

bool	operator!= (const SoftwareVersion &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"}
	The full path for this value More...

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

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

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

Detailed Description

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

Constructor & Destructor Documentation

◆ SoftwareVersion()

Zivid::FrameInfo::SoftwareVersion::SoftwareVersion ( const std::string & fileName )

explicit

Construct object by loading from file

Member Function Documentation

◆ forEach() [1/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

◆ forEach() [2/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

◆ getString()

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

Get a value as string by specifying the path

◆ load()

void Zivid::FrameInfo::SoftwareVersion::load ( const std::string & fileName )

Load from the given file

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ save()

void Zivid::FrameInfo::SoftwareVersion::save ( const std::string & fileName ) const

Save to the given file

◆ set() [1/21]

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

Set a value from string by specifying the path

◆ set() [2/21]

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

inline

Set ZividStudio

◆ set() [3/21]

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

inline

Set ZividStudio::FileDescription

◆ set() [4/21]

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

inline

Set ZividStudio::FileVersion

◆ set() [5/21]

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

inline

Set ZividStudio::ProductVersion

◆ set() [6/21]

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

inline

Set ZividStudio::Comments

◆ set() [7/21]

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

inline

Set ZividAPI

◆ set() [8/21]

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

inline

Set ZividAPI::FileDescription

◆ set() [9/21]

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

inline

Set ZividAPI::FileVersion

◆ set() [10/21]

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

inline

Set ZividAPI::ProductVersion

◆ set() [11/21]

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

inline

Set ZividAPI::Comments

◆ set() [12/21]

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

inline

Set ZividCameraToshibaTeli

◆ set() [13/21]

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

inline

Set ZividCameraToshibaTeli::FileDescription

◆ set() [14/21]

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

inline

Set ZividCameraToshibaTeli::FileVersion

◆ set() [15/21]

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

inline

Set ZividCameraToshibaTeli::ProductVersion

◆ set() [16/21]

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

inline

Set ZividCameraToshibaTeli::Comments

◆ set() [17/21]

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

inline

Set ZividCameraFile

◆ set() [18/21]

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

inline

Set ZividCameraFile::FileDescription

◆ set() [19/21]

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

inline

Set ZividCameraFile::FileVersion

◆ set() [20/21]

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

inline

Set ZividCameraFile::ProductVersion

◆ set() [21/21]

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

inline

Set ZividCameraFile::Comments

◆ setFromString()

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

Set from the given string

◆ toString()

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

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

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

inline

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

◆ traverseValues() [2/2]

template<typename F >

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

inline

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

◆ zividAPI()

const ZividAPI& Zivid::FrameInfo::SoftwareVersion::zividAPI ( ) const

inline

Get ZividAPI

◆ zividCameraFile()

const ZividCameraFile& Zivid::FrameInfo::SoftwareVersion::zividCameraFile ( ) const

inline

Get ZividCameraFile

◆ zividCameraToshibaTeli()

const ZividCameraToshibaTeli& Zivid::FrameInfo::SoftwareVersion::zividCameraToshibaTeli ( ) const

inline

Get ZividCameraToshibaTeli

◆ zividStudio()

const ZividStudio& Zivid::FrameInfo::SoftwareVersion::zividStudio ( ) const

inline

Get ZividStudio

Friends And Related Function Documentation

◆ operator<<

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

friend

Operator to send the value as string to a stream

◆ operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

◆ isContainer

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

static

Whether this node contains child values

◆ name

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

static

The name of this value

◆ path

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

static

The full path for this value

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

C:/vagrant/source/cpp/build/install/include/Zivid/FrameInfo.h

Classes

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SoftwareVersion()

Member Function Documentation

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ getString()

◆ load()

◆ operator!=()

◆ operator==()

◆ save()

◆ set() [1/21]

◆ set() [2/21]

◆ set() [3/21]

◆ set() [4/21]

◆ set() [5/21]

◆ set() [6/21]

◆ set() [7/21]

◆ set() [8/21]

◆ set() [9/21]

◆ set() [10/21]

◆ set() [11/21]

◆ set() [12/21]

◆ set() [13/21]

◆ set() [14/21]

◆ set() [15/21]

◆ set() [16/21]

◆ set() [17/21]

◆ set() [18/21]

◆ set() [19/21]

◆ set() [20/21]

◆ set() [21/21]

◆ setFromString()

◆ toString()

◆ traverseValues() [1/2]

◆ traverseValues() [2/2]

◆ zividAPI()

◆ zividCameraFile()

◆ zividCameraToshibaTeli()

◆ zividStudio()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ isContainer

◆ name

◆ path