ptserver.actor

Class ProxyActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptserver.actor.ProxyActor

All Implemented Interfaces:

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

Direct Known Subclasses:

ProxySink, ProxySource

public abstract class ProxyActor
extends TypedAtomicActor

An abstract parent actor that contains logic common to both sink and source proxy actors. This actor is responsible for either removing the target actor and putting itself as a proxy or removing all actors connected to the target actor and putting itself instead of all of connected actor connected to the target actor.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Anar Huseynov

See Also:

ProxySink, ProxySource

Pt.AcceptedRating:

Red (ahuseyno)

Pt.ProposedRating:

Red (ahuseyno)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	REPLACE_CONNECTING_ENTITIES Replace entities connected to the target entity with proxy actor.
static boolean	REPLACE_TARGET_ENTITY Replace target entity with the ProxySink and ProxySource.

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

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
ProxyActor(CompositeEntity container, ComponentEntity targetEntity, boolean replaceTargetEntity, java.util.HashMap<java.lang.String,java.lang.String> portTypes) Parent constructor that replaces either targetEntity if replaceTargetEntity is true or otherwise all entities connected to it with a proxy instance (ProxySink or ProxySource).
ProxyActor(CompositeEntity container, java.lang.String name) Create a new instance of the ProxyActor without doing any actor replacement.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTargetEntityName() Return the full name of the target entity.
void	setTargetEntityName(java.lang.String targetEntityName) Set the full name of the target entity.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

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

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, 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, requestChange, 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

REPLACE_TARGET_ENTITY

public static final boolean REPLACE_TARGET_ENTITY

Replace target entity with the ProxySink and ProxySource.

See Also:

Constant Field Values

REPLACE_CONNECTING_ENTITIES

public static final boolean REPLACE_CONNECTING_ENTITIES

Replace entities connected to the target entity with proxy actor.

See Also:

Constant Field Values

Constructor Detail

ProxyActor

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

Create a new instance of the ProxyActor without doing any actor replacement.

Parameters:

container - The container of the actor.

name - The name of this actor within the container.

Throws:

IllegalActionException - If this actor cannot be contained by the proposed container (see the setContainer() method).

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

ProxyActor

public ProxyActor(CompositeEntity container,
                  ComponentEntity targetEntity,
                  boolean replaceTargetEntity,
                  java.util.HashMap<java.lang.String,java.lang.String> portTypes)
           throws IllegalActionException,
                  NameDuplicationException,
                  java.lang.CloneNotSupportedException

Parent constructor that replaces either targetEntity if replaceTargetEntity is true or otherwise all entities connected to it with a proxy instance (ProxySink or ProxySource). The proxy actor is named the same as the original with addition of "_remote" suffix. All links of the targetEntity are removed. The proxy actor dynamically adds ports that were present in the targetEntity (with the same port name) or and connects them to the targetEntity's relations.

Parameters:

container - The container of the actor.

targetEntity - the targetEntity to be replaced by a proxy

replaceTargetEntity - if true replace the target entity with the proxy, otherwise replace all entities connecting to it with one proxy

portTypes - Map of ports and their resolved types

Throws:

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

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

java.lang.CloneNotSupportedException - If port cloning is not supported

Method Detail

getTargetEntityName

public java.lang.String getTargetEntityName()

Return the full name of the target entity.

Returns:

the targetEntityName

See Also:

setTargetEntityName(String)

setTargetEntityName

public void setTargetEntityName(java.lang.String targetEntityName)
                         throws IllegalActionException

Set the full name of the target entity.

Parameters:

targetEntityName - the target entity name

Throws:

IllegalActionException - If the change is not acceptable to the container.

See Also:

getTargetEntityName()