AttributeEngine: Attrib::Param Class Reference

Inheritance diagram for Attrib::Param:

List of all members.

Public Member Functions
	Param (const char *key)
	Param (const Param &)
virtual	~Param ()
virtual Param *	clone () const =0
bool	operator== (const Param &p) const
bool	operator!= (const Param &p) const
virtual bool	isOK () const =0
bool	isEnabled () const
void	setEnabled (bool yn=true)
bool	isRequired () const
void	setRequired (bool yn=true)
bool	isGroup () const
const char *	getKey () const
virtual bool	setCompositeValue (const char *)
virtual bool	setValues (BufferStringSet &)
virtual bool	getCompositeValue (BufferString &) const =0
virtual BufferString	getDefaultValue () const
void	setKey (const char *newkey)
virtual void	fillDefStr (BufferString &) const =0
Protected Member Functions
bool	_isEqual (const Param &p) const
virtual bool	isEqual (const Param &) const =0
Protected Attributes
BufferString	key_
bool	isgroup_
bool	enabled_
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

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

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

virtual Attrib::Param::~Param ( ) [inline, virtual]

Member Function Documentation

bool Attrib::Param::_isEqual ( const Param & p ) const [inline, protected]

virtual Param* Attrib::Param::clone ( ) const [pure virtual]

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

virtual void Attrib::Param::fillDefStr ( BufferString & ) const [pure virtual]

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

virtual bool Attrib::Param::getCompositeValue ( BufferString & ) const [pure virtual]

Put all values into one string.

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

virtual BufferString Attrib::Param::getDefaultValue ( ) const [inline, virtual]

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

const char* Attrib::Param::getKey ( ) const [inline]

bool Attrib::Param::isEnabled ( ) const [inline]

virtual bool Attrib::Param::isEqual ( const Param & ) const [protected, pure virtual]

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

bool Attrib::Param::isGroup ( ) const [inline]

virtual bool Attrib::Param::isOK ( ) const [pure virtual]

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

bool Attrib::Param::isRequired ( ) const [inline]

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

bool Attrib::Param::operator== ( const Param & p ) const [inline]

virtual bool Attrib::Param::setCompositeValue ( const char * ) [inline, virtual]

Set all values from one composite string.

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

void Attrib::Param::setEnabled ( bool yn = true ) [inline]

void Attrib::Param::setKey ( const char * newkey ) [inline]

void Attrib::Param::setRequired ( bool yn = true ) [inline]

virtual bool Attrib::Param::setValues ( BufferStringSet & ) [inline, virtual]

Set all values from multiple strings.

Reimplemented in Attrib::ParamGroup< PT >.

Member Data Documentation

bool Attrib::Param::enabled_ [protected]

bool Attrib::Param::isgroup_ [protected]

BufferString Attrib::Param::key_ [protected]

bool Attrib::Param::required_ [protected]