Package ptolemy.domains.metroII.kernel

Class MetroIICompositeActor

    • Constructor Detail

      • MetroIICompositeActor

        public MetroIICompositeActor()
        Constructs a MetroIICompositeActor.

      • MetroIICompositeActor

        public MetroIICompositeActor​(Workspace workspace)
        Constructs a MetroIICompositeActor based on a given workspace.
        Parameters:
        workspace - The workspace for this object.

      • MetroIICompositeActor

        public MetroIICompositeActor​(CompositeEntity container,
                             java.lang.String name)
                      throws IllegalActionException,
                             NameDuplicationException
        Constructs a MetroIICompositeActor based on a given container and a name.
        Parameters:
        container - container of the director.
        name - name of this director.
        Throws:
        IllegalActionException - If the director is not compatible with the specified container. May be thrown in a derived class.
        NameDuplicationException - If the container is not a CompositeActor and the name collides with an entity in the container.

    • Method Detail

      • adapter

        public net.jimblackler.Utils.YieldAdapterIterable<java.lang.Iterable<metroIIcomm.Event.Builder>> adapter()
        Returns the iterator for the caller function of getfire().
        Specified by:
        adapter in interface GetFirable
        Returns:
        iterator the iterator for the caller function of getfire()

      • getfire

        public void getfire​(net.jimblackler.Utils.ResultHandler<java.lang.Iterable<metroIIcomm.Event.Builder>> resultHandler)
             throws net.jimblackler.Utils.CollectionAbortedException,
                    IllegalActionException
        getfire() should be identical to fire() except it calls the getfire() of enclosed director instead of fire(). When getfire() is called, the enclosed director should be a MetroII director.

        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:
        getfire in interface GetFirable
        Parameters:
        resultHandler - iterable of events 'yield returned'.
        Throws:
        IllegalActionException
        net.jimblackler.Utils.CollectionAbortedException