JeVois
1.22
JeVois Smart Embedded Machine Vision Toolkit
|
|
#include <jevois/Component/ParameterDef.H>
Base class for a Parameter definition.
This exposes the string-based interface to the definition while derived class templates will expose the value-based interface. Users should never directly create a ParameterDefBase, but should instead create a properly templated ParameterDef<T>, as ParameterDef<T> derives from ParameterBase.
Definition at line 47 of file ParameterDef.H.
Public Member Functions | |
ParameterDefBase (std::string const &name, std::string const &description, ParameterCategory const &category=ParameterCategory()) | |
Construct a ParameterDefBase. | |
virtual | ~ParameterDefBase () |
Destructor. | |
std::string const & | name () const |
The parameter name (without the leading "--") | |
std::string const & | description () const |
Description of what the parameter does. | |
ParameterCategory const & | category () const |
The Parameter category. | |
virtual std::string const | defaultValueString () const =0 |
Default value in string representation. | |
virtual std::string const | validValuesString () const =0 |
Valid values in string representation. | |
Protected Attributes | |
std::string | itsName |
Our name. | |
std::string | itsDescription |
Our description string. | |
ParameterCategory | itsCategory |
Our category. | |
jevois::ParameterDefBase::ParameterDefBase | ( | std::string const & | name, |
std::string const & | description, | ||
ParameterCategory const & | category = ParameterCategory() |
||
) |
Construct a ParameterDefBase.
Definition at line 32 of file ParameterDef.C.
|
virtual |
Destructor.
Definition at line 38 of file ParameterDef.C.
jevois::ParameterCategory const & jevois::ParameterDefBase::category | ( | ) | const |
The Parameter category.
Definition at line 50 of file ParameterDef.C.
|
pure virtual |
Default value in string representation.
Implemented in jevois::ParameterDef< T >.
std::string const & jevois::ParameterDefBase::description | ( | ) | const |
Description of what the parameter does.
Definition at line 46 of file ParameterDef.C.
std::string const & jevois::ParameterDefBase::name | ( | ) | const |
The parameter name (without the leading "--")
Definition at line 42 of file ParameterDef.C.
|
pure virtual |
Valid values in string representation.
Implemented in jevois::ParameterDef< T >.
|
protected |
Our category.
Definition at line 75 of file ParameterDef.H.
|
protected |
Our description string.
Definition at line 74 of file ParameterDef.H.
|
protected |
Our name.
Definition at line 73 of file ParameterDef.H.