visiontransfer::param::ParameterSet Class Reference

Detailed Description

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

Definition at line 59 of file parameterset.h.

#include <visiontransfer/parameterset.h>

Inheritance diagram for visiontransfer::param::ParameterSet:

Collaboration diagram for visiontransfer::param::ParameterSet:

Classes
class	Pimpl

Public Types
typedef std::shared_ptr< ParameterSet >	ptr

Public Member Functions
VT_EXPORT Parameter &	get (const std::string &uid)
	Checked parameter getter for clients to avoid instantiation of incomplete ones. More...
VT_EXPORT bool	add (const Parameter &param)
template<typename T >
VT_EXPORT 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 >
VT_EXPORT 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...
VT_EXPORT Parameter &	setOrCreateSimpleScalar (const std::string &uid, int value)
VT_EXPORT Parameter &	setOrCreateSimpleScalar (const std::string &uid, bool value)
VT_EXPORT Parameter &	setOrCreateSimpleScalar (const std::string &uid, double value)
VT_EXPORT Parameter &	setOrCreateSimpleScalar (const std::string &uid, const std::string &value)

Member Function Documentation

get()

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

inline

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

Definition at line 80 of file parameterset.h.

getCurrent()

template<typename T >

VT_EXPORT 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 95 of file parameterset.h.

getCurrentOrFallback()

template<typename T >

VT_EXPORT 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 88 of file parameterset.h.

---

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

• visiontransfer/parameterset.h
• visiontransfer/parameterset.cpp