org.kepler

Class ExecutionEngine

java.lang.Object

org.kepler.ExecutionEngine

All Implemented Interfaces:

ExecutionListener

public class ExecutionEngine
extends java.lang.Object
implements ExecutionListener

This class is the main entry point for making API calls to the underlying ptolemy execution engine and moml parser.

Method Summary

Modifier and Type	Method and Description
void	addExecutionListener(ExecutionListener exeListener) add an execution listener
void	executionError(Manager manager, java.lang.Throwable throwable) implements executionError in ExecutionListener
void	executionFinished(Manager manager) implements executionFinished in ExecutionListener
java.util.Vector<ExecutionListener>	getExecutionListeners() return a vector of all of the registered ExecutionListeners
static ExecutionEngine	getInstance() singleton accessor
static void	main(java.lang.String[] args) command line interface to this class
void	managerStateChanged(Manager manager) implements managerStateChanged in ExecutionListener
static NamedObj	parseMoML(java.lang.String moml) static method to parse a moml document and return a NamedObj
static NamedObj	parseMoML(java.lang.String moml, Workspace workspace) static method to parse a moml document and return a NamedObj
static java.lang.String	readFile(java.lang.String filename) read a file and return its contents as a string
void	removeExecutionListener(ExecutionListener exeListener) remove an execution listener
Manager	runModel(CompositeActor model) run a single model in the current thread
Manager	runModelInThread(CompositeActor model) run a model in a new thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ExecutionEngine getInstance()

singleton accessor

runModel

public Manager runModel(CompositeActor model)
                 throws IllegalActionException,
                        KernelException

run a single model in the current thread

Parameters:

model - the model to run

Returns:

Manager the manager to control the execution

Throws:

IllegalActionException

KernelException

runModelInThread

public Manager runModelInThread(CompositeActor model)
                         throws IllegalActionException,
                                KernelException

run a model in a new thread. Use the manager to control the thread.

Parameters:

model - the model to run

Returns:

Manager the manager that controls the new thread

Throws:

IllegalActionException

KernelException

addExecutionListener

public void addExecutionListener(ExecutionListener exeListener)

add an execution listener

Parameters:

exeListener - the listener to add

removeExecutionListener

public void removeExecutionListener(ExecutionListener exeListener)

remove an execution listener

Parameters:

exeListener - the listener to remove

getExecutionListeners

public java.util.Vector<ExecutionListener> getExecutionListeners()

return a vector of all of the registered ExecutionListeners

parseMoML

public static NamedObj parseMoML(java.lang.String moml)
                          throws java.lang.Exception

static method to parse a moml document and return a NamedObj

Parameters:

moml - the moml to parse

Throws:

java.lang.Exception

parseMoML

public static NamedObj parseMoML(java.lang.String moml,
                                 Workspace workspace)
                          throws java.lang.Exception

static method to parse a moml document and return a NamedObj

Parameters:

moml - the moml to parse

workspace - the workspace to parse the moml in to.

Throws:

java.lang.Exception

readFile

public static java.lang.String readFile(java.lang.String filename)
                                 throws java.io.FileNotFoundException,
                                        java.io.IOException

read a file and return its contents as a string

Parameters:

filename - the name or path of the file to read

Throws:

java.io.FileNotFoundException

java.io.IOException

main

public static void main(java.lang.String[] args)

command line interface to this class

executionError

public void executionError(Manager manager,
                           java.lang.Throwable throwable)

implements executionError in ExecutionListener

Specified by:

executionError in interface ExecutionListener

Parameters:

manager - The manager controlling the execution.

throwable - The throwable to report.

executionFinished

public void executionFinished(Manager manager)

implements executionFinished in ExecutionListener

Specified by:

executionFinished in interface ExecutionListener

Parameters:

manager - The manager controlling the execution.

managerStateChanged

public void managerStateChanged(Manager manager)

implements managerStateChanged in ExecutionListener

Specified by:

managerStateChanged in interface ExecutionListener

Parameters:

manager - The manager controlling the execution.

See Also:

Manager.getState()