VisualBufferConfigurator Class Reference

VisualBuffer configurator. More...

#include <Neuro/VisualBuffer.H>

Inheritance diagram for VisualBufferConfigurator:

[legend]

Collaboration diagram for VisualBufferConfigurator:

[legend]

List of all members.

Public Member Functions
	VisualBufferConfigurator (OptionManager &mgr, const std::string &descrName="Visual Buffer Configurator", const std::string &tagName="VisualBufferConfigurator")
	Constructor.
virtual	~VisualBufferConfigurator ()
	destructor
nub::ref< VisualBuffer >	getVB () const
	Get the chosen VB.
Protected Member Functions
virtual void	paramChanged (ModelParamBase *const param, const bool valueChanged, ParamClient::ChangeStatus *status)
	Intercept people changing our ModelParam.
Protected Attributes
OModelParam< std::string >	itsVBtype
	type of buffer

---

Detailed Description

VisualBuffer configurator.

This will export the --vb-type=XX command-line option and will instantiate a VisualBuffer of the desired type as the option gets assigned a value. As this happens, new options may become available in the command-line. To see them, use --help AFTER you have chosen the type to use. The current VB may be retrieved using getVB().

Definition at line 93 of file VisualBuffer.H.

---

Constructor & Destructor Documentation

VisualBufferConfigurator::VisualBufferConfigurator	(	OptionManager &	mgr,
		const std::string &	descrName = "Visual Buffer Configurator",
		const std::string &	tagName = "VisualBufferConfigurator"
	)

Constructor.

Definition at line 78 of file VisualBuffer.C.

References ModelComponent::addSubComponent().

VisualBufferConfigurator::~VisualBufferConfigurator

(

)

[virtual]

destructor

Definition at line 89 of file VisualBuffer.C.

---

Member Function Documentation

nub::ref< VisualBuffer > VisualBufferConfigurator::getVB

(

)

const

Get the chosen VB.

You should call this during start() of the ModelComponent that needs the VB. NOTE: this will never return a null pointer (since it's a nub::ref rather than a nub::soft_ref), but it may return a "stub" object (e.g. VisualBufferStub).

Definition at line 93 of file VisualBuffer.C.

void VisualBufferConfigurator::paramChanged	(	ModelParamBase *const	param,
		const bool	valueChanged,
		ParamClient::ChangeStatus *	status
	)			[protected, virtual]

Intercept people changing our ModelParam.

See ModelComponent.H; as parsing the command-line or reading a config file sets our name, we'll also here instantiate a buffer of the proper type (and export its options)

Reimplemented from ModelComponent.

Definition at line 99 of file VisualBuffer.C.

References ModelComponent::addSubComponent(), ModelComponent::getManager(), OModelParam< T >::getVal(), itsVBtype, MC_RECURSE, ModelComponent::removeSubComponent(), and nub::ref< T >::reset().

---

Member Data Documentation

OModelParam<std::string> VisualBufferConfigurator::itsVBtype [protected]

type of buffer

Definition at line 112 of file VisualBuffer.H.

Referenced by paramChanged().

---

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

• src/Neuro/VisualBuffer.H
• src/Neuro/VisualBuffer.C