ptolemy.actor
Interface Actor

All Superinterfaces:
Executable
All Known Subinterfaces:
ConditionalBranchActor, CTDynamicActor, CTEventGenerator, CTStatefulActor, CTStepSizeControlActor, CTWaveformGenerator, TMActor, TypedActor, WirelessChannel
All Known Implementing Classes:
AtomicActor, AtomicWirelessChannel, CompositeActor, CSPActor, CTBaseIntegrator, CTCompositeActor, CTPeriodicSampler, CTTriggeredSampler, EventSource, FirstOrderHold, FSMActor, LevelCrossingDetector, ThresholdMonitor, TMCompositeFacade, TypedAtomicActor, TypedCompositeActor, ZeroOrderHold

public interface Actor
extends Executable

An Actor is an executable entity. This interface defines the common functionality in AtomicActor and CompositeActor.

Since:
Ptolemy II 0.2
Version:
$Id: Actor.java,v 1.55.2.2 2004/06/20 03:10:42 cxh Exp $
Author:
Edward A. Lee
See Also:
CompositeActor, AtomicActor
Accepted Rating:
Green (davisj)
Proposed Rating:
Green (eal)

Field Summary
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Method Summary
 Director getDirector()
          Return the local director, if there is one, otherwise the executive director, if there is one, otherwise null.
 Director getExecutiveDirector()
          Return the executive director, if there is one, otherwise return null.
 FunctionDependency getFunctionDependency()
          Return a representation of the function dependencies that output ports have on input ports.
 Manager getManager()
          Return the Manager, if there is one.
 java.util.List inputPortList()
          Return a list of the input ports of this actor.
 Receiver newReceiver()
          Return a new receiver of a type compatible with the executive director.
 java.util.List outputPortList()
          Return a list of the output ports of this actor.
 
Methods inherited from interface ptolemy.actor.Executable
fire, initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 

Method Detail

getDirector

public Director getDirector()
Return the local director, if there is one, otherwise the executive director, if there is one, otherwise null.

Returns:
The director.

getExecutiveDirector

public Director getExecutiveDirector()
Return the executive director, if there is one, otherwise return null.

Returns:
The executive director.

getFunctionDependency

public FunctionDependency getFunctionDependency()
Return a representation of the function dependencies that output ports have on input ports.

Returns:
A representation of the function dependencies of the ports of this actor.
See Also:
FunctionDependency

getManager

public Manager getManager()
Return the Manager, if there is one. Otherwise, return null.

Returns:
The Manager.

inputPortList

public java.util.List inputPortList()
Return a list of the input ports of this actor. Note that implementations should return ports directly contained by this actor, whether they are transparent or not.

Returns:
A list of input IOPort objects.

newReceiver

public Receiver newReceiver()
                     throws IllegalActionException
Return a new receiver of a type compatible with the executive director. This is the receiver that should be used by ports of this actor.

Returns:
A new object implementing the Receiver interface.
Throws:
IllegalActionException - If there is no director.

outputPortList

public java.util.List outputPortList()
Return a list of the output ports of this actor. Note that implementations should return ports directly contained by this actor, whether they are transparent or not.

Returns:
A list of output IOPort objects.