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

#include <jevois/Component/ParameterRegistry.H>

A simple registry of all parameters associated with a Component.

This registry allows one to loop over or search for given parameters in a Component.

Definition at line 33 of file ParameterRegistry.H.

Inheritance diagram for jevois::ParameterRegistry:

Public Member Functions

virtual ~ParameterRegistry ()
 Virtual destructor for safe inheritance. More...
 

Protected Member Functions

void addParameter (ParameterBase *const param)
 The Parameter class uses this method to register itself on construction with its owning Component. More...
 
void removeParameter (ParameterBase *const param)
 The Parameter class uses this method to un-register itself on destruction with its owning Component. More...
 
void callbackInitCall ()
 For all parameters that have a callback which has never been called, call it with the default param value. More...
 

Friends

class Component
 Allow Component and DynamicParameter to access our registry data, everyone else is locked out. More...
 
template<typename T >
class DynamicParameter
 

Constructor & Destructor Documentation

◆ ~ParameterRegistry()

jevois::ParameterRegistry::~ParameterRegistry ( )
virtual

Virtual destructor for safe inheritance.

Definition at line 25 of file ParameterRegistry.C.

Member Function Documentation

◆ addParameter()

void jevois::ParameterRegistry::addParameter ( jevois::ParameterBase *const  param)
protected

The Parameter class uses this method to register itself on construction with its owning Component.

Definition at line 29 of file ParameterRegistry.C.

References JEVOIS_TRACE, LDEBUG, LFATAL, and jevois::ParameterBase::name().

◆ callbackInitCall()

void jevois::ParameterRegistry::callbackInitCall ( )
protected

For all parameters that have a callback which has never been called, call it with the default param value.

Definition at line 63 of file ParameterRegistry.C.

References JEVOIS_TRACE.

◆ removeParameter()

void jevois::ParameterRegistry::removeParameter ( jevois::ParameterBase *const  param)
protected

The Parameter class uses this method to un-register itself on destruction with its owning Component.

Definition at line 44 of file ParameterRegistry.C.

References JEVOIS_TRACE, LDEBUG, LERROR, and jevois::ParameterBase::name().

Friends And Related Function Documentation

◆ Component

friend class Component
friend

Allow Component and DynamicParameter to access our registry data, everyone else is locked out.

Definition at line 51 of file ParameterRegistry.H.

◆ DynamicParameter

template<typename T >
friend class DynamicParameter
friend

Definition at line 52 of file ParameterRegistry.H.


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