Attrib::BinIDParam Class Reference

A parameter that is used by an attribute. More...

Inheritance diagram for Attrib::BinIDParam:

Public Member Functions
	BinIDParam (const char *)
	BinIDParam (const char *, const BinID &, bool isreq=true)
	~BinIDParam ()
BinIDParam *	clone () const override
bool	getCompositeValue (BufferString &) const override
BinID	getDefaultBinIDValue () const
BufferString	getDefaultValue () const override
BinID	getValue () const
bool	setCompositeValue (const char *) override
void	setDefaultValue (const BinID &)
void	setLimits (const Interval< int > &inlrg, const Interval< int > &crlrg)
void	setLimits (int mininl, int maxinl, int mincrl, int maxcrl)
void	toString (BufferString &, const BinID &) const
Public Member Functions inherited from Attrib::ValParam
	ValParam (const char *key, DataInpSpec *)
	ValParam (const ValParam &)
virtual	~ValParam ()
ValParam *	clone () const override
void	fillDefStr (BufferString &) const override
bool	getBoolValue (int idx=0) const
bool	getCompositeValue (BufferString &) const override
bool	getDefaultBoolValue (int idx=0) const
virtual double	getDefaultdValue (int idx=0) const
virtual float	getDefaultfValue (int idx=0) const
virtual int	getDefaultIntValue (int idx=0) const
const char *	getDefaultStringValue (int idx=0) const
BufferString	getDefaultValue () const override
virtual double	getDValue (int idx=0) const
double	getdValue (int idx=0) const
virtual float	getFValue (int idx=0) const
float	getfValue (int idx=0) const
virtual int	getIntValue (int idx=0) const
DataInpSpec *	getSpec ()
const DataInpSpec *	getSpec () const
const char *	getStringValue (int idx=0) const
bool	isOK () const override
int	nrValues () const
bool	setCompositeValue (const char *) override
void	setDefaultValue (bool, int idx=0)
void	setDefaultValue (const char *, int idx=0)
void	setDefaultValue (double, int idx=0)
void	setDefaultValue (float, int idx=0)
void	setDefaultValue (int, int idx=0)
void	setValue (bool, int idx=0)
void	setValue (const char *, int idx=0)
void	setValue (const MultiID &, int idx=0)
void	setValue (double, int idx=0)
void	setValue (float, int idx=0)
void	setValue (int, int idx=0)
Public Member Functions inherited from Attrib::Param
virtual	~Param ()
StringView	getKey () const
bool	isEnabled () const
bool	isGroup () const
bool	isRequired () const
bool	operator!= (const Param &p) const
bool	operator== (const Param &p) const
void	setEnabled (bool yn=true)
void	setKey (const char *newkey)
void	setRequired (bool yn=true)
virtual bool	setValues (BufferStringSet &)

Additional Inherited Members
Protected Member Functions inherited from Attrib::ValParam
bool	isEqual (const Param &) const override
Protected Member Functions inherited from Attrib::Param
	Param (const char *key)
	Param (const Param &)
bool	_isEqual (const Param &p) const
Protected Attributes inherited from Attrib::ValParam
DataInpSpec *	spec_
Protected Attributes inherited from Attrib::Param
bool	enabled_
bool	isgroup_
BufferString	key_
bool	required_

Detailed Description

A parameter that is used by an attribute.

Each attribute has a definition string that defines how the attribute is computed. The definition string has the format:

AttribNameWithoutSpaces param1=value1 param2=value2,value3

The paramater thus has a key (e.g. param1) and one or more associated values.

Subclasses are used to provide accurate parameter definition for parameters of each and every type.

<>

Constructor & Destructor Documentation

BinIDParam() [1/2]

Attrib::BinIDParam::BinIDParam

(

const char *

)

BinIDParam() [2/2]

Attrib::BinIDParam::BinIDParam	(	const char *	,
		const BinID &	,
		bool	isreq = true
	)

~BinIDParam()

Attrib::BinIDParam::~BinIDParam

(

)

Member Function Documentation

clone()

BinIDParam* Attrib::BinIDParam::clone ( ) const

overridevirtual

Implements Attrib::Param.

getCompositeValue()

bool Attrib::BinIDParam::getCompositeValue ( BufferString &  ) const

overridevirtual

Put all values into one string.

Implements Attrib::Param.

getDefaultBinIDValue()

BinID Attrib::BinIDParam::getDefaultBinIDValue

(

)

const

getDefaultValue()

BufferString Attrib::BinIDParam::getDefaultValue ( ) const

overridevirtual

Reimplemented from Attrib::Param.

getValue()

BinID Attrib::BinIDParam::getValue

(

)

const

setCompositeValue()

bool Attrib::BinIDParam::setCompositeValue ( const char *  )

overridevirtual

Set all values from one composite string.

Reimplemented from Attrib::Param.

setDefaultValue()

void Attrib::BinIDParam::setDefaultValue

(

const BinID &

)

setLimits() [1/2]

void Attrib::BinIDParam::setLimits	(	const Interval< int > &	inlrg,
		const Interval< int > &	crlrg
	)

setLimits() [2/2]

void Attrib::BinIDParam::setLimits	(	int	mininl,
		int	maxinl,
		int	mincrl,
		int	maxcrl
	)

toString()

void Attrib::BinIDParam::toString	(	BufferString &	,
		const BinID &
	)		const