Package ptolemy.actor.lib

Class Sampler

  • All Implemented Interfaces:
    java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    public class Sampler
extends Transformer
    This actor generates discrete events by sampling the input signal whenever the trigger input is present. This sampler will send to the output whatever input occurs at a sample time; if the input is absent, the output will be absent.

    This actor has multiport inputs and outputs. Signals in each input channel are sampled and produced to corresponding output channel. When there are multiple inputs, the first non-absent input from each channel is read, and the output is produced at the first microstep after the last of the inputs became non-absent.

    Since:
    Ptolemy II 8.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Yellow (eal)

    • Field Detail

      • trigger

        public TypedIOPort trigger
        The trigger port, which has undeclared type. If this port receives a token, then the most recent token from the input port will be emitted on the output port.

    • Constructor Detail

      • Sampler

        public Sampler​(CompositeEntity container,
               java.lang.String name)
        throws IllegalActionException,
               NameDuplicationException
        Construct an 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. The actor can be either dynamic, or not. It must be set at the construction time and can't be changed thereafter. A dynamic actor will produce a token at its initialization phase.
        Parameters:
        container - The container of this actor.
        name - The actor's name
        Throws:
        IllegalActionException - If the entity cannot be contained by the proposed container.
        NameDuplicationException - If name coincides with an entity already in the container.

    • Method Detail

      • clone

        public java.lang.Object clone​(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
        Clone this actor into the specified workspace. The new actor is not added to the directory of that workspace (you must do this yourself if you want it there). The result is a new actor with the same ports as the original, but no connections and no container. A container must be set before much can be done with this actor.
        Overrides:
        clone in class TypedAtomicActor
        Parameters:
        workspace - The workspace for the cloned object.
        Returns:
        A new ComponentEntity.
        Throws:
        java.lang.CloneNotSupportedException - If cloned ports cannot have as their container the cloned entity (this should not occur), or if one of the attributes cannot be cloned.
        See Also:
        NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)