Package ptolemy.domains.wireless.lib

Class Locator

  • All Implemented Interfaces:
    java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    Direct Known Subclasses:
    GraphicalLocator
    public class Locator
extends TypedAtomicActor
    This is a wireless sensor node that reacts to an input event by transmitting an output with the current location of this node and the time of the input. The output is a record token with type {location={double}, time=double}. The location is an array with two doubles representing the X and Y positions of the sensor. The location of the sensor is determined by the _getLocation() protected method, which in this base class returns the location of the icon in the visual editor, which is determined from the _location attribute of the actor. If there is no _location attribute, then an exception is thrown. Derived classes may override this protected method to specify the location in some other way (or in more dimensions).
    Since:
    Ptolemy II 4.0
    Version:
    $Id$
    Author:
    Philip Baldwin, Xiaojun Liu and Edward A. Lee
    Pt.AcceptedRating:
    Red (pjb2e)
    Pt.ProposedRating:
    Yellow (eal)

    • Field Detail

      • input

        public WirelessIOPort input
        Port that receives a trigger input that causes transmission of location and time information on the output port.

      • inputChannelName

        public StringParameter inputChannelName
        Name of the input channel. This is a string that defaults to "InputChannel".

      • output

        public WirelessIOPort output
        Port that transmits the current location and the time of the event on the input port. This has type {location={double}, time=double}, a record token.

      • outputChannelName

        public StringParameter outputChannelName
        Name of the output channel. This is a string that defaults to "OutputChannel".

    • Method Detail

      • _getLocation

        protected double[] _getLocation()
                         throws IllegalActionException
        Return the location of this sensor. In this base class, this is determined by looking for an attribute with name "_location" and class Location. Normally, a visual editor such as Vergil will create this icon, so the location will be determined by the visual editor. Derived classes can override this method to specify the location in some other way.
        Returns:
        An array identifying the location.
        Throws:
        IllegalActionException - If the location attribute does not exist or cannot be evaluated.