Package ptolemy.actor.lib.gui

Class SequencePlotter

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.lib.gui.PlotterBase

ptolemy.actor.lib.gui.Plotter

ptolemy.actor.lib.gui.SequencePlotter

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, PortablePlaceable, SequenceActor, TypedActor, Changeable, Configurable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

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$

Author:

Edward A. Lee, Bart Kienhuis

Pt.AcceptedRating:

Green (cxh)

Pt.ProposedRating:

Green (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
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, _source, _text, automaticRescale, fillOnWrapup, legend, plot

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor	Description
SequencePlotter(CompositeEntity container, java.lang.String name)	Construct an actor with the given container and name.

Method Summary

Modifier and Type	Method	Description
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, _getImplementation, _implementDeferredConfigurations, _isMoMLSuppressed, _newPlot, _propagateValue, cleanUp, clone, configure, getConfigureSource, getConfigureText, place, preinitialize, setContainer, setDisplayName, setFrame, setName, wrapup

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, 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

Parameters:

attribute - The attribute that changed.

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 Initializable

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<TypedIOPort>

Returns:

True if it is OK to continue.

Throws:

IllegalActionException - If there is no director, or if the base class throws it.