ptolemy.actor.lib.gui
Class SequencePlotter

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.SequencePlotter
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Configurable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, Placeable, SequenceActor, java.io.Serializable, TypedActor
Direct Known Subclasses:
SequenceScope, SketchedSource

public class SequencePlotter
extends Plotter
implements SequenceActor

A sequence plotter. This plotter contains an instance of the Plot class from the Ptolemy plot package as a public member. Data at the input, which can consist of any number of channels, are plotted on this instance. Each channel is plotted as a separate data set. The horizontal axis represents the count of the iterations, scaled by the xUnit parameter. The horizontal increment between samples is given by the xUnit parameter. Its default value is 1.0. The horizontal value of the first sample is given by the xInit parameter. Its default value is 0.0. The input is of type DoubleToken.

Since:
Ptolemy II 1.0
Version:
$Id: SequencePlotter.java,v 1.21 2004/04/13 03:06:17 cxh Exp $
Author:
Edward A. Lee, Bart Kienhuis
See Also:
Serialized Form
Accepted Rating:
Green (cxh)
Proposed Rating:
Green (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
Entity.ContainedObjectsIterator
 
Field Summary
protected  double _xInit
          Start of the X axis counter.
protected  double _xUnit
          Increment of the X axis counter.
protected  double _xValue
          X axis counter.
 TypedIOPort input
          Input port, which has type DoubleToken.
 Parameter xInit
          The start point of the X axis.
 Parameter xUnit
          The increment of the X axis.
 
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
SequencePlotter(CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void attributeChanged(Attribute attribute)
          Notification that an attribute has changed.
 void initialize()
          Reset the x axis counter, and call the base class.
 boolean postfire()
          Read at most one token from each input channel and plot it as a function of the iteration number, scaled by xUnit.
 
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

input

public TypedIOPort input
Input port, which has type DoubleToken.


xUnit

public Parameter xUnit
The increment of the X axis.


xInit

public Parameter xInit
The start point of the X axis.


_xValue

protected double _xValue
X axis counter.


_xInit

protected double _xInit
Start of the X axis counter.


_xUnit

protected double _xUnit
Increment of the X axis counter.

Constructor Detail

SequencePlotter

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

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

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException
Notification that an attribute has changed.

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

initialize

public void initialize()
                throws IllegalActionException
Reset the x axis counter, and call the base class. Also, clear the datasets that this actor will use.

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

postfire

public boolean postfire()
                 throws IllegalActionException
Read at most one token from each input channel and plot it as a function of the iteration number, scaled by xUnit. The first point is plotted at the horizontal position given by xInit. The increments on the position are given by xUnit. The input data are plotted in postfire() to ensure that the data have settled.

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