Various information for a frame. More...

#include <Zivid/FrameInfo.h>

Classes
class	Metrics
	Metrics related to this capture. More...

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

class	SystemInfo
	Information about the system that captured this frame. More...

class	TimeStamp
	The time of frame capture. More...

Public Types
using	Descendants

Public Member Functions
	FrameInfo ()
	Default constructor.

	FrameInfo (const std::string &fileName)
	Construct FrameInfo by loading from file.

std::string	serialize () const
	Serialize to a string.

template<typename... Args>
	FrameInfo (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
FrameInfo	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const Metrics &	metrics () const
	Get Metrics.

Metrics &	metrics ()
	Get Metrics.

FrameInfo &	set (const Metrics &value)
	Set Metrics.

FrameInfo &	set (const Metrics::AcquisitionTime &value)
	Set Metrics::AcquisitionTime.

FrameInfo &	set (const Metrics::CaptureTime &value)
	Set Metrics::CaptureTime.

const SoftwareVersion &	softwareVersion () const
	Get SoftwareVersion.

SoftwareVersion &	softwareVersion ()
	Get SoftwareVersion.

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

FrameInfo &	set (const SoftwareVersion::Core &value)
	Set SoftwareVersion::Core.

const SystemInfo &	systemInfo () const
	Get SystemInfo.

SystemInfo &	systemInfo ()
	Get SystemInfo.

FrameInfo &	set (const SystemInfo &value)
	Set SystemInfo.

FrameInfo &	set (const SystemInfo::CPU &value)
	Set SystemInfo::CPU.

FrameInfo &	set (const SystemInfo::CPU::Model &value)
	Set SystemInfo::CPU::Model.

FrameInfo &	set (const SystemInfo::ComputeDevice &value)
	Set SystemInfo::ComputeDevice.

FrameInfo &	set (const SystemInfo::ComputeDevice::Model &value)
	Set SystemInfo::ComputeDevice::Model.

FrameInfo &	set (const SystemInfo::ComputeDevice::Vendor &value)
	Set SystemInfo::ComputeDevice::Vendor.

FrameInfo &	set (const SystemInfo::OperatingSystem &value)
	Set SystemInfo::OperatingSystem.

const TimeStamp &	timeStamp () const
	Get TimeStamp.

TimeStamp &	timeStamp ()
	Get TimeStamp.

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

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

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

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

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

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<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo >::value, int >::type = 0>
const FrameInfo::SystemInfo &	get () const

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

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::CPU::Model >::value, int >::type = 0>
const FrameInfo::SystemInfo::CPU::Model &	get () const

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

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::ComputeDevice::Model >::value, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Model &	get () const

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::ComputeDevice::Vendor >::value, int >::type = 0>
const FrameInfo::SystemInfo::ComputeDevice::Vendor &	get () const

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

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

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

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

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

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const FrameInfo::TimeStamp &	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 FrameInfo &other) const
	Equality operator.

bool	operator!= (const FrameInfo &other) const
	Inequality operator.

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

void	save (const std::string &fileName) const
	Save to the given file.

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

Static Public Member Functions
static FrameInfo	fromSerialized (const std::string &value)
	Construct a new FrameInfo instance from a previously serialized string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.

static constexpr const char *	path { "" }
	The full path for this value.

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

static constexpr const char *	description { R"description(Various information for a frame)description" }
	The description for this value.

static constexpr size_t	version { 4 }

Friends
struct	DataModel::Detail::Befriend< FrameInfo >

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

Detailed Description

Various information for a frame.

Member Typedef Documentation

◆ Descendants

using Zivid::FrameInfo::Descendants

Initial value:

 std::tuple<
            FrameInfo::Metrics,
            FrameInfo::Metrics::AcquisitionTime,
            FrameInfo::Metrics::CaptureTime,
            FrameInfo::SoftwareVersion,
            FrameInfo::SoftwareVersion::Core,
            FrameInfo::SystemInfo,
            FrameInfo::SystemInfo::CPU,
            FrameInfo::SystemInfo::CPU::Model,
            FrameInfo::SystemInfo::ComputeDevice,
            FrameInfo::SystemInfo::ComputeDevice::Model,
            FrameInfo::SystemInfo::ComputeDevice::Vendor,
            FrameInfo::SystemInfo::OperatingSystem,
            FrameInfo::TimeStamp>

Constructor & Destructor Documentation

◆ FrameInfo() [1/3]

Zivid::FrameInfo::FrameInfo ( )

Default constructor.

◆ FrameInfo() [2/3]

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

explicit

Construct FrameInfo by loading from file.

◆ FrameInfo() [3/3]

template<typename... Args>

Zivid::FrameInfo::FrameInfo ( 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 FrameInfo then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

FrameInfo Zivid::FrameInfo::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 FrameInfo 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 FrameInfo. These types can be provided:

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

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

◆ fromSerialized()

static FrameInfo Zivid::FrameInfo::fromSerialized ( const std::string & value )

staticnodiscard

Construct a new FrameInfo instance from a previously serialized string.

◆ get() [1/17]

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

const FrameInfo::Metrics & Zivid::FrameInfo::get ( ) const

inline

◆ get() [2/17]

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

const FrameInfo::Metrics::AcquisitionTime & Zivid::FrameInfo::get ( ) const

inline

◆ get() [3/17]

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

const FrameInfo::Metrics::CaptureTime & Zivid::FrameInfo::get ( ) const

inline

◆ get() [4/17]

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

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

inline

◆ get() [5/17]

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

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

inline

◆ get() [6/17]

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

const FrameInfo::SystemInfo & Zivid::FrameInfo::get ( ) const

inline

◆ get() [7/17]

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

const FrameInfo::SystemInfo::CPU & Zivid::FrameInfo::get ( ) const

inline

◆ get() [8/17]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::CPU::Model >::value, int >::type = 0>

const FrameInfo::SystemInfo::CPU::Model & Zivid::FrameInfo::get ( ) const

inline

◆ get() [9/17]

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

const FrameInfo::SystemInfo::ComputeDevice & Zivid::FrameInfo::get ( ) const

inline

◆ get() [10/17]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::ComputeDevice::Model >::value, int >::type = 0>

const FrameInfo::SystemInfo::ComputeDevice::Model & Zivid::FrameInfo::get ( ) const

inline

◆ get() [11/17]

template<typename T , typename std::enable_if< std::is_same< T, FrameInfo::SystemInfo::ComputeDevice::Vendor >::value, int >::type = 0>

const FrameInfo::SystemInfo::ComputeDevice::Vendor & Zivid::FrameInfo::get ( ) const

inline

◆ get() [12/17]

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

const FrameInfo::SystemInfo::OperatingSystem & Zivid::FrameInfo::get ( ) const

inline

◆ get() [13/17]

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

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

inline

◆ get() [14/17]

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

const FrameInfo::Metrics & Zivid::FrameInfo::get ( ) const

inline

◆ get() [15/17]

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

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

inline

◆ get() [16/17]

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

const FrameInfo::SystemInfo & Zivid::FrameInfo::get ( ) const

inline

◆ get() [17/17]

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

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

inline

◆ load()

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

Load from the given file.

◆ metrics() [1/2]

Metrics & Zivid::FrameInfo::metrics ( )

inline

Get Metrics.

◆ metrics() [2/2]

const Metrics & Zivid::FrameInfo::metrics ( ) const

inline

Get Metrics.

◆ 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.

◆ serialize()

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

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/14]

template<typename... Args>

void Zivid::FrameInfo::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 FrameInfo. These types can be provided:

◆ set() [2/14]

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

inline

Set Metrics.

◆ set() [3/14]

FrameInfo & Zivid::FrameInfo::set ( const Metrics::AcquisitionTime & value )

inline

Set Metrics::AcquisitionTime.

◆ set() [4/14]

FrameInfo & Zivid::FrameInfo::set ( const Metrics::CaptureTime & value )

inline

Set Metrics::CaptureTime.

◆ set() [5/14]

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

inline

Set SoftwareVersion.

◆ set() [6/14]

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

inline

Set SoftwareVersion::Core.

◆ set() [7/14]

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

inline

Set SystemInfo.

◆ set() [8/14]

FrameInfo & Zivid::FrameInfo::set ( const SystemInfo::ComputeDevice & value )

inline

Set SystemInfo::ComputeDevice.

◆ set() [9/14]

FrameInfo & Zivid::FrameInfo::set ( const SystemInfo::ComputeDevice::Model & value )

inline

Set SystemInfo::ComputeDevice::Model.

◆ set() [10/14]

FrameInfo & Zivid::FrameInfo::set ( const SystemInfo::ComputeDevice::Vendor & value )

inline

Set SystemInfo::ComputeDevice::Vendor.

◆ set() [11/14]

FrameInfo & Zivid::FrameInfo::set ( const SystemInfo::CPU & value )

inline

Set SystemInfo::CPU.

◆ set() [12/14]

FrameInfo & Zivid::FrameInfo::set ( const SystemInfo::CPU::Model & value )

inline

Set SystemInfo::CPU::Model.

◆ set() [13/14]

FrameInfo & Zivid::FrameInfo::set ( const SystemInfo::OperatingSystem & value )

inline

Set SystemInfo::OperatingSystem.

◆ set() [14/14]

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

inline

Set TimeStamp.

◆ softwareVersion() [1/2]

SoftwareVersion & Zivid::FrameInfo::softwareVersion ( )

inline

Get SoftwareVersion.

◆ softwareVersion() [2/2]

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

inline

Get SoftwareVersion.

◆ systemInfo() [1/2]

SystemInfo & Zivid::FrameInfo::systemInfo ( )

inline

Get SystemInfo.

◆ systemInfo() [2/2]

const SystemInfo & Zivid::FrameInfo::systemInfo ( ) const

inline

Get SystemInfo.

◆ timeStamp() [1/2]

TimeStamp & Zivid::FrameInfo::timeStamp ( )

inline

Get TimeStamp.

◆ timeStamp() [2/2]

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

inline

Get TimeStamp.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< FrameInfo >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::FrameInfo::description { R"description(Various information for a frame)description" }

staticconstexpr

The description for this value.

◆ name

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

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

staticconstexpr

The full path for this value.

◆ version

size_t Zivid::FrameInfo::version { 4 }

staticconstexpr

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

Zivid/FrameInfo.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ FrameInfo() [1/3]

◆ FrameInfo() [2/3]

◆ FrameInfo() [3/3]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ fromSerialized()

◆ get() [1/17]

◆ get() [2/17]

◆ get() [3/17]

◆ get() [4/17]

◆ get() [5/17]

◆ get() [6/17]

◆ get() [7/17]

◆ get() [8/17]

◆ get() [9/17]

◆ get() [10/17]

◆ get() [11/17]

◆ get() [12/17]

◆ get() [13/17]

◆ get() [14/17]

◆ get() [15/17]

◆ get() [16/17]

◆ get() [17/17]

◆ load()

◆ metrics() [1/2]

◆ metrics() [2/2]

◆ operator!=()

◆ operator==()

◆ save()

◆ serialize()

◆ set() [1/14]

◆ set() [2/14]

◆ set() [3/14]

◆ set() [4/14]

◆ set() [5/14]

◆ set() [6/14]

◆ set() [7/14]

◆ set() [8/14]

◆ set() [9/14]

◆ set() [10/14]

◆ set() [11/14]

◆ set() [12/14]

◆ set() [13/14]

◆ set() [14/14]

◆ softwareVersion() [1/2]

◆ softwareVersion() [2/2]

◆ systemInfo() [1/2]

◆ systemInfo() [2/2]

◆ timeStamp() [1/2]

◆ timeStamp() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< FrameInfo >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version