ptolemy.apps.hardrealtime

Class PtidesToMultiFrame

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.apps.hardrealtime.PtidesToMultiFrame

All Implemented Interfaces:

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

public class PtidesToMultiFrame
extends Attribute
implements Decorator

When configured this attribute generates a multiframe task that simulates the behavior of the Ptides platform it is contained in.

Version:

$Id$

Author:

Christos Stergiou

Pt.AcceptedRating:

Red (chster)

Pt.ProposedRating:

Red (chster)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.kernel.util.NamedObj

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

Constructor Summary

Constructors

Constructor and Description
PtidesToMultiFrame(NamedObj container, java.lang.String name) Construct an attribute with the given name contained by the specified entity.

Method Summary

Modifier and Type	Method and Description
DecoratorAttributes	createDecoratorAttributes(NamedObj target) Return the decorated attributes for the target NamedObj.
java.util.List<NamedObj>	decoratedObjects() Return a list of the entities deeply contained by the container of this resource scheduler.
TypedCompositeActor	generateMultiFrameSystem(java.lang.Class<? extends Director> directorClass) Construct a multiframe task system that has the same execution profile as the container Ptides system.
boolean	isGlobalDecorator() Return true to indicate that this decorator should decorate objects across opaque hierarchy boundaries.

Methods inherited from class ptolemy.kernel.util.Attribute

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, 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, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Constructor Detail

PtidesToMultiFrame

public PtidesToMultiFrame(NamedObj container,
                          java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException

Construct an attribute with the given name contained by the specified entity.

Parameters:

container - The container.

name - The name of this attributed.

Throws:

IllegalActionException - If the attribute 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

createDecoratorAttributes

public DecoratorAttributes createDecoratorAttributes(NamedObj target)

Return the decorated attributes for the target NamedObj. If the specified target is not an Actor, return null.

Specified by:

createDecoratorAttributes in interface Decorator

Parameters:

target - The NamedObj that will be decorated.

Returns:

The decorated attributes for the target NamedObj, or null if the specified target is not an Actor.

decoratedObjects

public java.util.List<NamedObj> decoratedObjects()

Return a list of the entities deeply contained by the container of this resource scheduler.

Specified by:

decoratedObjects in interface Decorator

Returns:

A list of the objects decorated by this decorator.

generateMultiFrameSystem

public TypedCompositeActor generateMultiFrameSystem(java.lang.Class<? extends Director> directorClass)
                                             throws IllegalActionException,
                                                    NameDuplicationException

Construct a multiframe task system that has the same execution profile as the container Ptides system.

Parameters:

directorClass - The class of the director that will control the execution of the multiframe task system.

Returns:

A multiframe task system that has the same execution profile as the container Ptides system.

Throws:

IllegalActionException - If preinitializing the Ptides platform, if adding task frames, or if accessing the minimum interarrival time of a Ptides input port throws it, or if the minimum interarrival time is not sufficiently large.

NameDuplicationException - If creating a multiframe task throws it.

isGlobalDecorator

public boolean isGlobalDecorator()

Return true to indicate that this decorator should decorate objects across opaque hierarchy boundaries.

Specified by:

isGlobalDecorator in interface Decorator

Returns:

False.