ptolemy.domains.wireless.lib
Class Locator

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.domains.wireless.lib.Locator
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor
Direct Known Subclasses:
GraphicalLocator

public class Locator
extends ptolemy.actor.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: Locator.java,v 1.10 2004/04/13 03:38:15 cxh Exp $
Author:
Philip Baldwin, Xiaojun Liu and Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Red (pjb2e)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 WirelessIOPort input
          Port that receives a trigger input that causes transmission of location and time information on the output port.
 ptolemy.data.expr.StringParameter inputChannelName
          Name of the input channel.
 WirelessIOPort output
          Port that transmits the current location and the time of the event on the input port.
 ptolemy.data.expr.StringParameter outputChannelName
          Name of the output channel.
 
Fields inherited from class ptolemy.actor.AtomicActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
Locator(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the specified container and name.
 
Method Summary
protected  double[] _getLocation()
          Return the location of this sensor.
 void fire()
          Generate an event on the output port that indicates the current position and time of the last input on the input port.
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

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 ptolemy.data.expr.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 ptolemy.data.expr.StringParameter outputChannelName
Name of the output channel. This is a string that defaults to "OutputChannel".

Constructor Detail

Locator

public Locator(ptolemy.kernel.CompositeEntity container,
               java.lang.String name)
        throws ptolemy.kernel.util.NameDuplicationException,
               ptolemy.kernel.util.IllegalActionException
Construct an actor with the specified container and name.

Parameters:
container - The container.
name - The name.
Throws:
ptolemy.kernel.util.IllegalActionException - If the entity cannot be contained by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If the container already has an actor with this name.
Method Detail

fire

public void fire()
          throws ptolemy.kernel.util.IllegalActionException
Generate an event on the output port that indicates the current position and time of the last input on the input port. The value of the input is ignored.

Throws:
ptolemy.kernel.util.IllegalActionException

_getLocation

protected double[] _getLocation()
                         throws ptolemy.kernel.util.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:
ptolemy.kernel.util.IllegalActionException - If the location attribute does not exist or cannot be evaluated.