Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Public Member Functions | List of all members
Zivid::Presets::CategoryBase< PresetType > Class Template Reference

Preset category. A preset category contains a collection of presets optimized for one scenario or use case. More...

#include <Zivid/Presets.h>

Public Member Functions

 CategoryBase (std::string name, std::vector< PresetType > presets) noexcept
 Constructor More...
 
const std::string & name () const noexcept
 Get the name of the category More...
 
const std::vector< PresetType > & presets () const noexcept
 Get the presets of the category More...
 
std::string toString () const
 Get string representation of the preset category More...
 

Detailed Description

template<typename PresetType>
class Zivid::Presets::CategoryBase< PresetType >

Preset category. A preset category contains a collection of presets optimized for one scenario or use case.

Constructor & Destructor Documentation

◆ CategoryBase()

template<typename PresetType >
Zivid::Presets::CategoryBase< PresetType >::CategoryBase ( std::string  name,
std::vector< PresetType >  presets 
)
noexcept

Constructor

Member Function Documentation

◆ name()

template<typename PresetType >
const std::string & Zivid::Presets::CategoryBase< PresetType >::name ( ) const
noexcept

Get the name of the category

◆ presets()

template<typename PresetType >
const std::vector< PresetType > & Zivid::Presets::CategoryBase< PresetType >::presets ( ) const
noexcept

Get the presets of the category

The settings might change between different releases of the SDK. New presets might be added and old ones might be removed. If having the exact same settings is desired, it is recommended to save them to a YML file and load as needed.

◆ toString()

template<typename PresetType >
std::string Zivid::Presets::CategoryBase< PresetType >::toString ( ) const

Get string representation of the preset category


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