ptolemy.actor
Class TypeOpaqueCompositeActor
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.kernel.CompositeEntity
ptolemy.actor.CompositeActor
ptolemy.actor.TypeOpaqueCompositeActor
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
- Direct Known Subclasses:
- NCCompositeActor
public class TypeOpaqueCompositeActor
- extends CompositeActor
- implements TypedActor
A composite actor whose ports have types, but the actors inside are
not required to be typed. This actor does not impose any type
constraints between its ports, so any output ports of this actor
have to have explicitly declared types. There is no mechanism for
inferring the types of the output ports. Note that the ports of
this actor cannot be linked on the inside to untyped relations, and
by default, any relation created on the inside will be untyped.
The intended use of this actor is for scenarios where the
inside structure is not part of the Ptolemy type system. For
example, the inside structure may define a component that will be
translated into executable code by a code generator. A subclass of
this actor would typically include the code generator an a
mechanism for executing the generating code.
- Since:
- Ptolemy II 4.1
- Version:
- $Id: TypeOpaqueCompositeActor.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Elaine Cheong and Edward A. Lee
- See Also:
TypedCompositeActor,
TypedIOPort,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Method Summary |
protected void |
_addPort(Port port)
Override the base class to throw an exception if the added port
is not an instance of TypedIOPort. |
Port |
newPort(java.lang.String name)
Create a new TypedIOPort with the specified name. |
java.util.Set<Inequality> |
typeConstraints()
Return the type constraints of this actor. |
| Methods inherited from class ptolemy.actor.CompositeActor |
_actorFiring, _actorFiring, _addEntity, _addRelation, _finishedAddEntity, _getPublishedPort, _setDirector, addActorFiringListener, addInitializable, addPiggyback, clone, connectionsChanged, createReceivers, createSchedule, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inferringWidths, inferWidths, initialize, inputPortList, isFireFunctional, isOpaque, isStrict, iterate, linkToPublishedPort, linkToPublishedPort, needsWidthInference, newInsideReceiver, newReceiver, newRelation, notifyConnectivityChange, outputPortList, postfire, prefire, preinitialize, recordFiring, registerPublisherPort, removeActorFiringListener, removeInitializable, removePiggyback, requestChange, setContainer, setDirector, setManager, stop, stopFire, terminate, unlinkToPublishedPort, unlinkToPublishedPort, unregisterPublisherPort, wrapup |
| Methods inherited from class ptolemy.kernel.CompositeEntity |
_adjustDeferrals, _deepOpaqueEntityList, _description, _exportMoMLContents, _recordDecoratedAttributes, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allCompositeEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepEntityList, deepGetEntities, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, lazyAllAtomicEntityList, lazyAllCompositeEntityList, 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.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, 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, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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 |
TypeOpaqueCompositeActor
public TypeOpaqueCompositeActor()
- Construct an actor in the default workspace with an empty string
as its name. The object is added to the workspace directory.
Increment the version number of the workspace.
TypeOpaqueCompositeActor
public TypeOpaqueCompositeActor(Workspace workspace)
- Construct an actor in the specified workspace with 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.
The object is added to the workspace directory.
Increment the version number of the workspace.
- Parameters:
workspace - The workspace that will list the entity.
TypeOpaqueCompositeActor
public TypeOpaqueCompositeActor(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Create a new actor in the specified container with the specified
name. The name must be unique within the container or an exception
is thrown. The container argument must not be null, or a
NullPointerException will be thrown.
- Parameters:
container - The container.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.
newPort
public Port newPort(java.lang.String name)
throws NameDuplicationException
- Create a new TypedIOPort 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 CompositeActor
- Parameters:
name - The name for the new port.
- Returns:
- The new port.
- Throws:
NameDuplicationException - If the actor already has a port
with the specified name.
typeConstraints
public java.util.Set<Inequality> typeConstraints()
- Return the type constraints of this actor.
This is always an empty list because the types of ports
have to be explicitly declared.
- Specified by:
typeConstraints in interface TypedActor
- Returns:
- An empty list.
- See Also:
Inequality
_addPort
protected void _addPort(Port port)
throws IllegalActionException,
NameDuplicationException
- Override the base class to throw an exception if the added port
is not an instance of TypedIOPort. This method should not be used
directly. Call the setContainer() method of the port instead.
This method does not set the container of the port to point to
this entity. It assumes that the port is in the same workspace
as this actor.
Derived classes may override this method to further constrain the
port to be a subclass of TypedIOPort. This method is not
synchronized on the workspace, so the caller should be.
- Overrides:
_addPort in class CompositeActor
- Parameters:
port - The port to add to this actor.
- Throws:
IllegalActionException - If the port is not an instance
of TypedIOPort, or the port has no name.
NameDuplicationException - If the port name coincides with
the name of another port already in the actor.