ptolemy.actor

Class ExecutionAspectHelper

java.lang.Object

ptolemy.actor.ExecutionAspectHelper

public class ExecutionAspectHelper
extends java.lang.Object

This is a helper class for execution aspects used in AtomicExecutionAspect and CompositeExecutionAspect.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Patricia Derler

Pt.AcceptedRating:

Red (derler)

Pt.ProposedRating:

Red (derler)

Constructor Summary

Constructors

Constructor and Description
ExecutionAspectHelper()

Method Summary

Modifier and Type	Method and Description
static java.util.List<NamedObj>	getEntitiesToDecorate(CompositeEntity container) Execution aspects are decorators and this method recursively computes all entities inside a given container that are decorated by execution aspects.
static Time	schedule(ActorExecutionAspect aspect, NamedObj actor, Time environmentTime, Time deadline) Schedule an actor for execution on an aspect and return the next time this aspect has to perform an action.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionAspectHelper

public ExecutionAspectHelper()

Method Detail

getEntitiesToDecorate

public static java.util.List<NamedObj> getEntitiesToDecorate(CompositeEntity container)

Execution aspects are decorators and this method recursively computes all entities inside a given container that are decorated by execution aspects.

Parameters:

container - The container.

Returns:

All entities to decorate.

schedule

public static Time schedule(ActorExecutionAspect aspect,
                            NamedObj actor,
                            Time environmentTime,
                            Time deadline)
                     throws IllegalActionException

Schedule an actor for execution on an aspect and return the next time this aspect has to perform an action. Derived classes must implement this method to actually schedule actors, this base class implementation just creates events for aspect activity that is displayed in the plotter. This base class implementation just creates events for aspect activity that is displayed in the plotter.

Parameters:

aspect - The aspect.

actor - The actor to be scheduled.

environmentTime - The current platform time.

deadline - The deadline timestamp of the event to be scheduled. This can be the same as the environmentTime.

Returns:

Relative time when this aspect has to be executed again to perform rescheduling actions.

Throws:

IllegalActionException - Thrown if actor parameters such as execution time or priority cannot be read.