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

ObjectInterfaceBase Class Reference

Pure virtual base class for object interfaces. More...

#include <ObjectInterface.h>

Inheritance diagram for ObjectInterfaceBase:

ObjectInterface< C > List of all members.

Public Methods

virtual ~ObjectInterfaceBase ()
virtual bool variableExists (std::string const &name) const=0
 Test if a given variable name exists in the interface.

virtual bool variableRequired (std::string const &name) const=0
 Test if a given variable is tagged as 'required'.

virtual std::string variableType (std::string const &name) const=0
 Get a type identifier string for a variable.

virtual std::vector< std::string > getVariableNames () const=0
 Get the names of all variables defined in the interface.

virtual std::vector< std::string > getRequiredNames () const=0
 Get the names of required variables defined in the interface.

virtual const TypeAdapter get (Object *o, std::string const &name) const=0
 Get the value of an interface variable.

virtual void set (Object *o, std::string const &name, const TypeAdapter &v) const=0
 Set the value of an interface variable.

virtual void push_back (Object *o, std::string const &name, const TypeAdapter &v) const=0
 Append a value to an interface variable list.

virtual void clear (Object *o, std::string const &name) const=0
 Clear an interface variable list.

Detailed Description

Pure virtual base class for object interfaces.

Constructor & Destructor Documentation

virtual ObjectInterfaceBase::~ObjectInterfaceBase (    )  [inline, virtual]
 

Member Function Documentation

virtual void ObjectInterfaceBase::clear (  Object *    o,
std::string const &    name
)  const [pure virtual]
 

Clear an interface variable list.

Implemented in ObjectInterface< C >.

virtual const TypeAdapter ObjectInterfaceBase::get (  Object *    o,
std::string const &    name
)  const [pure virtual]
 

Get the value of an interface variable.

Implemented in ObjectInterface< C >.

virtual std::vector<std::string> ObjectInterfaceBase::getRequiredNames (    )  [pure virtual]
 

Get the names of required variables defined in the interface.

Implemented in ObjectInterface< C >.

virtual std::vector<std::string> ObjectInterfaceBase::getVariableNames (    )  [pure virtual]
 

Get the names of all variables defined in the interface.

Implemented in ObjectInterface< C >.

virtual void ObjectInterfaceBase::push_back (  Object *    o,
std::string const &    name,
const TypeAdapter &    v
)  const [pure virtual]
 

Append a value to an interface variable list.

Implemented in ObjectInterface< C >.

virtual void ObjectInterfaceBase::set (  Object *    o,
std::string const &    name,
const TypeAdapter &    v
)  const [pure virtual]
 

Set the value of an interface variable.

Implemented in ObjectInterface< C >.

virtual bool ObjectInterfaceBase::variableExists (  std::string const &    name )  const [pure virtual]
 

Test if a given variable name exists in the interface.

Returns:
Returns true if the variable name exists in the interface.

Implemented in ObjectInterface< C >.

virtual bool ObjectInterfaceBase::variableRequired (  std::string const &    name )  const [pure virtual]
 

Test if a given variable is tagged as 'required'.

Returns:
Returns false if the variable is not marked as 'required' or does not exist in the interface.

Implemented in ObjectInterface< C >.

virtual std::string ObjectInterfaceBase::variableType (  std::string const &    name )  const [pure virtual]
 

Get a type identifier string for a variable.

Returns:
Returns the type identifier string.

Implemented in ObjectInterface< C >.

The documentation for this class was generated from the following file:
SimData version pre-0.4.0. For more information on SimData, visit the SimData Homepage.

Generated on Tue Oct 14 12:06:41 2003, using Doxygen 1.2.18.

[SF.net]