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:

[legend]

Public Member Functions
	ParameterBase ()
	Constructor. More...

virtual	~ParameterBase ()
	Destructor, will remove the parameter from its owner component. More...

virtual const std::string &	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 const std::string	strget () const =0
	Get the value as a string. More...

virtual const ParameterSummary	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...

void	freeze (bool doit)
	Alternate syntax that can be used instead of freeze()/unFreeze(), useful for programmatic freezing. More...

virtual void	reset ()=0
	Reset this parameter to its default value. 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...

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

Public Member Functions

Protected Attributes