Package ptolemy.actor

Class TypeOpaqueCompositeActor

  • All Implemented Interfaces:
    java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    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$
    Author:
    Elaine Cheong and Edward A. Lee
    See Also:
    TypedCompositeActor, TypedIOPort
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)

    • Constructor Detail

      • 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.

    • Method Detail

      • isBackwardTypeInferenceEnabled

        public boolean isBackwardTypeInferenceEnabled()
        Return false because backward type inference is not implemented for this actor.
        Specified by:
        isBackwardTypeInferenceEnabled in interface TypedActor
        Returns:
        false

      • 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.