JeVois  1.5
JeVois Smart Embedded Machine Vision Toolkit
Share this page:

#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.

Inheritance diagram for jevois::ParameterDefBase:
Collaboration diagram for jevois::ParameterDefBase:

Public Member Functions

 ParameterDefBase (std::string const &name, std::string const &description, ParameterCategory const &category=ParameterCategory())
 Construct a ParameterDefBase. More...
 
virtual ~ParameterDefBase ()
 Destructor. More...
 
std::string const & name () const
 The parameter name (without the leading "--") More...
 
std::string const & description () const
 Description of what the parameter does. More...
 
ParameterCategory const & category () const
 The Parameter category. More...
 
virtual std::string const defaultValueString () const =0
 Default value in string representation. More...
 
virtual std::string const validValuesString () const =0
 Valid values in string representation. More...
 

Protected Attributes

std::string itsName
 Our name. More...
 
std::string itsDescription
 Our description string. More...
 
ParameterCategory itsCategory
 Our category. More...
 

Constructor & Destructor Documentation

◆ ParameterDefBase()

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.

◆ ~ParameterDefBase()

jevois::ParameterDefBase::~ParameterDefBase ( )
virtual

Destructor.

Definition at line 38 of file ParameterDef.C.

Member Function Documentation

◆ category()

jevois::ParameterCategory const & jevois::ParameterDefBase::category ( ) const

The Parameter category.

Definition at line 50 of file ParameterDef.C.

References itsCategory.

◆ defaultValueString()

virtual std::string const jevois::ParameterDefBase::defaultValueString ( ) const
pure virtual

Default value in string representation.

Implemented in jevois::ParameterDef< T >.

◆ description()

std::string const & jevois::ParameterDefBase::description ( ) const

Description of what the parameter does.

Definition at line 46 of file ParameterDef.C.

References itsDescription.

◆ name()

std::string const & jevois::ParameterDefBase::name ( ) const

The parameter name (without the leading "--")

Definition at line 42 of file ParameterDef.C.

References itsName.

◆ validValuesString()

virtual std::string const jevois::ParameterDefBase::validValuesString ( ) const
pure virtual

Valid values in string representation.

Implemented in jevois::ParameterDef< T >.

Member Data Documentation

◆ itsCategory

ParameterCategory jevois::ParameterDefBase::itsCategory
protected

Our category.

Definition at line 75 of file ParameterDef.H.

Referenced by category().

◆ itsDescription

std::string jevois::ParameterDefBase::itsDescription
protected

Our description string.

Definition at line 74 of file ParameterDef.H.

Referenced by description().

◆ itsName

std::string jevois::ParameterDefBase::itsName
protected

Our name.

Definition at line 73 of file ParameterDef.H.

Referenced by name(), and jevois::ParameterDef< T >::ParameterDef().


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