Various information for a frame More...

#include <FrameInfo.h>

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

class	TimeStamp
	The time of frame capture More...

Public Member Functions
	FrameInfo (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...

FrameInfo &	set (const TimeStamp &value)
	Set TimeStamp More...

const TimeStamp &	timeStamp () const
	Get TimeStamp More...

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

const SoftwareVersion &	softwareVersion () const
	Get SoftwareVersion More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

FrameInfo &	set (const SoftwareVersion::ZividCameraFile::Comments &value)
	Set SoftwareVersion::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 FrameInfo &other) const
	Equality operator More...

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

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

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

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

Detailed Description

Various information for a frame

Constructor & Destructor Documentation

◆ FrameInfo()

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

explicit

Construct object by loading from file

Member Function Documentation

◆ forEach() [1/2]

template<typename F >

void Zivid::FrameInfo::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::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::getString ( const std::string & fullPath ) const

Get a value as string by specifying the path

◆ load()

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

Load from the given file

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ save()

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

Save to the given file

◆ set() [1/23]

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

Set a value from string by specifying the path

◆ set() [2/23]

FrameInfo& Zivid::FrameInfo::set ( const TimeStamp & value )

inline

Set TimeStamp

◆ set() [3/23]

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

inline

Set SoftwareVersion

◆ set() [4/23]

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

inline

Set SoftwareVersion::ZividStudio

◆ set() [5/23]

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

inline

Set SoftwareVersion::ZividStudio::FileDescription

◆ set() [6/23]

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

inline

Set SoftwareVersion::ZividStudio::FileVersion

◆ set() [7/23]

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

inline

Set SoftwareVersion::ZividStudio::ProductVersion

◆ set() [8/23]

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

inline

Set SoftwareVersion::ZividStudio::Comments

◆ set() [9/23]

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

inline

Set SoftwareVersion::ZividAPI

◆ set() [10/23]

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

inline

Set SoftwareVersion::ZividAPI::FileDescription

◆ set() [11/23]

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

inline

Set SoftwareVersion::ZividAPI::FileVersion

◆ set() [12/23]

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

inline

Set SoftwareVersion::ZividAPI::ProductVersion

◆ set() [13/23]

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

inline

Set SoftwareVersion::ZividAPI::Comments

◆ set() [14/23]

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

inline

Set SoftwareVersion::ZividCameraToshibaTeli

◆ set() [15/23]

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

inline

Set SoftwareVersion::ZividCameraToshibaTeli::FileDescription

◆ set() [16/23]

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

inline

Set SoftwareVersion::ZividCameraToshibaTeli::FileVersion

◆ set() [17/23]

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

inline

Set SoftwareVersion::ZividCameraToshibaTeli::ProductVersion

◆ set() [18/23]

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

inline

Set SoftwareVersion::ZividCameraToshibaTeli::Comments

◆ set() [19/23]

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

inline

Set SoftwareVersion::ZividCameraFile

◆ set() [20/23]

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

inline

Set SoftwareVersion::ZividCameraFile::FileDescription

◆ set() [21/23]

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

inline

Set SoftwareVersion::ZividCameraFile::FileVersion

◆ set() [22/23]

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

inline

Set SoftwareVersion::ZividCameraFile::ProductVersion

◆ set() [23/23]

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

inline

Set SoftwareVersion::ZividCameraFile::Comments

◆ setFromString()

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

Set from the given string

◆ softwareVersion()

const SoftwareVersion& Zivid::FrameInfo::softwareVersion ( ) const

inline

Get SoftwareVersion

◆ timeStamp()

const TimeStamp& Zivid::FrameInfo::timeStamp ( ) const

inline

Get TimeStamp

◆ toString()

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

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

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

inline

Traverse all members 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 FrameInfo &	value
	)

friend

Operator to send the value as string to a stream

◆ operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

◆ isContainer

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

static

Whether this node contains child values

◆ name

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

static

The name of this value

◆ path

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

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

◆ FrameInfo()

Member Function Documentation

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ getString()

◆ load()

◆ operator!=()

◆ operator==()

◆ save()

◆ set() [1/23]

◆ set() [2/23]

◆ set() [3/23]

◆ set() [4/23]

◆ set() [5/23]

◆ set() [6/23]

◆ set() [7/23]

◆ set() [8/23]

◆ set() [9/23]

◆ set() [10/23]

◆ set() [11/23]

◆ set() [12/23]

◆ set() [13/23]

◆ set() [14/23]

◆ set() [15/23]

◆ set() [16/23]

◆ set() [17/23]

◆ set() [18/23]

◆ set() [19/23]

◆ set() [20/23]

◆ set() [21/23]

◆ set() [22/23]

◆ set() [23/23]

◆ setFromString()

◆ softwareVersion()

◆ timeStamp()

◆ toString()

◆ traverseValues() [1/2]

◆ traverseValues() [2/2]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ isContainer

◆ name

◆ path