#include <jevois/Component/Manager.H>

Manager of a hierarchy of Component objects.

A Manager should be the top-level Component of any hierarchy of Components. It is primarily responsible for handling the setting of Parameter values via the command-line or otherwise.

Users should only need to construct a Manager (including Engine, which derives from Manager), add any Component to it, and then call init() on the Manager, which will parse all command line options, bind them to the relevant Parameters, and call init() on all subComponents (which in turn calls init() on all of their subComponents, etc.). See the documentation of Component for more information about the init() flow.

The parameter nickname is not internally used by the Manager. It can be set, for example, in initscript.cfg to a different value for each camera, in systems that use multiple JeVois cameras connected to a single USB bus.

Definition at line 72 of file Manager.H.

Inheritance diagram for jevois::Manager:

[legend]

Collaboration diagram for jevois::Manager:

[legend]

Public Member Functions
Manager construction, destruction, parsing command-line arguments
	Manager (std::string const &instance="TheManager")
	Constructor without command-line args.

	Manager (int argc, char const *argv[], std::string const &instance="TheManager")
	Constructor.

void	setCommandLineArgs (int argc, char const *argv[])
	Set the command-line arguments, call this before start() if args were not passed at construction.

virtual	~Manager ()
	Destructor.

Component hierarchies under the Manager
template<class Comp , typename... Args>
std::shared_ptr< Comp >	addComponent (std::string const &instanceName, Args &&...args)
	Pseudo-constructor: construct a top-level Component.

template<class Comp , typename... Args>
std::shared_ptr< Comp >	addSubComponent (std::string const &instanceName, Args &&...args)=delete
	Use addComponent() on the Manager as opposed to jevois::Component::addSubComponent()

template<class Comp >
void	removeComponent (std::shared_ptr< Comp > &component)
	Remove a top-level Component from the Manager, by shared_ptr.

template<class Comp >
void	removeSubComponent (std::shared_ptr< Comp > &component)=delete
	Use removeComponent() on the Manager as opposed to jevois::Component::removeSubComponent()

void	removeComponent (std::string const &instanceName, bool warnIfNotFound=true)
	Remove a top-level Component from the Manager, by instance name.

void	removeSubComponent (std::string const &instanceName, bool warnIfNotFound)=delete
	Use removeComponent() on the Manager as opposed to jevois::Component::removeSubComponent()

template<class Comp = jevois::Component>
std::shared_ptr< Comp >	getComponent (std::string const &instanceName) const
	Get a top-level component by instance name.

template<class Comp >
std::shared_ptr< Comp >	getSubComponent (std::string const &instanceName) const =delete
	Use getComponent() on the Manager as opposed to jevois::Component::getSubComponent()

Manager runtime
std::vector< std::string > const &	remainingArgs () const
	Get the remaining arguments that were not parsed by the command line.

Public Member Functions inherited from jevois::Component
	Component (std::string const &instance)
	Constructor.

virtual	~Component ()
	Virtual destructor for safe inheritance.

template<class Comp , typename... Args>
std::shared_ptr< Comp >	addSubComponent (std::string const &instance, Args &&...args)
	Pseudo-constructor: construct and add another component as a subcomponent of this one.

template<class Comp >
void	removeSubComponent (std::shared_ptr< Comp > &component)
	Remove a sub-Component from this Component, by shared_ptr.

void	removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
	Remove a sub-Component from this Component, by instance name.

template<class Comp = jevois::Component>
std::shared_ptr< Comp >	getSubComponent (std::string const &instance) const
	Get a sub-component by instance name.

bool	isTopLevel () const
	Returns true if this component is top-level, i.e., its parent is jevois::Manager.

bool	initialized () const
	Has this component been initialized yet?

std::string const &	className () const
	The class name of this component.

std::string const &	instanceName () const
	The instance name of this component.

template<typename T >
std::vector< std::string >	setParamVal (std::string const &paramdescriptor, T const &val)
	Set a parameter value.

template<typename T >
void	setParamValUnique (std::string const &paramdescriptor, T const &val)
	Set a parameter value, simple version assuming only one parameter match.

template<typename T >
std::vector< std::pair< std::string, T > >	getParamVal (std::string const &paramdescriptor) const
	Get parameter(s) value(s) by descriptor.

template<typename T >
T	getParamValUnique (std::string const &paramdescriptor) const
	Get a parameter value, simple version assuming only one parameter match.

std::vector< std::string >	setParamString (std::string const &paramdescriptor, std::string const &val)
	Set a parameter value, by string.

void	setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
	Set a parameter value by string, simple version assuming only one parameter match.

std::vector< std::pair< std::string, std::string > >	getParamString (std::string const &paramdescriptor) const
	Get a parameter value, by string.

std::string	getParamStringUnique (std::string const &paramdescriptor) const
	Get a parameter value by string, simple version assuming only one parameter match.

void	freezeParam (std::string const &paramdescriptor, bool doit)
	Freeze/unfreeze a parameter, by name, see ParameterBase::freeze()

void	freezeAllParams (bool doit)
	Freeze all parameters.

std::string	descriptor () const
	Get our full descriptor (including all parents) as [Instancename]:[...]:[...].

void	setParamsFromFile (std::string const &filename)
	Set some parameters from a file.

std::istream &	setParamsFromStream (std::istream &is, std::string const &absfile)
	Set some parameters from an open stream.

virtual void	paramInfo (std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="")
	Get machine-oriented descriptions of all parameters.

void	foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="")
	Run a function on every param we hold.

template<typename T >
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category)
	Add a new parameter after the Component has already been constructed.

template<typename T , template< typename > class ValidValuesSpec>
std::shared_ptr< DynamicParameter< T > >	addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category)
	Add a new parameter after the Component has already been constructed.

template<typename T >
void	setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true)
	Register a callback with a previously created dynamic parameter.

void	removeDynamicParameter (std::string const &name, bool throw_if_not_found=true)
	Remove a previously added dynamic parameter.

void	setPath (std::string const &path)
	Assign a filesystem path to this component.

std::filesystem::path	absolutePath (std::filesystem::path const &path="")
	If given path is relative (not starting with /), prepend the Component path to it.

Public Member Functions inherited from jevois::ParameterRegistry
virtual	~ParameterRegistry ()
	Virtual destructor for safe inheritance.

Protected Member Functions
void	onParamChange (manager::loglevel const &param, manager::LogLevel const &newval) override
	Parameter callback.

void	onParamChange (manager::tracelevel const &param, unsigned int const &newval) override
	Parameter callback.

void	preInit () override
	Calls parseCommandLine()

void	postInit () override
	Checks for the –help flag.

void	constructHelpMessage (std::ostream &out) const
	Constructs a help message from all parameters in the model, and outputs it to 'out'.

void	printHelpMessage () const
	Constructs a help message and tries to send it to /usr/bin/less.

Protected Member Functions inherited from jevois::Component
virtual void	preUninit ()
	Called before all sub-Components are uninit()ed.

virtual void	postUninit ()
	Called after all sub-Components are uninit()ed.

Protected Member Functions inherited from jevois::ParameterRegistry
void	addParameter (ParameterBase *const param)
	The Parameter class uses this method to register itself on construction with its owning Component.

void	removeParameter (ParameterBase *const param)
	The Parameter class uses this method to un-register itself on destruction with its owning Component.

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

Related Symbols
(Note that these are not member symbols.)
	JEVOIS_DECLARE_PARAMETER (help, bool, "Print this help message", false, ParamCateg)
	Parameter.

	JEVOIS_DEFINE_ENUM_CLASS (LogLevel,(fatal)(error)(info)(debug))
	Enum for Parameter.

	JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK (loglevel, LogLevel, "Set the minimum log level to display", LogLevel::info, LogLevel_Values, ParamCateg)
	Parameter.

	JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK (tracelevel, unsigned int, "Set the minimum trace level to display", 0, ParamCateg)
	Parameter.

	JEVOIS_DECLARE_PARAMETER (nickname, std::string, "Nickname associated with this camera, useful when multiple " "JeVois cameras are connected to a same USB bus", "jevois", ParamCateg)
	Parameter.

Constructor & Destructor Documentation

◆ Manager() [1/2]

jevois::Manager::Manager ( std::string const & instance = "TheManager" )

Constructor without command-line args.

The command-line args should be passed later using setArgs(), before you init(), otherwise the manager will issue a non-fatal warning.

Definition at line 27 of file Manager.C.

◆ Manager() [2/2]

jevois::Manager::Manager	(	int	argc,
		char const *	argv[],
		std::string const &	instance = `"TheManager"`
	)

Constructor.

Creates the Manager, and optionally takes in the command line arguments.

Definition at line 32 of file Manager.C.

◆ ~Manager()

jevois::Manager::~Manager ( )

virtual

Destructor.

Definition at line 45 of file Manager.C.

Member Function Documentation

◆ addComponent()

template<class Comp , typename... Args>

std::shared_ptr< Comp > jevois::Manager::addComponent	(	std::string const &	instanceName,
		Args &&...	args
	)

Pseudo-constructor: construct a top-level Component.

A component of type Comp (which must derive from jevois::Component) will be created and added as a sub-component of the manager (making it a so-called top-level component). The child logically "belongs" to the Manager, and will automatically be deleted when the Manager is deleted. In addition to construction, the component will be brought to the same initialized state as the Manager.

◆ addSubComponent()

template<class Comp , typename... Args>

std::shared_ptr< Comp > jevois::Manager::addSubComponent	(	std::string const &	instanceName,
		Args &&...	args
	)

delete

Use addComponent() on the Manager as opposed to jevois::Component::addSubComponent()

◆ constructHelpMessage()

void jevois::Manager::constructHelpMessage ( std::ostream & out ) const

protected

Constructs a help message from all parameters in the model, and outputs it to 'out'.

Definition at line 82 of file Manager.C.

◆ getComponent()

template<class Comp = jevois::Component>

std::shared_ptr< Comp > jevois::Manager::getComponent ( std::string const & instanceName ) const

Get a top-level component by instance name.

This method does a dynamic_pointer_cast to Comp if it is not the default (jevois::Component). Throws if component is not found by instance name, or it is found but not of type Comp (if Comp is specified). Note that once you hold a shared_ptr to a Component, it is guaranteed that the component will not be destroyed until that shared_ptr is released. If the JeVois system tries to destroy the component, e.g., someone calls removeComponent(), the component will be un-initialized and its parent will be unset, so it will not be fully operational, and will be actually deleted when the last shared_ptr to it runs out of scope.

Referenced by jevois::GUIhelper::drawConsole(), jevois::GUIhelper::drawJeVoisGUI(), and jevois::dnn::PostProcessorPose::process().

◆ getSubComponent()

template<class Comp >

std::shared_ptr< Comp > jevois::Manager::getSubComponent ( std::string const & instanceName ) const

delete

Use getComponent() on the Manager as opposed to jevois::Component::getSubComponent()

◆ onParamChange() [1/2]

void jevois::Manager::onParamChange	(	manager::loglevel const &	param,
		manager::LogLevel const &	newval
	)

overrideprotected

Parameter callback.

◆ onParamChange() [2/2]

void jevois::Manager::onParamChange	(	manager::tracelevel const &	param,
		unsigned int const &	newval
	)

overrideprotected

Parameter callback.

◆ postInit()

void jevois::Manager::postInit ( )

overrideprotectedvirtual

Checks for the –help flag.

Reimplemented from jevois::Component.

Definition at line 59 of file Manager.C.

References LINFO.

Referenced by jevois::Engine::postInit().

◆ preInit()

void jevois::Manager::preInit ( )

overrideprotectedvirtual

Calls parseCommandLine()

Reimplemented from jevois::Component.

Definition at line 49 of file Manager.C.

References LERROR.

Referenced by jevois::Engine::preInit().

◆ printHelpMessage()

void jevois::Manager::printHelpMessage ( ) const

protected

Constructs a help message and tries to send it to /usr/bin/less.

Definition at line 76 of file Manager.C.

◆ remainingArgs()

std::vector< std::string > const & jevois::Manager::remainingArgs ( ) const

Get the remaining arguments that were not parsed by the command line.

Any command line arguments after a lone '–' will be available in remainingArgs()

Definition at line 168 of file Manager.C.

◆ removeComponent() [1/2]

template<class Comp >

void jevois::Manager::removeComponent ( std::shared_ptr< Comp > & component )

Remove a top-level Component from the Manager, by shared_ptr.

Note: Beware that the passed shared_ptr is invalidated in the process. A warning is issued if the use_count is not down to zero after that (i.e., there are additional shared_ptr pointers to this Component floating around, which prevent it from actually being deleted.

◆ removeComponent() [2/2]

void jevois::Manager::removeComponent	(	std::string const &	instanceName,
		bool	warnIfNotFound = `true`
	)

Remove a top-level Component from the Manager, by instance name.

Definition at line 172 of file Manager.C.

References LERROR.

◆ removeSubComponent() [1/2]

template<class Comp >

void jevois::Manager::removeSubComponent ( std::shared_ptr< Comp > & component )

delete

Use removeComponent() on the Manager as opposed to jevois::Component::removeSubComponent()

◆ removeSubComponent() [2/2]

void jevois::Manager::removeSubComponent	(	std::string const &	instanceName,
		bool	warnIfNotFound
	)

delete

Use removeComponent() on the Manager as opposed to jevois::Component::removeSubComponent()

◆ setCommandLineArgs()

void jevois::Manager::setCommandLineArgs	(	int	argc,
		char const *	argv[]
	)

Set the command-line arguments, call this before start() if args were not passed at construction.

Definition at line 38 of file Manager.C.

Friends And Related Symbol Documentation

◆ JEVOIS_DECLARE_PARAMETER() [1/2]

JEVOIS_DECLARE_PARAMETER	(	help	,
		bool	,
		"Print this help message"	,
		false	,
		ParamCateg
	)

◆ JEVOIS_DECLARE_PARAMETER() [2/2]

JEVOIS_DECLARE_PARAMETER	(	nickname	,
		std::string	,
		"Nickname associated with this	camera,
		useful when multiple " "JeVois cameras are connected to a same USB bus"	,
		"jevois"	,
		ParamCateg
	)

◆ JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK() [1/2]

JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK	(	loglevel	,
		LogLevel	,
		"Set the minimum log level to display"	,
		LogLevel::info	,
		LogLevel_Values	,
		ParamCateg
	)

◆ JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK() [2/2]

JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK	(	tracelevel	,
		unsigned int	,
		"Set the minimum trace level to display"	,
		0	,
		ParamCateg
	)

◆ JEVOIS_DEFINE_ENUM_CLASS()

JEVOIS_DEFINE_ENUM_CLASS	(	LogLevel	,
		(fatal)(error)(info)(debug)
	)

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

include/jevois/Component/Manager.H
src/jevois/Component/Manager.C

Public Member Functions

Protected Member Functions

Related Symbols

Constructor & Destructor Documentation

◆ Manager() [1/2]

◆ Manager() [2/2]

◆ ~Manager()

Member Function Documentation

◆ addComponent()

◆ addSubComponent()

◆ constructHelpMessage()

◆ getComponent()

◆ getSubComponent()

◆ onParamChange() [1/2]

◆ onParamChange() [2/2]

◆ postInit()

◆ preInit()

◆ printHelpMessage()

◆ remainingArgs()

◆ removeComponent() [1/2]

◆ removeComponent() [2/2]

◆ removeSubComponent() [1/2]

◆ removeSubComponent() [2/2]

◆ setCommandLineArgs()

Friends And Related Symbol Documentation

◆ JEVOIS_DECLARE_PARAMETER() [1/2]

◆ JEVOIS_DECLARE_PARAMETER() [2/2]

◆ JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK() [1/2]

◆ JEVOIS_DECLARE_PARAMETER_WITH_CALLBACK() [2/2]

◆ JEVOIS_DEFINE_ENUM_CLASS()