Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members | Related Pages

vlNameValuePairBase Class Reference

Base class for vlNameValuePair. More...

#include <vlnamevaluepair.h>

Inheritance diagram for vlNameValuePairBase:

vlNameValuePair< DataType > List of all members.

Public Member Functions

virtual ~vlNameValuePairBase ()
 Virtual destructor.

virtual std::string name () const=0
 Returns the short name of the variable.

virtual std::string desc () const=0
 Returns the description of the variable.

virtual const char * typeInfo () const=0
 Returns the typeinfo name of the datatype.

virtual bool isDirty () const=0
 Returns true if data is dirty.

virtual void resetDirty ()=0
 Reset the dirty flag.

virtual bool isValid () const=0
 Returns the state of the valid flag.

virtual void setValid (bool valid=true)=0
 Sets the state of the valid flag.

virtual vlNameValuePairBasecopySelf () const=0
 Provide a copy of self.


Detailed Description

Author:
Sarang Lakare <sarang@users.sf.net>
See also:
vlNameValuePair<T>

Definition at line 45 of file vlnamevaluepair.h.


Constructor & Destructor Documentation

virtual vlNameValuePairBase::~vlNameValuePairBase  )  [inline, virtual]
 

Definition at line 49 of file vlnamevaluepair.h.


Member Function Documentation

virtual vlNameValuePairBase* vlNameValuePairBase::copySelf  )  const [pure virtual]
 

Implemented in vlNameValuePair< DataType >.

virtual std::string vlNameValuePairBase::desc  )  const [pure virtual]
 

Implemented in vlNameValuePair< DataType >.

virtual bool vlNameValuePairBase::isDirty  )  const [pure virtual]
 

The dirty bit is set with every call to set() and is reset every time resetDirty() is called. This can be used to track modifications to the data.

Returns:
true or false

Implemented in vlNameValuePair< DataType >.

Referenced by vlVarList::isDirty().

virtual bool vlNameValuePairBase::isValid  )  const [pure virtual]
 

This valid flag indicates if the data is logically valid. The setting and resetting of this flag is thus in the hands of the user. By default, it is set to true.

Implemented in vlNameValuePair< DataType >.

Referenced by vlVarList::isValid().

virtual std::string vlNameValuePairBase::name  )  const [pure virtual]
 

Implemented in vlNameValuePair< DataType >.

virtual void vlNameValuePairBase::resetDirty  )  [pure virtual]
 

Implemented in vlNameValuePair< DataType >.

Referenced by vlVarList::resetDirty().

virtual void vlNameValuePairBase::setValid bool  valid = true  )  [pure virtual]
 

Implemented in vlNameValuePair< DataType >.

Referenced by vlVarList::setValid().

virtual const char* vlNameValuePairBase::typeInfo  )  const [pure virtual]
 

This is the best way to compare all datatypes. Note that datatype names are not constant across compilers.

Implemented in vlNameValuePair< DataType >.

Referenced by vlVarList::getNameValuePair(), and vlVarList::getTypeInfo().


The documentation for this class was generated from the following file:
Generated on Fri Mar 18 11:33:18 2005 for OpenVL by doxygen 1.3.3