Package ptolemy.domains.tm.lib

Class TMCompositeFacade

    • Field Detail

      • executionTime

        public Parameter executionTime
        The default execution time.

      • priority

        public Parameter priority
        Priority of the background process.

    • Constructor Detail

      • TMCompositeFacade

        public TMCompositeFacade​(CompositeEntity container,
                         java.lang.String name)
                  throws NameDuplicationException,
                         IllegalActionException
        Construct an actor with the specified container and name. There is one parameter which is the full class name of a Ptolemy actor. This actor has no ports.
        Parameters:
        container - The container.
        name - The name.
        Throws:
        IllegalActionException - If the actor cannot be contained by the proposed container.
        NameDuplicationException - If the name coincides with an actor already in the container.

    • Method Detail

      • prefire

        public boolean prefire()
                throws IllegalActionException
        Description copied from class: CompositeActor
        If this actor is opaque, invoke the prefire() method of the local director. This method returns true if the actor is ready to fire (determined by the prefire() method of the director). It is read-synchronized on the workspace.
        Specified by:
        prefire in interface Executable
        Overrides:
        prefire in class CompositeActor
        Returns:
        True if the iteration can proceed.
        Throws:
        IllegalActionException - If there is no director, or if the director's prefire() method throws it, or if this actor is not opaque.

      • fire

        public void fire()
          throws IllegalActionException
        Description copied from class: CompositeActor
        If this actor is opaque, transfer any data from the input ports of this composite to the ports connected on the inside, and then invoke the fire() method of its local director. The transfer is accomplished by calling the transferInputs() method of the local director (the exact behavior of which depends on the domain). If the actor is not opaque, throw an exception. This method is read-synchronized on the workspace, so the fire() method of the director need not be (assuming it is only called from here). After the fire() method of the director returns, send any output data created by calling the local director's transferOutputs method.
        Specified by:
        fire in interface Executable
        Overrides:
        fire in class CompositeActor
        Throws:
        IllegalActionException - If there is no director, or if the director's fire() method throws it, or if the actor is not opaque.

      • postfire

        public boolean postfire()
                 throws IllegalActionException
        Description copied from class: CompositeActor
        If this actor is opaque, invoke the postfire() method of its local director and transfer output data. Specifically, transfer any data from the output ports of this composite to the ports connected on the outside. The transfer is accomplished by calling the transferOutputs() method of the executive director. If there is no executive director, then no transfer occurs. This method is read-synchronized on the workspace.
        Specified by:
        postfire in interface Executable
        Overrides:
        postfire in class CompositeActor
        Returns:
        True if the execution can continue into the next iteration.
        Throws:
        IllegalActionException - If there is no director, or if the director's postfire() method throws it, or if this actor is not opaque.

      • getExecutionTime

        public double getExecutionTime()
        Description copied from interface: TMActor
        Return the execution time for this iteration. This method will be called by the TMDirector after the prefire() method is called. The reason for this method is to allow the actor to determine/estimate its execution time on a per iteration basis.
        Specified by:
        getExecutionTime in interface TMActor
        Returns:
        The execution time for this iteration.