Zivid::Settings2D::Acquisitions Class Reference

List of acquisitions. Note that the Zivid SDK only supports a single acquisition per capture in 2D mode. More...

#include <Zivid/Settings2D.h>

Public Types
using	ValueType = std::vector< Settings2D::Acquisition >
	The type of the underlying value More...
using	Iterator = std::vector< Settings2D::Acquisition >::iterator
	Iterator type for Acquisitions More...
using	ConstIterator = std::vector< Settings2D::Acquisition >::const_iterator
	Constant iterator type for Acquisitions More...

Public Member Functions
	Acquisitions ()=default
	Default constructor More...
	Acquisitions (std::vector< Settings2D::Acquisition > value)
	Constructor More...
	Acquisitions (std::initializer_list< Settings2D::Acquisition > value)
	Constructor More...
const std::vector< Settings2D::Acquisition > &	value () const
	Get the value More...
std::string	toString () const
	Get the value as string More...
std::size_t	size () const noexcept
	Get the size of the list More...
bool	isEmpty () const noexcept
	Check if the list is empty More...
template<typename... Args>
void	emplaceBack (Args &&...args)
	Appends a new element to the end of the list More...
Settings2D::Acquisition &	at (std::size_t pos)
	Returns a reference to the element at position pos in the list More...
const Settings2D::Acquisition &	at (std::size_t pos) const
	Returns a const reference to the element at position pos in the list More...
Settings2D::Acquisition &	operator[] (std::size_t pos)
	Returns a reference to the element at position pos in the list More...
const Settings2D::Acquisition &	operator[] (std::size_t pos) const
	Returns a const reference to the element at position pos in the list More...
template<typename F >
void	forEach (const F &f)
	Run the given function on each element in the list More...
template<typename F >
void	forEach (const F &f) const
	Run the given function on each element in the list More...
Iterator	begin () noexcept
	Returns an iterator to the first element of the list More...
Iterator	end () noexcept
	Returns an iterator to the element following the last element of the list More...
ConstIterator	begin () const noexcept
	Returns a constant iterator to the first element of the list More...
ConstIterator	end () const noexcept
	Returns a constant iterator to the element following the last element of the list More...
ConstIterator	cbegin () const noexcept
	Returns a constant iterator to the first element of the list More...
ConstIterator	cend () const noexcept
	Returns a constant iterator to the element following the last element of the list More...
bool	operator== (const Acquisitions &other) const
	Comparison operator More...
bool	operator!= (const Acquisitions &other) const
	Comparison operator More...

Static Public Member Functions
static constexpr Range< ValueType::size_type >	validSize ()
	The valid sizes for Acquisitions More...

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

Friends
struct	DataModel::Detail::Befriend< Acquisitions >
std::ostream &	operator<< (std::ostream &stream, const Acquisitions &value)
	Operator to serialize the value to a stream More...

Detailed Description

List of acquisitions. Note that the Zivid SDK only supports a single acquisition per capture in 2D mode.

Member Typedef Documentation

ConstIterator

using Zivid::Settings2D::Acquisitions::ConstIterator = std::vector<Settings2D::Acquisition>::const_iterator

Constant iterator type for Acquisitions

Iterator

using Zivid::Settings2D::Acquisitions::Iterator = std::vector<Settings2D::Acquisition>::iterator

Iterator type for Acquisitions

ValueType

using Zivid::Settings2D::Acquisitions::ValueType = std::vector<Settings2D::Acquisition>

The type of the underlying value

Constructor & Destructor Documentation

Acquisitions() [1/3]

Zivid::Settings2D::Acquisitions::Acquisitions ( )

default

Default constructor

Acquisitions() [2/3]

Zivid::Settings2D::Acquisitions::Acquisitions ( std::vector< Settings2D::Acquisition >  value )

inlineexplicit

Constructor

Acquisitions() [3/3]

Zivid::Settings2D::Acquisitions::Acquisitions ( std::initializer_list< Settings2D::Acquisition >  value )

inlineexplicit

Constructor

Member Function Documentation

at() [1/2]

Settings2D::Acquisition & Zivid::Settings2D::Acquisitions::at

(

std::size_t

pos

)

Returns a reference to the element at position pos in the list

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

at() [2/2]

const Settings2D::Acquisition & Zivid::Settings2D::Acquisitions::at

(

std::size_t

pos

)

const

Returns a const reference to the element at position pos in the list

This function checks that pos is within the bounds (from 0 to size - 1). If pos is not within bounds an exception is thrown.

begin() [1/2]

ConstIterator Zivid::Settings2D::Acquisitions::begin ( ) const

noexcept

Returns a constant iterator to the first element of the list

begin() [2/2]

Iterator Zivid::Settings2D::Acquisitions::begin ( )

noexcept

Returns an iterator to the first element of the list

cbegin()

ConstIterator Zivid::Settings2D::Acquisitions::cbegin ( ) const

noexcept

Returns a constant iterator to the first element of the list

cend()

ConstIterator Zivid::Settings2D::Acquisitions::cend ( ) const

noexcept

Returns a constant iterator to the element following the last element of the list

emplaceBack()

template<typename... Args>

void Zivid::Settings2D::Acquisitions::emplaceBack ( Args &&...  args )

inline

Appends a new element to the end of the list

The new element is constructed in-place. The provided arguments Args are forwarded to the constructor of Settings2D::Acquisition. Invoking this method may invalidate all references to elements in the list.

end() [1/2]

ConstIterator Zivid::Settings2D::Acquisitions::end ( ) const

noexcept

Returns a constant iterator to the element following the last element of the list

end() [2/2]

Iterator Zivid::Settings2D::Acquisitions::end ( )

noexcept

Returns an iterator to the element following the last element of the list

forEach() [1/2]

template<typename F >

void Zivid::Settings2D::Acquisitions::forEach ( const F &  f )

inline

Run the given function on each element in the list

forEach() [2/2]

template<typename F >

void Zivid::Settings2D::Acquisitions::forEach ( const F &  f ) const

inline

Run the given function on each element in the list

isEmpty()

bool Zivid::Settings2D::Acquisitions::isEmpty ( ) const

noexcept

Check if the list is empty

operator!=()

bool Zivid::Settings2D::Acquisitions::operator!= ( const Acquisitions &  other ) const

inline

Comparison operator

operator==()

bool Zivid::Settings2D::Acquisitions::operator== ( const Acquisitions &  other ) const

inline

Comparison operator

operator[]() [1/2]

Settings2D::Acquisition & Zivid::Settings2D::Acquisitions::operator[]

(

std::size_t

pos

)

Returns a reference to the element at position pos in the list

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) will check the bounds and throw an exception if pos it out of bounds.

operator[]() [2/2]

const Settings2D::Acquisition & Zivid::Settings2D::Acquisitions::operator[]

(

std::size_t

pos

)

const

Returns a const reference to the element at position pos in the list

pos must be within the bounds (from 0 to size - 1). No bounds checking is performed. at(size_t) const will check the bounds and throw an exception if pos it out of bounds.

size()

std::size_t Zivid::Settings2D::Acquisitions::size ( ) const

noexcept

Get the size of the list

toString()

std::string Zivid::Settings2D::Acquisitions::toString

(

)

const

Get the value as string

validSize()

static constexpr Range< ValueType::size_type > Zivid::Settings2D::Acquisitions::validSize ( )

inlinestaticconstexpr

The valid sizes for Acquisitions

value()

const std::vector< Settings2D::Acquisition > & Zivid::Settings2D::Acquisitions::value

(

)

const

Get the value

Friends And Related Function Documentation

DataModel::Detail::Befriend< Acquisitions >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream

Member Data Documentation

description

constexpr const char* Zivid::Settings2D::Acquisitions::description

staticconstexpr

Initial value:

{
                R"description(List of acquisitions. Note that the Zivid SDK only supports a single acquisition per capture in 2D mode.)description"
            }

The description for this value

name

constexpr const char* Zivid::Settings2D::Acquisitions::name { "Acquisitions" }

staticconstexpr

The name of this value

nodeType

constexpr DataModel::NodeType Zivid::Settings2D::Acquisitions::nodeType = DataModel::NodeType::leafDataModelList

staticconstexpr

The type of this node

path

constexpr const char* Zivid::Settings2D::Acquisitions::path { "Acquisitions" }

staticconstexpr

The full path for this value

---

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

• Zivid/Settings2D.h