ScriptingAccess Interface Reference
[Component IDL and Corba Setup]

import "rtt/corba/ScriptingAccess.idl";

Inheritance diagram for ScriptingAccess:

ScriptingAccessProxy ParserScriptingAccess

List of all members.


Detailed Description

This interface provides easy access to a task's programs and state machines.

Definition at line 16 of file ScriptingAccess.idl.


Public Types

typedef sequence
< string > 
ProgramNames
typedef sequence
< string > 
StateMachineNames

Public Member Functions

long execute (in string code)
 Parse and execute a statement.
Command getCommand (in long ticket)
 Return the command with a given ticket number.
void loadPrograms (in string code, in string filename) raises (LoadException)
void unloadProgram (in string name) raises (LoadException)
boolean hasProgram (in string name)
ProgramNames getPrograms ()
long getProgramLine (in string name)
string getProgramText (in string name)
string getProgramStatus (in string name)
void loadStateMachines (in string code, in string filename) raises (LoadException)
void unloadStateMachine (in string name) raises (LoadException)
boolean hasStateMachine (in string name)
StateMachineNames getStateMachines ()
string getStateMachineText (in string name)
string getStateMachineStatus (in string name)
long getStateMachineLine (in string name)
string getCurrentState (in string name)

Classes

exception  LoadException
 An exception indicating that a Program or StateMachine could not be loaded or unloaded. More...

Member Function Documentation

long execute ( in string  code  ) 

Parse and execute a statement.

Return values:
-1 if a parse error occured.
0 if a statement was executed.
Returns:
a positive integer if code was a command. This number is the command's ticket number.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 25 17:41:59 2008 for OrocosReal-TimeToolkit by  doxygen 1.5.3