vistle::ParameterManager Class Reference

#include <core/parametermanager.h>

Inheritance diagram for vistle::ParameterManager:

Public Member Functions
	ParameterManager (const std::string &name, int id)
virtual	~ParameterManager ()
void	setCurrentParameterGroup (const std::string &group=std::string())
	set group for all subsequently added parameters, reset with empty group More...
const std::string &	currentParameterGroup () const
virtual Parameter *	addParameterGeneric (const std::string &name, std::shared_ptr< Parameter > parameter)
bool	updateParameter (const std::string &name, const Parameter *parameter, const message::SetParameter *inResponseTo, Parameter::RangeType rt=Parameter::Value)
template<class T >
Parameter *	addParameter (const std::string &name, const std::string &description, const T &value, Parameter::Presentation presentation=Parameter::Generic)
template<class T >
bool	setParameter (const std::string &name, const T &value, const message::SetParameter *inResponseTo=nullptr)
template<class T >
bool	setParameter (ParameterBase< T > *param, const T &value, const message::SetParameter *inResponseTo=nullptr)
template<class T >
bool	setParameterMinimum (ParameterBase< T > *param, const T &minimum)
template<class T >
bool	setParameterMaximum (ParameterBase< T > *param, const T &maximum)
template<class T >
bool	setParameterRange (const std::string &name, const T &minimum, const T &maximum)
template<class T >
bool	setParameterRange (ParameterBase< T > *param, const T &minimum, const T &maximum)
template<class T >
bool	getParameter (const std::string &name, T &value) const
void	setParameterChoices (const std::string &name, const std::vector< std::string > &choices)
void	setParameterChoices (Parameter *param, const std::vector< std::string > &choices)
void	setParameterFilters (const std::string &name, const std::string &filters)
void	setParameterFilters (StringParameter *param, const std::string &filters)
StringParameter *	addStringParameter (const std::string &name, const std::string &description, const std::string &value, Parameter::Presentation p=Parameter::Generic)
bool	setStringParameter (const std::string &name, const std::string &value, const message::SetParameter *inResponseTo=NULL)
std::string	getStringParameter (const std::string &name) const
FloatParameter *	addFloatParameter (const std::string &name, const std::string &description, const Float value)
bool	setFloatParameter (const std::string &name, const Float value, const message::SetParameter *inResponseTo=NULL)
Float	getFloatParameter (const std::string &name) const
IntParameter *	addIntParameter (const std::string &name, const std::string &description, const Integer value, Parameter::Presentation p=Parameter::Generic)
bool	setIntParameter (const std::string &name, const Integer value, const message::SetParameter *inResponseTo=NULL)
Integer	getIntParameter (const std::string &name) const
VectorParameter *	addVectorParameter (const std::string &name, const std::string &description, const ParamVector &value)
bool	setVectorParameter (const std::string &name, const ParamVector &value, const message::SetParameter *inResponseTo=NULL)
ParamVector	getVectorParameter (const std::string &name) const
IntVectorParameter *	addIntVectorParameter (const std::string &name, const std::string &description, const IntParamVector &value)
bool	setIntVectorParameter (const std::string &name, const IntParamVector &value, const message::SetParameter *inResponseTo=NULL)
IntParamVector	getIntVectorParameter (const std::string &name) const
bool	removeParameter (const std::string &name)
virtual bool	removeParameter (Parameter *param)
std::shared_ptr< Parameter >	findParameter (const std::string &name) const
void	init ()
void	quit ()
bool	handleMessage (const message::SetParameter &message)
virtual void	sendParameterMessage (const message::Message &message, const buffer *payload=nullptr) const =0
template<class Payload >
void	sendParameterMessageWithPayload (message::Message &message, Payload &payload)
virtual bool	changeParameters (std::set< const Parameter * > params)
virtual bool	changeParameter (const Parameter *p)
void	setId (int id)
int	id () const
void	setName (const std::string &name)
void	applyDelayedChanges ()

Constructor & Destructor Documentation

ParameterManager()

vistle::ParameterManager::ParameterManager	(	const std::string &	name,
		int	id
	)

~ParameterManager()

vistle::ParameterManager::~ParameterManager ( )

virtual

Member Function Documentation

addFloatParameter()

FloatParameter * vistle::ParameterManager::addFloatParameter	(	const std::string &	name,
		const std::string &	description,
		const Float	value
	)

addIntParameter()

IntParameter * vistle::ParameterManager::addIntParameter	(	const std::string &	name,
		const std::string &	description,
		const Integer	value,
		Parameter::Presentation	p = Parameter::Generic
	)

addIntVectorParameter()

IntVectorParameter * vistle::ParameterManager::addIntVectorParameter	(	const std::string &	name,
		const std::string &	description,
		const IntParamVector &	value
	)

addParameter()

template<class T >

Parameter * vistle::ParameterManager::addParameter	(	const std::string &	name,
		const std::string &	description,
		const T &	value,
		Parameter::Presentation	presentation = Parameter::Generic
	)

addParameterGeneric()

Parameter * vistle::ParameterManager::addParameterGeneric ( const std::string &  name, std::shared_ptr< Parameter >  parameter  )

virtual

Reimplemented in vistle::Module.

addStringParameter()

StringParameter * vistle::ParameterManager::addStringParameter	(	const std::string &	name,
		const std::string &	description,
		const std::string &	value,
		Parameter::Presentation	p = Parameter::Generic
	)

addVectorParameter()

VectorParameter * vistle::ParameterManager::addVectorParameter	(	const std::string &	name,
		const std::string &	description,
		const ParamVector &	value
	)

applyDelayedChanges()

void vistle::ParameterManager::applyDelayedChanges

(

)

changeParameter()

bool vistle::ParameterManager::changeParameter ( const Parameter *  p )

virtual

Reimplemented in vistle::Module, and vistle::Reader.

changeParameters()

bool vistle::ParameterManager::changeParameters ( std::set< const Parameter * >  params )

virtual

Reimplemented in vistle::Reader.

currentParameterGroup()

const std::string & vistle::ParameterManager::currentParameterGroup

(

)

const

findParameter()

std::shared_ptr< Parameter > vistle::ParameterManager::findParameter

(

const std::string &

name

)

const

getFloatParameter()

Float vistle::ParameterManager::getFloatParameter

(

const std::string &

name

)

const

getIntParameter()

Integer vistle::ParameterManager::getIntParameter

(

const std::string &

name

)

const

getIntVectorParameter()

IntParamVector vistle::ParameterManager::getIntVectorParameter

(

const std::string &

name

)

const

getParameter()

template<class T >

bool vistle::ParameterManager::getParameter	(	const std::string &	name,
		T &	value
	)		const

getStringParameter()

std::string vistle::ParameterManager::getStringParameter

(

const std::string &

name

)

const

getVectorParameter()

ParamVector vistle::ParameterManager::getVectorParameter

(

const std::string &

name

)

const

handleMessage()

bool vistle::ParameterManager::handleMessage

(

const message::SetParameter &

message

)

id()

int vistle::ParameterManager::id

(

)

const

init()

void vistle::ParameterManager::init

(

)

quit()

void vistle::ParameterManager::quit

(

)

removeParameter() [1/2]

bool vistle::ParameterManager::removeParameter

(

const std::string &

name

)

removeParameter() [2/2]

bool vistle::ParameterManager::removeParameter ( Parameter *  param )

virtual

Reimplemented in vistle::Module.

sendParameterMessage()

virtual void vistle::ParameterManager::sendParameterMessage ( const message::Message &  message, const buffer *  payload = nullptr  ) const

pure virtual

Implemented in vistle::Module.

sendParameterMessageWithPayload()

template<class Payload >

void vistle::ParameterManager::sendParameterMessageWithPayload	(	message::Message &	message,
		Payload &	payload
	)

setCurrentParameterGroup()

void vistle::ParameterManager::setCurrentParameterGroup

(

const std::string &

group = std::string()

)

set group for all subsequently added parameters, reset with empty group

setFloatParameter()

bool vistle::ParameterManager::setFloatParameter	(	const std::string &	name,
		const Float	value,
		const message::SetParameter *	inResponseTo = NULL
	)

setId()

void vistle::ParameterManager::setId

(

int

id

)

setIntParameter()

bool vistle::ParameterManager::setIntParameter	(	const std::string &	name,
		const Integer	value,
		const message::SetParameter *	inResponseTo = NULL
	)

setIntVectorParameter()

bool vistle::ParameterManager::setIntVectorParameter	(	const std::string &	name,
		const IntParamVector &	value,
		const message::SetParameter *	inResponseTo = NULL
	)

setName()

void vistle::ParameterManager::setName

(

const std::string &

name

)

setParameter() [1/2]

template<class T >

bool vistle::ParameterManager::setParameter	(	const std::string &	name,
		const T &	value,
		const message::SetParameter *	inResponseTo = nullptr
	)

setParameter() [2/2]

template<class T >

bool vistle::ParameterManager::setParameter	(	ParameterBase< T > *	param,
		const T &	value,
		const message::SetParameter *	inResponseTo = nullptr
	)

setParameterChoices() [1/2]

void vistle::ParameterManager::setParameterChoices	(	const std::string &	name,
		const std::vector< std::string > &	choices
	)

setParameterChoices() [2/2]

void vistle::ParameterManager::setParameterChoices	(	Parameter *	param,
		const std::vector< std::string > &	choices
	)

setParameterFilters() [1/2]

void vistle::ParameterManager::setParameterFilters	(	const std::string &	name,
		const std::string &	filters
	)

setParameterFilters() [2/2]

void vistle::ParameterManager::setParameterFilters	(	StringParameter *	param,
		const std::string &	filters
	)

setParameterMaximum()

template<class T >

bool vistle::ParameterManager::setParameterMaximum	(	ParameterBase< T > *	param,
		const T &	maximum
	)

setParameterMinimum()

template<class T >

bool vistle::ParameterManager::setParameterMinimum	(	ParameterBase< T > *	param,
		const T &	minimum
	)

setParameterRange() [1/2]

template<class T >

bool vistle::ParameterManager::setParameterRange	(	const std::string &	name,
		const T &	minimum,
		const T &	maximum
	)

setParameterRange() [2/2]

template<class T >

bool vistle::ParameterManager::setParameterRange	(	ParameterBase< T > *	param,
		const T &	minimum,
		const T &	maximum
	)

setStringParameter()

bool vistle::ParameterManager::setStringParameter	(	const std::string &	name,
		const std::string &	value,
		const message::SetParameter *	inResponseTo = NULL
	)

setVectorParameter()

bool vistle::ParameterManager::setVectorParameter	(	const std::string &	name,
		const ParamVector &	value,
		const message::SetParameter *	inResponseTo = NULL
	)

updateParameter()

bool vistle::ParameterManager::updateParameter	(	const std::string &	name,
		const Parameter *	parameter,
		const message::SetParameter *	inResponseTo,
		Parameter::RangeType	rt = Parameter::Value
	)

---

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

• core/parametermanager.h
• core/parametermanager.cpp
• core/parametermanager_impl.h