ptolemy.actor.sched
Class FixedPointScheduler

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.sched.Scheduler
              ptolemy.actor.sched.FixedPointScheduler

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

ContinuousScheduler, SROptimizedScheduler

public class FixedPointScheduler
extends Scheduler

A scheduler for the FixedPointDirector. This scheduler constructs a static schedule for a model by performing a topological sort on actors. Currently, in this class, each actor appears only once, but a more sophisticated scheduler may mention an actor more than once if the dependencies require it.

Since:

Ptolemy II 5.2

Version:

$Id: FixedPointScheduler.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Haiyang Zheng and Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (reviewModerator)

Proposed Rating:

Yellow (hyzheng)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.actor.sched.Scheduler

_DEFAULT_SCHEDULER_NAME

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

FixedPointScheduler(StaticSchedulingDirector container, java.lang.String name)
Construct a scheduler in the given container with the given name.

Method Summary

protected Schedule

_getSchedule() Return the schedule.

Methods inherited from class ptolemy.actor.sched.Scheduler

clone, getSchedule, isValid, setContainer, setValid

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedPointScheduler

public FixedPointScheduler(StaticSchedulingDirector container,
                           java.lang.String name)
                    throws IllegalActionException,
                           NameDuplicationException

Construct a scheduler in the given container with the given name. The container argument must not be null, or a NullPointerException will be thrown. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.

Parameters:

container - The container.

name - The name of this scheduler.

Throws:

IllegalActionException - If the scheduler is not of an acceptable class for the container, or if the name contains a period.

NameDuplicationException - If the name coincides with an attribute already in the container.

Method Detail

_getSchedule

protected Schedule _getSchedule()

Return the schedule. This method attempts to construct a schedule based on a topological sort of the graph (which uses causality interfaces). If there are cycles, no such sort is possible, and this method simply returns a schedule that lists the actors in their natural order in the container, which is the order in which they were created (unless that order has been modified through "bring to front" or "send to back"). This method should not be called directly, but rather the getSchedule() method (which is defined in the superclass) will call it when the schedule is invalid. This method is not synchronized on the workspace.

Overrides:

_getSchedule in class Scheduler

Returns:

A schedule.

See Also:

CompositeEntity.deepEntityList()