Various information for a frame More...

#include <Zivid/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 Types
using	Descendants = std::tuple< FrameInfo::SoftwareVersion, FrameInfo::SoftwareVersion::Core, FrameInfo::TimeStamp >

Public Member Functions
	FrameInfo ()
	Default constructor More...

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

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

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

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) More...

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

SoftwareVersion &	softwareVersion ()
	Get SoftwareVersion More...

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

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

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

TimeStamp &	timeStamp ()
	Get TimeStamp More...

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

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::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::SoftwareVersion &	get () const

template<size_t i, typename std::enable_if< i==1, 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 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...

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

bool	operator!= (const FrameInfo &other) const
	Inequality operator 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	load (const std::string &fileName)
	Load from the given file More...

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node 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...

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

static constexpr size_t	version { 2 }

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

Detailed Description

Various information for a frame

Member Typedef Documentation

◆ Descendants

using Zivid::FrameInfo::Descendants = std::tuple<FrameInfo::SoftwareVersion, FrameInfo::SoftwareVersion::Core, 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

◆ get() [1/5]

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() [2/5]

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() [3/5]

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() [4/5]

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

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

inline

◆ get() [5/5]

template<size_t i, typename std::enable_if< i==1, 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

◆ 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/4]

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/4]

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

inline

Set SoftwareVersion

◆ set() [3/4]

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

inline

Set SoftwareVersion::Core

◆ set() [4/4]

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

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

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

staticconstexpr

The description for this value

◆ name

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

staticconstexpr

The name of this value

◆ nodeType

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

staticconstexpr

The type of this node

◆ path

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

staticconstexpr

The full path for this value

◆ version

constexpr size_t Zivid::FrameInfo::version { 2 }

staticconstexpr

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

Zivid/FrameInfo.h

Classes

Public Types

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]

◆ get() [1/5]

◆ get() [2/5]

◆ get() [3/5]

◆ get() [4/5]

◆ get() [5/5]

◆ load()

◆ operator!=()

◆ operator==()

◆ save()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ softwareVersion() [1/2]

◆ softwareVersion() [2/2]

◆ timeStamp() [1/2]

◆ timeStamp() [2/2]

◆ toString()

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< FrameInfo >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version