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

skTest Class Reference

You can use this small class to trace calls into a C++ object from a script. More...

Inheritance diagram for skTest:

skExecutable skiExecutable List of all members.

Public Methods

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

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

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

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

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. More...

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

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


Detailed Description

You can use this small class to trace calls into a C++ object from a script.

The class supports the method "createObject" and an instance is put as a global variable called "Test". This means you can do the following in Simkin script:

 a=Test.createObject(); b=a:name; 
And watch a trace of the "getValue" function being called


Member Function Documentation

skExecutableIterator * skTest::createIterator ( ) [inline, 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 from skExecutable.

skExecutableIterator * skTest::createIterator ( const skString & qualifier ) [inline, 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 from skExecutable.

bool skTest::getValue ( const skString & field_name,
const skString & attribute,
skRValue & value ) [inline, 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 from skExecutable.

bool skTest::getValueAt ( const skRValue & array_index,
const skString & attribute,
skRValue & value ) [inline, 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 from skExecutable.

bool skTest::method ( const skString & method_name,
skRValueArray & arguments,
skRValue & return_value ) [inline, 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 from skExecutable.

bool skTest::setValue ( const skString & field_name,
const skString & attribute,
const skRValue & value ) [inline, 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 from skExecutable.

bool skTest::setValueAt ( const skRValue & array_index,
const skString & attribute,
const skRValue & value ) [inline, 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 from skExecutable.


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