Package ptolemy.actor

Executable entities.

See: Description

Interface Summary

Interface	Description
Actor	An Actor is an executable entity.
ActorExecutionAspect	An interface for objects that can intervene in the execution of actors.
ActorFiringListener	A FiringEventListener listens for events that are issued during AtomicActor's iterations.
ApplicationConfigurer	A marker interface indicating that a class is used to configure a Ptolemy IIapplication.
CommunicationAspect	An interface for objects that can intervene in communication between actors.
CommunicationAspectListener	This interface defines a listener for communication aspects.
Executable	This interface defines the action methods, which determine how an object can be invoked.
ExecutionAspectListener	This is an interface for an execution aspect.
ExecutionListener	An ExecutionListener listens for events that are issued during the execution of a model by a Manager.
FiringsRecordable	Interface for entities that can report FiringEvents.
Initializable	This interface defines a subset of the action methods for initialization and wrapup.
InstanceOpener	An interface that is used to open an instance of a NamedObj.
IOPortEventListener	Listen for events that are issued during the send(), broadcast(), sendInside(), get(), getInside() function calls of an IOPort.
Librariable	Classes that implement this interface are assumed to be in the actor library.
QuasiTransparentDirector	This is a marker interface for modal directors.
Receiver	Interface for objects that can hold tokens.
StateReceiver	This is a marker interface for receivers that have state semantics.
SuperdenseTimeDirector	This is an interface for directors that use a superdense model of time.
TimedActor	This is a marker interface for actors that operate on time-based signals.
TimeRegulator	This interface is implemented by attributes that wish to be consulted when a director advances time.
TokenGotListener	Deprecated Use IOPortEventListener instead.
TokenSentListener	Deprecated Use IOPortEventListener instead.
TypedActor	A TypedActor is an actor whose ports have types.
TypeListener	An interface implemented by objects that are interested in being kept informed about type changes in a Typeable object.

Class Summary

Class	Description
AbstractInitializableAttribute	An abstract base class for attributes that are preinitialized, initialized, and wrapped up during execution of a model.
AbstractReceiver	An abstract implementation of the Receiver interface.
AtomicActor<T extends IOPort>	An AtomicActor is an executable entity that cannot itself contain other actors.
CommunicationAspectAttributes	Attributes for ports decorated by a communication aspect.
CompositeActor	A CompositeActor is an aggregation of actors.
ConstantPublisherPort	This is a specialized output port that publishes constant data sent on the specified named channel.
DesignPatternGetMoMLAction	An action that generates the Moml for a group of states to be used as a design pattern.
Director	A Director governs the execution within a CompositeActor.
DoNothingDirector	A director that does nothing, for use in models that have no useful execution.
ExecutionAspectHelper	This is a helper class for execution aspects used in AtomicExecutionAspect and CompositeExecutionAspect.
ExecutionAttributes	Container for decorator attributes that are provided to actors by a ExecutionAspect.
FiringEvent	An event that is published by directors whenever an actor is activated.
FiringEvent.FiringEventType	A type of firing event that can be published.
GraphReader	This class provides methods for converting Ptolemy II models into generic graph representations.
IntermediateReceiver	A receiver that delegates to another receiver all method calls except IntermediateReceiver.put(Token) (and its variants), for which it delegates to a communication aspect.
IOPort	This class supports exchanging data between entities via message passing.
IOPortEvent	An event that is published by an IOPort when a token or tokens are sent or received.
IORelation	This class mediates connections between ports that can send data to one another via message passing.
LazyTypedCompositeActor	An aggregation of typed actors with lazy evaluation.
LocalClock	A clock that keeps track of model time at a level of the model hierarchy and relates it to the time of the enclosing model, if there is one.
Mailbox	A token holder with capacity one.
Manager	A Manager governs the execution of a model in a domain-independent way.
Manager.State	Instances of this class represent phases of execution, or the state of the manager.
PublisherPort	This is a specialized output port that publishes data sent through it on the specified named channel.
PubSubPort	An abstract base class for publisher and subscriber ports.
QueueReceiver	A first-in, first-out (FIFO) queue receiver with variable capacity and optional history.
RelationWidthInference	A class that offers convenience utility methods to infer the widths of relations in a composite actor.
StreamExecutionListener	A default implementation of the ExecutionListener interface.
SubscriberPort	This is a specialized input port that subscribes to data sent to it on the specified named channel.
SubscriptionAggregatorPort	Aggregate data produced by multiple publishers.
TokenGotEvent	Deprecated Use IOPortEvent instead.
TokenSentEvent	Deprecated Use IOPortEvent instead.
TypeAttribute	An attribute for defining a data type for a port.
TypedAtomicActor	A TypedAtomicActor is an AtomicActor whose ports and parameters have types.
TypedCompositeActor	A TypedCompositeActor is an aggregation of typed actors.
TypedIOPort	An IOPort with a type.
TypedIORelation	This class overrides some of the methods in IORelation to ensure that TypedIOPorts are only connected to TypedIOPorts.
TypeEvent	A TypeEvent represents a type change on a Typeable object.
TypeOpaqueCompositeActor	A composite actor whose ports have types, but the actors inside are not required to be typed.

Enum Summary

Enum	Description
CommunicationAspectListener.EventType	Type of the event.
ExecutionAspectListener.ExecutionEventType	Execution time event types.

Exception Summary

Exception	Description
InvariantViolationException	Thrown when an invariant is violated.
NoRoomException	This exception is thrown when an attempt is made to put a token into a receiver that does not have room to accommodate one.
NoTokenException	This exception is thrown when an attempt is made to get a token from a receiver that does not contain one.
TypeConflictException	Thrown on detecting type conflicts.
TypedIOPort.RunTimeTypeCheckException	Exception class for run-time type errors.

Package ptolemy.actor Description

Executable entities.

Since:

Ptolemy II 0.2