ptolemy.domains.pthales.lib

Class PthalesCompositeActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.kernel.CompositeEntity

ptolemy.actor.CompositeActor

ptolemy.actor.TypedCompositeActor

ptolemy.domains.pthales.lib.PthalesCompositeActor

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

PthalesDynamicCompositeActor

public class PthalesCompositeActor
extends TypedCompositeActor

A composite actor imposes the use of PthalesIOPort as they contain needed values used by PThalesDirector. A PthalesCompositeActor can contain actors from different model (as SDF), but the port must be a PthalesIOPort, because of the ArrayOL parameters.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Rémi Barrère

See Also:

TypedIOPort

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.CompositeEntity

CompositeEntity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	_REPETITIONS The name of the total repetitions parameter.
Parameter	repetitions The number of times this actor is fired.

Fields inherited from class ptolemy.actor.CompositeActor

_actorFiringListeners, _causalityInterface, _derivedPiggybacks, _initializables, _notifyingActorFiring, _piggybacks, _publishedPorts, _publisherRelations, _stopRequested, _subscribedPorts

Fields inherited from class ptolemy.kernel.CompositeEntity

_levelCrossingLinks

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

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
PthalesCompositeActor() Construct a PthalesCompositeActor in the default workspace with no container and an empty string as its name.
PthalesCompositeActor(CompositeEntity container, java.lang.String name) Construct a PthalesCompositeActor with a name and a container.
PthalesCompositeActor(Workspace workspace) Construct a PthalesCompositeActor in the specified workspace with no container and an empty string as a name.

Method Summary

Modifier and Type	Method and Description
protected void	_initialize() Set specific attributes common to all Pthales composite actors.
java.lang.Integer[]	computeIterations(IOPort portIn, java.util.LinkedHashMap<java.lang.String,java.lang.Integer> sizes) Compute iteration number of the actor, which is the number of times internal entities are called.
void	computeSetIterations(IOPort portIn, java.util.LinkedHashMap<java.lang.String,java.lang.Integer> sizes) Compute iteration number of the actor, which is the number of times internal entities are called.
Port	newPort(java.lang.String name) Create a new PthalesIOPort with the specified name.
void	setIterations(java.lang.Integer[] repetition) Set iteration number of the actor, which is the number of times internal entities are called.

Methods inherited from class ptolemy.actor.TypedCompositeActor

_addEntity, _addPort, _addRelation, _checkTypesFromTo, _destinationTypeConstraints, attributeChanged, attributeTypeChanged, isBackwardTypeInferenceEnabled, newRelation, resolveTypes, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.CompositeActor

_actorFiring, _actorFiring, _finishedAddEntity, _setDirector, _transferPortParameterInputs, addActorFiringListener, addInitializable, addPiggyback, clone, connectionsChanged, createReceivers, createSchedule, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, getPublishedPort, getPublishedPortChannel, getPublishedPorts, getSubscribedPortChannel, inferringWidths, inferWidths, initialize, inputPortList, isFireFunctional, isOpaque, isPublishedPort, isStrict, iterate, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, needsWidthInference, newInsideReceiver, newReceiver, notifyConnectivityChange, outputPortList, postfire, prefire, preinitialize, recordFiring, registerPublisherPort, registerPublisherPort, removeActorFiringListener, removeInitializable, removePiggyback, requestChange, setContainer, setDirector, setManager, stop, stopFire, terminate, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unregisterPublisherPort, unregisterPublisherPort, wrapup

Methods inherited from class ptolemy.kernel.CompositeEntity

_adjustDeferrals, _containedDecorators, _deepOpaqueEntityList, _description, _exportMoMLContents, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepCompositeEntityList, deepEntityList, deepGetEntities, deepNamedObjList, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyAllCompositeTransparentAndOpaqueEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, statistics, uniqueName

Methods inherited from class ptolemy.kernel.ComponentEntity

_checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, clone, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

repetitions

public Parameter repetitions

The number of times this actor is fired. The initial default value is an array with one element, the integer "1".

_REPETITIONS

protected static java.lang.String _REPETITIONS

The name of the total repetitions parameter.

Constructor Detail

PthalesCompositeActor

public PthalesCompositeActor()
                      throws NameDuplicationException,
                             IllegalActionException

Construct a PthalesCompositeActor in the default workspace with no container and an empty string as its name. Add the actor to the workspace directory. You should set the local director or executive director before attempting to send data to the actor or to execute it. Increment the version number of the workspace.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

PthalesCompositeActor

public PthalesCompositeActor(CompositeEntity container,
                             java.lang.String name)
                      throws IllegalActionException,
                             NameDuplicationException

Construct a PthalesCompositeActor with a name and a container. The container argument must not be null, or a NullPointerException will be thrown. This actor will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace. This actor will have no local director initially, and its executive director will be simply the director of the container.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the container is incompatible with this actor.

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

PthalesCompositeActor

public PthalesCompositeActor(Workspace workspace)
                      throws NameDuplicationException,
                             IllegalActionException

Construct a PthalesCompositeActor in the specified workspace with no container and an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. You should set the local director or executive director before attempting to send data to the actor or to execute it. Add the actor to the workspace directory. Increment the version number of the workspace.

Parameters:

workspace - The workspace that will list the actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

computeIterations

public java.lang.Integer[] computeIterations(IOPort portIn,
                                             java.util.LinkedHashMap<java.lang.String,java.lang.Integer> sizes)

Compute iteration number of the actor, which is the number of times internal entities are called. and set corresponding attribute.

Parameters:

portIn - the input port

sizes - dimensions sizes of the input

Returns:

An array of iterations. The length of the array is equal to the tiling on the input port.

computeSetIterations

public void computeSetIterations(IOPort portIn,
                                 java.util.LinkedHashMap<java.lang.String,java.lang.Integer> sizes)

Compute iteration number of the actor, which is the number of times internal entities are called. and set corresponding attribute

Parameters:

portIn - the input port

sizes - dimensions sizes of the input

setIterations

public void setIterations(java.lang.Integer[] repetition)

Set iteration number of the actor, which is the number of times internal entities are called. and set corresponding attribute

Parameters:

repetition - The number of times this actor is fired.

newPort

public Port newPort(java.lang.String name)
             throws NameDuplicationException

Create a new PthalesIOPort with the specified name. The container of the port is set to this actor. This method is write-synchronized on the workspace.

Overrides:

newPort in class TypedCompositeActor

Parameters:

name - The name for the new port.

Returns:

A new PthalesIOPort.

Throws:

NameDuplicationException - If this actor already has a port with the specified name.

_initialize

protected void _initialize()
                    throws IllegalActionException,
                           NameDuplicationException

Set specific attributes common to all Pthales composite actors.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.