libvisiontransfer  10.0.0
Public Types | Public Member Functions | List of all members
visiontransfer::param::ParameterSet Class Reference

#include <visiontransfer/parameterset.h>

Inheritance diagram for visiontransfer::param::ParameterSet:
Inheritance graph
[legend]
Collaboration diagram for visiontransfer::param::ParameterSet:
Collaboration graph
[legend]

Public Types

typedef std::shared_ptr< ParameterSetptr
 

Public Member Functions

Parameterget (const std::string &uid)
 Checked parameter getter for clients to avoid instantiation of incomplete ones. More...
 
bool add (const Parameter &param)
 
template<typename T >
getCurrentOrFallback (const std::string &key, T &&fallback)
 Convenience function for safe bulk parameter access (fallback for invalid UIDs). Will return any default value if UID exists but current value unset. More...
 
template<typename T >
getCurrent (const std::string &key)
 Convenience function for safe bulk parameter access (throws for invalid UIDs). Will return any default value if UID exists but current value unset. More...
 
ParametersetOrCreateSimpleScalar (const std::string &uid, int value)
 
ParametersetOrCreateSimpleScalar (const std::string &uid, bool value)
 
ParametersetOrCreateSimpleScalar (const std::string &uid, double value)
 
ParametersetOrCreateSimpleScalar (const std::string &uid, const std::string &value)
 

Detailed Description

ParameterSet is a map from UIDs to Parameters with some extra functionality.

Definition at line 35 of file parameterset.h.

Member Function Documentation

◆ get()

Parameter& visiontransfer::param::ParameterSet::get ( const std::string &  uid)
inline

Checked parameter getter for clients to avoid instantiation of incomplete ones.

Definition at line 39 of file parameterset.h.

◆ getCurrent()

template<typename T >
T visiontransfer::param::ParameterSet::getCurrent ( const std::string &  key)
inline

Convenience function for safe bulk parameter access (throws for invalid UIDs). Will return any default value if UID exists but current value unset.

Definition at line 52 of file parameterset.h.

◆ getCurrentOrFallback()

template<typename T >
T visiontransfer::param::ParameterSet::getCurrentOrFallback ( const std::string &  key,
T &&  fallback 
)
inline

Convenience function for safe bulk parameter access (fallback for invalid UIDs). Will return any default value if UID exists but current value unset.

Definition at line 46 of file parameterset.h.


The documentation for this class was generated from the following files:
Nerian Vision Technologies