iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nrt::ParameterDefBase Class Referenceabstract

#include <nrt/Core/Model/ParameterDef.H>

Base class for a Paramater 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 ParemeterDef<T>

Definition at line 86 of file ParameterDef.H.

Inheritance diagram for nrt::ParameterDefBase:
nrt::ParameterDef< T >

Public Member Functions

 ParameterDefBase (std::string const &name, std::string const &description, ParameterCategory const &category=ParameterCategory(), ParameterFlags const pflags=ParameterFlags::None)
 Construct a ParameterDefBase.
virtual ~ParameterDefBase ()
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.
ParameterFlags flags () const
 The Parameter Flags.

Protected Attributes

std::string itsName
std::string itsDescription
ParameterCategory itsCategory
ParameterFlags itsFlags

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