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

skExecutable Class Reference

This class gives a default implementation for the skiExecutable interface. More...

#include <skExecutable.h>

Inheritance diagram for skExecutable:

skiExecutable skElementObject skElementObjectEnumerator skInterpreter skMSXMLElementObject skMSXMLElementObjectEnumerator skNull skTreeNodeObject skTreeNodeObjectEnumerator skXMLElementObject skXMLElementObjectEnumerator List of all members.

Public Methods

 skExecutable ()
 Default Constructor.

virtual ~skExecutable ()
 Destructor.

virtual int executableType () const
 this method returns the type of the object at this level this is UNDEFINED_TYPE.

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual skString getSource (const skString &location)
 This method returns the source for a scripted method described by the location.

virtual void getInstanceVariables (skRValueTable &table)
 This method returns the instance variables for this object.


Detailed Description

This class gives a default implementation for the skiExecutable interface.


Member Function Documentation

skExecutableIterator * skExecutable::createIterator   [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

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

skExecutableIterator * skExecutable::createIterator const skString   qualifier [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

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

bool skExecutable::equals const skiExecutable   other_object const [virtual]
 

This method compares this object with another object.

This implementation checks object pointers.

Implements skiExecutable.

int skExecutable::executableType   const [virtual]
 

this method returns the type of the object at this level this is UNDEFINED_TYPE.

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

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

void skExecutable::getInstanceVariables skRValueTable   table [virtual]
 

This method returns the instance variables for this object.

Parameters:
table a table to filled with references to the instance variables

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

skString skExecutable::getSource const skString   location [virtual]
 

This method returns the source for a scripted method described by the location.

Parameters:
location the location of the method - in the format passed to the execute functions in the Interpreter
Returns:
the source for the method

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

bool skExecutable::getValue const skString   field_name,
const skString   attribute,
skRValue   value
[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

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

bool skExecutable::getValueAt const skRValue   array_index,
const skString   attribute,
skRValue   value
[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

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

bool skExecutable::method const skString   method_name,
skRValueArray   arguments,
skRValue   return_value,
skExecutableContext   ctxt
[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
context context object to receive errors
Returns:
true if the method could be executed, or false if the method is not supported

Implements skiExecutable.

Reimplemented in skElementObject, skElementObjectEnumerator, skInterpreter, skMSXMLElementObject, skMSXMLElementObjectEnumerator, skTreeNodeObject, skTreeNodeObjectEnumerator, skXMLElementObject, and skXMLElementObjectEnumerator.

bool skExecutable::setValue const skString   field_name,
const skString   attribute,
const skRValue   value
[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

Implements skiExecutable.

Reimplemented in skElementObject, skInterpreter, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

bool skExecutable::setValueAt const skRValue   array_index,
const skString   attribute,
const skRValue   value
[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

Implements skiExecutable.

Reimplemented in skElementObject, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.


The documentation for this class was generated from the following files:
Generated on Thu Jan 23 15:25:39 2003 for Simkin by doxygen1.3-rc1