ptolemy.domains.tm.kernel

Interface TMActor

All Superinterfaces:

Actor, Executable, Initializable, Nameable

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 43782 2006-09-21 15:10:05Z cxh $

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

Modifier and Type	Method and Description
double	getExecutionTime() Return the execution time for this iteration.

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Method Detail

getExecutionTime

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.

Returns:

The execution time for this iteration.