Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skiExecutable Class Reference

This class gives an interface for the Interpreter to call into. More...

#include <skiExecutable.h>

Inheritance diagram for skiExecutable:

skExecutable skElementObject skElementObjectEnumerator skInterpreter skNull skTest skTreeNodeObject skTreeNodeObjectEnumerator skXMLElementObject skXMLElementObjectEnumerator List of all members.

Public Methods

virtual ~skiExecutable ()
 Destructor.

virtual int executableType () const = 0
 this method returns the type of the object. More...

virtual int intValue () const = 0
 returns an integer equivalent of this object.

virtual bool boolValue () const = 0
 returns a boolean equivalent of this object.

virtual Char charValue () const = 0
 returns a character equivalent of this object.

virtual skString strValue () const = 0
 returns a String equivalent of this object.

virtual float floatValue () const = 0
 returns a float equivalent of this object.

virtual bool setValue (const skString& field_name,const skString& attribute,const skRValue& value) = 0
 requests the object to set a field to the given value. More...

virtual bool setValueAt (const skRValue& array_index,const skString& attribute,const skRValue& value) = 0
 requests the object to set an item in its collection to a certain value. More...

virtual bool getValue (const skString& field_name,const skString& attribute,skRValue& value) = 0
 requests the object to return a field's value. More...

virtual bool getValueAt (const skRValue& array_index,const skString& attribute,skRValue& value) = 0
 requests the object to return an object from its collection. More...

virtual bool method (const skString& method_name,skRValueArray& arguments,skRValue& return_value) = 0
 Requests that the object execute the given method. More...

virtual bool equals (const skiExecutable * other_object) const = 0
 This method compares this object with another object.

virtual skExecutableIteratorcreateIterator (const skString& qualifier) = 0
 This method returns an executable iterator used in foreach statements. More...

virtual skExecutableIteratorcreateIterator () = 0
 This method returns an executable iterator used in foreach statements. More...


Detailed Description

This class gives an interface for the Interpreter to call into.

All its methods are pure virtuals so that it can be used in as many different class hierarchies as possible.


Member Function Documentation

skExecutableIterator * skiExecutable::createIterator ( ) [pure virtual]
 

This method returns an executable iterator used in foreach statements.

Returns:
an skExecutableIterator object that can be used to iterate over the components of this container

Reimplemented in skTest, skElementObject, skExecutable, skTreeNodeObject, and skXMLElementObject.

skExecutableIterator * skiExecutable::createIterator ( const skString & qualifier ) [pure virtual]
 

This method returns an executable iterator used in foreach statements.

Parameters:
qualifier   a value to qualify the iteration by
Returns:
an skExecutableIterator object that can be used to iterate over the result of the qualifier

Reimplemented in skTest, skElementObject, skExecutable, skTreeNodeObject, and skXMLElementObject.

int skiExecutable::executableType ( ) const [pure virtual]
 

this method returns the type of the object.

Define your own value if you want to check the type of your object at run-time

Reimplemented in skElementObject, skExecutable, skTreeNodeObject, and skXMLElementObject.

bool skiExecutable::getValue ( const skString & field_name,
const skString & attribute,
skRValue & value ) [pure virtual]
 

requests the object to return a field's value.

Parameters:
field_name   - the name of the field name to get
attribute   - the attribute name to get (may be blank)
value   - the value to receive the value of the field
Returns:
true if the field was changed, false if the field could not be get or found

Reimplemented in skTest, skElementObject, skExecutable, skTreeNodeObject, and skXMLElementObject.

bool skiExecutable::getValueAt ( const skRValue & array_index,
const skString & attribute,
skRValue & value ) [pure virtual]
 

requests the object to return an object from its collection.

Parameters:
array_index   - the identifier of the item - this might be a string, integer or any other legal value
attribute   - the attribute name to get (may be blank)
value   - the value to receive the value of the field
Returns:
true if the field was changed, false if the field could not be get or found

Reimplemented in skTest, skElementObject, skExecutable, skTreeNodeObject, and skXMLElementObject.

bool skiExecutable::method ( const skString & s,
skRValueArray & args,
skRValue & r ) [pure virtual]
 

Requests that the object execute the given method.

Parameters:
method_name   - the name of the method to execute
arguments   - an array of RValue objects, which are the arguments to the method
return_value   - an object to receive the return value of the method
return   true if the method could be executed, or false if the method is not supported

Reimplemented in skTest, skElementObject, skElementObjectEnumerator, skExecutable, skTreeNodeObject, skTreeNodeObjectEnumerator, skXMLElementObject, and skXMLElementObjectEnumerator.

bool skiExecutable::setValue ( const skString & field_name,
const skString & attribute,
const skRValue & value ) [pure virtual]
 

requests the object to set a field to the given value.

Parameters:
field_name   - the name of the field name to set
attribute   - the attribute name to set (may be blank)
value   - the value to be set
Returns:
true if the field was changed, false if the field could not be set or found

Reimplemented in skTest, skElementObject, skExecutable, skInterpreter, skTreeNodeObject, skXMLElementObject, and skInterpreter.

bool skiExecutable::setValueAt ( const skRValue & array_index,
const skString & attribute,
const skRValue & value ) [pure virtual]
 

requests the object to set an item in its collection to a certain value.

Parameters:
array_index   - the identifier of the item - this might be a string, integer or any other legal value
attribute   - the attribute name to set (may be blank)
value   - the value to be set
Returns:
true if the field was changed, false if the field could not be set or found

Reimplemented in skTest, skElementObject, skExecutable, skTreeNodeObject, and skXMLElementObject.


The documentation for this class was generated from the following file:
Generated at Mon Nov 5 19:22:26 2001 for Simkin by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000