ptolemy.actor.lib.gui
Class XYPlotter

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.actor.lib.gui.PlotterBase
                              extended byptolemy.actor.lib.gui.Plotter
                                  extended byptolemy.actor.lib.gui.XYPlotter
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Configurable, 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, ptolemy.actor.gui.Placeable, java.io.Serializable, ptolemy.actor.TypedActor
Direct Known Subclasses:
XYScope

public class XYPlotter
extends Plotter

An XY plotter. This plotter contains an instance of the Plot class from the Ptolemy plot package as a public member. Data at inputX and inputY are plotted on this instance. Both inputX and inputY are multiports with type DOUBLE. When plotted, the first channel of inputX and the first channel of inputY are together considered the first signal, then the second channel of inputX and the second channel of inputY are considered the second signal, and so on. This requires that inputX and inputY have the same width. The actor assumes that there is at least one token available on each channel when it fires. The horizontal axis is given by the value of the input from inputX and vertical axis is given by inputY.

Since:
Ptolemy II 1.0
Version:
$Id: XYPlotter.java,v 1.21.2.1 2004/06/18 00:48:55 cxh Exp $
Author:
Jie Liu
See Also:
Serialized Form
Accepted Rating:
Green (cxh)
Proposed Rating:
Green (liuj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.actor.lib.gui.PlotterBase
PlotterBase.PlotterPlotFrame, PlotterBase.PlotWindowTableau
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.actor.TypedIOPort inputX
          Input port for the horizontal axis, with type DOUBLE.
 ptolemy.actor.TypedIOPort inputY
          Input port for the vertical axis, with type DOUBLE.
 
Fields inherited from class ptolemy.actor.lib.gui.Plotter
startingDataset
 
Fields inherited from class ptolemy.actor.lib.gui.PlotterBase
_base, _container, _frame, _plotSize, _source, _text, _windowProperties, fillOnWrapup, legend, plot
 
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
XYPlotter(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 boolean postfire()
          Read at most one token from each channel of each input port and plot it.
 
Methods inherited from class ptolemy.actor.lib.gui.Plotter
attributeChanged, initialize
 
Methods inherited from class ptolemy.actor.lib.gui.PlotterBase
_exportMoMLContents, _implementDeferredConfigurations, _newPlot, _propagateValue, clone, configure, getConfigureSource, getConfigureText, place, preinitialize, setContainer, wrapup
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, connectionsChanged, fire, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, prefire, pruneDependencies, removeDependency, stop, stopFire, terminate
 
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, _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, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, 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
fire, iterate, prefire, stop, stopFire, terminate
 
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

inputX

public ptolemy.actor.TypedIOPort inputX
Input port for the horizontal axis, with type DOUBLE.


inputY

public ptolemy.actor.TypedIOPort inputY
Input port for the vertical axis, with type DOUBLE.

Constructor Detail

XYPlotter

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

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

postfire

public boolean postfire()
                 throws ptolemy.kernel.util.IllegalActionException
Read at most one token from each channel of each input port and plot it. This is done in postfire to ensure that data has settled. The width of the inputs should be the same, otherwise a exception will be thrown. The channels from the two input ports are matched to give the X and Y position of a single data point. Each matched channel pair must have at least one token, or a token will be consumed from the input channel that has a token, but nothing will be plotted.

Returns:
True if it is OK to continue.
Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director, the width of the ports are not the same, or if the base class throws it.