JeVois  1.0
JeVois Smart Embedded Machine Vision Toolkit

#include <jevois/Component/Parameter.H>

Base class for Parameter.

This exposes the string interface to the Parameter while derived template classes will expose the value-based interface.

Definition at line 121 of file Parameter.H.

Inheritance diagram for jevois::ParameterBase:

Public Member Functions

 ParameterBase ()
 Constructor. More...
 
virtual ~ParameterBase ()
 Destructor, will remove the parameter from its owner component. More...
 
virtual std::string const & name () const =0
 Get the parameter name. More...
 
virtual std::string descriptor () const =0
 Get the parameter fully-qualified name, aka descriptor, including names of owning Component and all parents. More...
 
virtual void strset (std::string const &valstring)=0
 Set the value from a string representation of it. More...
 
virtual std::string const strget () const =0
 Get the value as a string. More...
 
virtual ParameterSummary const summary () const =0
 Get summary info about this parameter. More...
 
void freeze ()
 Freeze this parameter, it becomes read-only and will not show up in the help message. More...
 
void unFreeze ()
 Unfreeze this parameter, it becomes read-write and will show up in the help message. More...
 

Protected Attributes

boost::shared_mutex itsMutex
 Mutex to protect the parameter value. More...
 
volatile bool itsFrozen
 When true, parameter is frozen (read-only, does not show up in help message) More...
 
bool itsVirgin
 Param has not yet been explicitly set, need to call the callback (if any) at init time. More...
 

Friends

class ParameterRegistry
 

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