ptolemy.domains.tm.kernel
Interface TMActor

All Superinterfaces:
Actor, Executable
All Known Implementing Classes:
TMCompositeFacade

public interface TMActor
extends Actor

An interface that adds a method getExecutionTime() to the Actor interface. This allows actors to estimate its execution time on a per iteration basis, and maybe in an input-dependent manner.

Since:
Ptolemy II 2.0
Version:
$Id: TMActor.java,v 1.8 2004/04/13 03:37:03 cxh Exp $
Author:
Jie Liu
Accepted Rating:
Yellow (janneck)
Proposed Rating:
Yellow (liuj)

Field Summary
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Method Summary
 double getExecutionTime()
          Return the execution time for this iteration.
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
fire, initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 

Method Detail

getExecutionTime

public double getExecutionTime()
Return the execution time for this iteration. This method will be called by the TMDirector after the prefire() method is called. The reason for this method is to allow the actor to determine/estimate its execution time on a per iteration basis.