BeanLike Class Reference

Something which has a name, a description and possibly some parameters of varying type. More...

#include <BeanLike.h>

Inheritance diagram for BeanLike:

Collaboration diagram for BeanLike:

Public Types
typedef ReferenceMap	map_t

Public Member Functions
	BeanLike (const BeanLike &b)
	BeanLike (const std::string &name, const std::string &description="")
virtual const std::string &	getName () const
	Return the name of an instance.
virtual const std::string &	getDescription () const
	Return a brief description.
bool	hasParameters () const
template<class F >
F	getParameter (const std::string &p) const
	Gets a single parameter.
const map_t &	getParameters () const
map_t &	getParameters ()
template<class F >
void	setParametersFromEntries (const F &args)
void	setParameters (std::initializer_list< Variable::init_pair_t > args)
	Grants access to (if above hidden)
virtual void	setParameters (const std::string &p, char assignmentSymbol='=', char separatorSymbol=0)
	Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2".
template<class T >
void	setParameters (const std::map< std::string, T > &args)
	Set parameters.
template<class T >
void	setParameters (const SmartMap< T > &args)
	Set parameters.
void	setParameter (const std::string &p, const Castable &value)
	Sets a single parameter.
template<class T >
void	setParameter (const std::string &p, const VariableT< T > &value)
template<class F >
void	setParameter (const std::string &p, const F &value)
	Sets a single parameter.
template<class F >
void	setParameter (const std::string &p, std::initializer_list< F > value)
	Sets a single parameter.
BeanLike &	operator= (const BeanLike &b)
virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const

Protected Member Functions
virtual void	storeLastArguments (const std::string &p)
	Called after setParameters()
virtual void	updateBean () const
	Called after setParameters()

Protected Attributes
const std::string	name
const std::string	description
map_t	parameters

Detailed Description

Something which has a name, a description and possibly some parameters of varying type.

The parameters are local variables (properties) linked by a ReferenceMap .

drain::Command's and drain::image::ImageOp's are typical BeanLikes.

Member Function Documentation

getDescription()

virtual const std::string & getDescription ( ) const

inlinevirtual

Return a brief description.

Reimplemented in ImpulseResponseOpBase< T >.

getName()

virtual const std::string & getName ( ) const

inlinevirtual

Return the name of an instance.

Reimplemented in ImpulseResponseOpBase< T >, BlenderOp, FlowAverageOp, GaussianAverageOp, SlidingWindowOp< W >, SlidingWindowOp< FlowAverageWindowWeighted >, SlidingWindowOp< SlidingOpticalFlowWeighted >, SlidingWindowOp< SlidingOpticalFlowWeighted2 >, SlidingWindowOp< SlidingWindowHistogramWeighted >, SlidingWindowOp< SlidingWindowMedianWeighted >, WindowOp< W >, WindowOp< FlowAverageWindowWeighted >, WindowOp< GaussianStripe< WindowCore > >, WindowOp< SlidingOpticalFlowWeighted >, WindowOp< SlidingOpticalFlowWeighted2 >, WindowOp< SlidingWindowHistogramWeighted >, WindowOp< SlidingWindowMedianWeighted >, WindowOp< W >, WindowOp< Window< GaussianWindowConf > >, and WindowOp< Window< WindowConfig > >.

setParameter() [1/2]

template<class F >

void setParameter ( const std::string &  p, const F &  value  )

inline

Sets a single parameter.

Sets a single parameter

setParameter() [2/2]

template<class T >

void setParameter ( const std::string &  p, const VariableT< T > &  value  )

inline

TODO: consider VariableLike Sets a single parameter

setParameters()

virtual void setParameters ( const std::string &  p, char  assignmentSymbol = '=', char  separatorSymbol = 0  )

inlinevirtual

Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2".

This function is virtual because derived classes may redefine it to update str members.

storeLastArguments()

virtual void storeLastArguments ( const std::string &  p )

inlineprotectedvirtual

Called after setParameters()

Reimplemented in ProductBase.

updateBean()

virtual void updateBean ( ) const

inlineprotectedvirtual

Called after setParameters()

Reimplemented in DataSelector, DataSelector, WeightedAverageMethod, DistanceModel, Functor, FuzzyStep< T >, FuzzyStep< double >, FuzzyTriangle< T >, FuzzyBell< T >, FuzzyBell< double >, FuzzyBell2< T >, FuzzyBell2< double >, FuzzyStepsoid< T >, FuzzyTwinPeaks< T >, and PrecipZ.

---

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

• src/drain/util/BeanLike.h
• src/drain/util/BeanLike.cpp