ptolemy.actor.lib.gui
Class XYScope

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
                                      extended byptolemy.actor.lib.gui.XYScope
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

public class XYScope
extends XYPlotter

An X-Y plotter that plots with finite persistence. 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 that take a DoubleToken. 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.

This 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.

If the persistence parameter is positive, then it specifies the number of points that are shown. It defaults to 100, so any point older than 100 samples is erased and forgotten.

Since:
Ptolemy II 1.0
Version:
$Id: XYScope.java,v 1.19 2004/04/13 03:06:31 cxh Exp $
Author:
Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Yellow (neuendor)
Proposed Rating:
Yellow (eal)

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.data.expr.Parameter persistence
          The number of samples from each input channel displayed at any one time (an integer).
 
Fields inherited from class ptolemy.actor.lib.gui.XYPlotter
inputX, inputY
 
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
XYScope(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void attributeChanged(ptolemy.kernel.util.Attribute attribute)
          Notify this that an attribute has changed.
 void initialize()
          Configure the plotter using the current parameter values.
 boolean postfire()
          Call the base class postfire() method, then yield this thread so that the event thread gets a chance.
 
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

persistence

public ptolemy.data.expr.Parameter persistence
The number of samples from each input channel displayed at any one time (an integer).

Constructor Detail

XYScope

public XYScope(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

attributeChanged

public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
                      throws ptolemy.kernel.util.IllegalActionException
Notify this that an attribute has changed. If either parameter is changed, then this actor updates the configuration of the visible plot.

Overrides:
attributeChanged in class Plotter
Throws:
ptolemy.kernel.util.IllegalActionException - If the expression of the attribute cannot be parsed or cannot be evaluated.

initialize

public void initialize()
                throws ptolemy.kernel.util.IllegalActionException
Configure the plotter using the current parameter values.

Specified by:
initialize in interface ptolemy.actor.Executable
Overrides:
initialize in class Plotter
Throws:
ptolemy.kernel.util.IllegalActionException - If the parent class throws it.

postfire

public boolean postfire()
                 throws ptolemy.kernel.util.IllegalActionException
Call the base class postfire() method, then yield this thread so that the event thread gets a chance. This is necessary, because otherwise the swing thread may be starved and accumulate a large number of points waiting to be plotted.

Specified by:
postfire in interface ptolemy.actor.Executable
Overrides:
postfire in class XYPlotter
Returns:
True if it is OK to continue.
Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director, or if the base class throws it.