Special info parameter class. More...

#include <dabc/Parameter.h>

Inheritance diagram for dabc::InfoParameter:

Public Member Functions
std::string	GetColor () const

std::string	GetInfo () const

int	GetVerbosity () const

void	SetColor (const std::string &name)

void	SetInfo (const std::string &info)

void	SetVerbosity (int level)

Public Member Functions inherited from dabc::Parameter
bool	Dflt (const RecordField &v)
	Set default parameter value. More...

Parameter &	DisableAverage ()
	Disables averaging functionality. More...

Parameter &	DisableRatemeter ()
	Disable ratemeter functionality. More...

void	FireModified ()
	Can be called by user to signal framework that parameter was modified. More...

const std::string	GetActualUnits () const
	Return actual units of parameter value, taking into account rate (1/s) unit when enabled. More...

int	GetDebugLevel () const

double	GetLowerLimit () const

const std::string	GetUnits () const
	Return units of parameter value. More...

double	GetUpperLimit () const

Reference	GetWorker () const
	Returns reference on the worker. More...

bool	IsAverage () const
	Returns true if average calculation is active. More...

bool	IsMonitored ()
	Returns true when parameter event should be delivered to the worker. More...

bool	IsRatemeter () const
	Returns true if rate measurement is activated. More...

const std::string	Kind () const

bool	NeedTimeout ()
	Returns true if parameter object requires timeout processing. More...

void	ScanParamFields (RecordFieldsMap *cont)

Parameter &	SetAverage (bool synchron=false, double interval=1.0)
	Converts parameter in statistic variable. More...

Parameter &	SetDebugLevel (int level=1)

Parameter &	SetDebugOutput (bool on=true, int level=1)
	Enable/disable debug output when parameter value is changed. More...

Parameter &	SetFld (const std::string &name, const RecordField &v)

Parameter &	SetLimits (double low, double up)

void	SetLowerLimit (double low)

Parameter &	SetMonitored (bool on=true)
	Specify if parameter event should be delivered to the worker. More...

Parameter &	SetRatemeter (bool synchron=false, double interval=1.0)
	Converts parameter in ratemeter - all values will be summed up and divided on specified interval. More...

Parameter &	SetSynchron (bool on, double interval=1., bool everyevnt=false)
	Indicate if parameter is should generate events synchron with code which modified it. More...

Parameter &	SetUnits (const std::string &unit)
	Set units field of parameter. More...

void	SetUpperLimit (double up)

bool	SetValue (const RecordField &v)
	Set parameter value. More...

Parameter &	SetWidthPrecision (unsigned width, unsigned prec)
	Set parameter to convert double values to the string - used for ratemeter. More...

bool	SubmitSetValue (const RecordField &v)

RecordField	Value () const
	Returns parameter value. More...

Public Member Functions inherited from dabc::Reference
bool	AddChild (Object *obj)
	Add child to list of object children. More...

const char *	ClassName () const
	Return class name of referenced object, if object not assigned, returns "---". More...

void	Destroy () throw ()
	Release reference and starts destroyment of referenced object. More...

Reference	FindChild (const char *name) const
	Searches for child in referenced object. More...

bool	GetAllChildRef (ReferencesVector *vect) const
	Return references for all childs. More...

Reference	GetChild (unsigned n) const
	Return reference on child n. More...

Reference	GetFolder (const std::string &name, bool force=false) throw ()
	Return folder of specified name, no special symbols are allowed. More...

const char *	GetName () const
	Return name of referenced object, if object not assigned, returns "---". More...

Object *	GetObject () const
	Return pointer on the object. More...

Object *	GetParent () const
	Returns pointer on parent object. More...

Reference	GetParentRef () const
	Returns reference on parent object. More...

bool	IsName (const char *name) const
	Returns true if object name is the same as specified one. More...

std::string	ItemName (bool compact=true) const
	Produce string, which can be used as name argument in dabc::mgr.FindItem(name) call. More...

bool	null () const
	Returns true if reference contains nullptr. More...

unsigned	NumChilds () const
	Return number of childs in referenced object. More...

unsigned	NumReferences () const
	Returns number of references on the object. More...

bool	operator! () const
	Returns true if reference contains nullptr. More...

bool	operator!= (const Reference &src) const
	Compare operator - return true if references refer to different object. More...

bool	operator!= (Object *obj) const
	Compare operator - return true if reference refer to different objects. More...

Object *	operator() () const
	Return pointer on the object. More...

Reference &	operator<< (Reference &src) throw ()
	Move operator - reference moved from source to target. More...

Reference &	operator= (const Reference &src) throw ()
	Assignment operator - copy reference. More...

Reference &	operator= (Object *obj) throw ()
	Assignment operator - copy reference. More...

bool	operator== (const Reference &src) const
	Compare operator - return true if references refer to same object. More...

bool	operator== (Object *obj) const
	Compare operator - return true if reference refer to same object. More...

void	Print (int lvl=0, const char *from=0) const
	Show on debug output content of reference. More...

	Reference (const Reference &src) throw ()
	Copy constructor, if source is transient than source reference will be emptied. More...

	Reference (Object *obj=nullptr)
	Constructor, creates reference on the object. More...

std::string	RelativeName (const dabc::Reference &topitem)
	Produce name, which can be used to find item, calling topitem.FindChild(). More...

void	Release () throw ()
	Releases reference on the object. More...

bool	RemoveChild (const char *name, bool cleanup=true)
	Remove child with given name and return reference on that child. More...

bool	RemoveChilds (bool cleanup=true)
	Remove all childs in referenced object If cleanup true (default) and object is owner, all objects will be destroyed. More...

void	SetAutoDestroy (bool on=true)
	Set autodestroy flag for the object Once enabled, object will be destroyed when last reference will be cleared. More...

void	SetObject (Object *obj, bool withmutex=true)
	Direct set of object to reference. More...

Reference	Take ()
	Copy reference to output object. More...

virtual	~Reference ()
	Destructor, releases reference on the object. More...

Static Public Member Functions
static const char *	infokind ()

Protected Member Functions
virtual const char *	ParReferenceKind ()

Protected Member Functions inherited from dabc::Parameter
int	ExecuteChange (Command cmd)
	Specifies that parameter produce 'modified' events synchronous with changes of parameter. More...

void	FireConfigured ()
	Fire parConfigured event for parameter. More...

bool	TakeAttrModified ()
	Returns true if any parameter attribute was modified since last call to this method. More...

template<class T >
bool	verify_object (Object src, T &tgt)
	Method used in reference constructor/assignments to verify is object is suitable. More...

Protected Member Functions inherited from dabc::Reference
bool	AcquireRefWithoutMutex (Reference &ref)
	Special method, which allows to generate new reference when object mutex is locked. More...

void	Assign (const Reference &src)
	Method used in copy constructor and assigned operations. More...

Mutex *	ObjectMutex () const

template<class T >
bool	verify_object (Object src, T &tgt)
	Method used in reference constructor/assignments to verify is object is suitable. More...

Additional Inherited Members
Protected Attributes inherited from dabc::Reference
Object *	fObj
	pointer on the object More...

Detailed Description

Special info parameter class.

This parameter class can only be used with parameters, created with CreatePar(name, "info") call

Definition at line 300 of file Parameter.h.

Member Function Documentation

◆ ParReferenceKind()

virtual const char* dabc::InfoParameter::ParReferenceKind ( )

inlineprotectedvirtual

Reimplemented from dabc::Parameter.

Definition at line 304 of file Parameter.h.

◆ SetInfo()

void dabc::InfoParameter::SetInfo ( const std::string & info )

inline

Definition at line 310 of file Parameter.h.

◆ GetInfo()

std::string dabc::InfoParameter::GetInfo ( ) const

inline

Definition at line 311 of file Parameter.h.

◆ SetColor()

void dabc::InfoParameter::SetColor ( const std::string & name )

inline

Definition at line 313 of file Parameter.h.

◆ GetColor()

std::string dabc::InfoParameter::GetColor ( ) const

inline

Definition at line 314 of file Parameter.h.

◆ SetVerbosity()

void dabc::InfoParameter::SetVerbosity ( int level )

inline

Definition at line 316 of file Parameter.h.

◆ GetVerbosity()

int dabc::InfoParameter::GetVerbosity ( ) const

inline

Definition at line 317 of file Parameter.h.

◆ infokind()

static const char* dabc::InfoParameter::infokind ( )

inlinestatic

Definition at line 319 of file Parameter.h.

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

base/dabc/Parameter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ParReferenceKind()

◆ SetInfo()

◆ GetInfo()

◆ SetColor()

◆ GetColor()

◆ SetVerbosity()

◆ GetVerbosity()

◆ infokind()