Attrib::Param Class Reference

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

Inheritance diagram for Attrib::Param:

Public Member Functions
virtual	~Param ()
virtual Param *	clone () const =0
virtual void	fillDefStr (BufferString &) const =0
virtual bool	getCompositeValue (BufferString &) const =0
virtual BufferString	getDefaultValue () const
StringView	getKey () const
bool	isEnabled () const
bool	isGroup () const
virtual bool	isOK () const =0
bool	isRequired () const
bool	operator!= (const Param &p) const
bool	operator== (const Param &p) const
virtual bool	setCompositeValue (const char *)
void	setEnabled (bool yn=true)
void	setKey (const char *newkey)
void	setRequired (bool yn=true)
virtual bool	setValues (BufferStringSet &)

Protected Member Functions
	Param (const char *key)
	Param (const Param &)
bool	_isEqual (const Param &p) const
virtual bool	isEqual (const Param &) const =0

Protected Attributes
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 parameter thus has a key (e.g. param1) and one or more associated values.

<>

Constructor & Destructor Documentation

~Param()

virtual Attrib::Param::~Param ( )

virtual

Param() [1/2]

Attrib::Param::Param ( const char *  key )

protected

Param() [2/2]

Attrib::Param::Param ( const Param &  )

protected

Member Function Documentation

_isEqual()

bool Attrib::Param::_isEqual ( const Param &  p ) const

inlineprotected

clone()

virtual Param* Attrib::Param::clone ( ) const

pure virtual

Implemented in Attrib::ParamGroup< PT >, Attrib::ValParam, Attrib::SeisStorageRefParam, Attrib::NumGateParam< T >, Attrib::NumParam< T >, Attrib::StringParam, Attrib::EnumParam, Attrib::BoolParam, and Attrib::BinIDParam.

fillDefStr()

virtual void Attrib::Param::fillDefStr ( BufferString &  ) const

pure virtual

Implemented in Attrib::ParamGroup< PT >, Attrib::ValParam, and Attrib::EnumParam.

getCompositeValue()

virtual bool Attrib::Param::getCompositeValue ( BufferString &  ) const

pure virtual

Put all values into one string.

Implemented in Attrib::NumGateParam< T >, Attrib::NumParam< T >, Attrib::ParamGroup< PT >, Attrib::ValParam, Attrib::StringParam, and Attrib::BinIDParam.

getDefaultValue()

virtual BufferString Attrib::Param::getDefaultValue ( ) const

inlinevirtual

Reimplemented in Attrib::ValParam, Attrib::NumGateParam< T >, Attrib::NumParam< T >, Attrib::StringParam, Attrib::EnumParam, Attrib::BoolParam, and Attrib::BinIDParam.

getKey()

StringView Attrib::Param::getKey ( ) const

inline

isEnabled()

bool Attrib::Param::isEnabled ( ) const

inline

isEqual()

virtual bool Attrib::Param::isEqual ( const Param &  ) const

protectedpure virtual

Implemented in Attrib::ParamGroup< PT >, and Attrib::ValParam.

isGroup()

bool Attrib::Param::isGroup ( ) const

inline

isOK()

virtual bool Attrib::Param::isOK ( ) const

pure virtual

Implemented in Attrib::ParamGroup< PT >, Attrib::ValParam, and Attrib::SeisStorageRefParam.

isRequired()

bool Attrib::Param::isRequired ( ) const

inline

operator!=()

bool Attrib::Param::operator!= ( const Param &  p ) const

inline

operator==()

bool Attrib::Param::operator== ( const Param &  p ) const

inline

setCompositeValue()

virtual bool Attrib::Param::setCompositeValue ( const char *  )

inlinevirtual

Set all values from one composite string.

Reimplemented in Attrib::ValParam, Attrib::NumGateParam< T >, Attrib::NumParam< T >, Attrib::StringParam, Attrib::BoolParam, and Attrib::BinIDParam.

setEnabled()

void Attrib::Param::setEnabled ( bool  yn = true )

inline

setKey()

void Attrib::Param::setKey ( const char *  newkey )

inline

setRequired()

void Attrib::Param::setRequired ( bool  yn = true )

inline

setValues()

virtual bool Attrib::Param::setValues ( BufferStringSet &  )

inlinevirtual

Set all values from multiple strings.

Reimplemented in Attrib::ParamGroup< PT >.

Member Data Documentation

enabled_

bool Attrib::Param::enabled_

protected

isgroup_

bool Attrib::Param::isgroup_

protected

key_

BufferString Attrib::Param::key_

protected

required_

bool Attrib::Param::required_

protected