/* Plot functions of time.
@Copyright (c) 1998-2005 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the
above copyright notice and the following two paragraphs appear in all
copies of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION 2
COPYRIGHTENDKEY
*/
package ptolemy.actor.lib.gui;
import ptolemy.actor.TimedActor;
import ptolemy.actor.TypedIOPort;
import ptolemy.data.DoubleToken;
import ptolemy.data.IntToken;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.plot.Plot;
//////////////////////////////////////////////////////////////////////////
//// TimedPlotter
/**
A signal 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 time.
@author Edward A. Lee
@version $Id: TimedPlotter.java,v 1.29 2005/07/08 19:56:20 cxh Exp $
@since Ptolemy II 1.0
@Pt.ProposedRating Green (eal)
@Pt.AcceptedRating Green (cxh)
*/
public class TimedPlotter extends Plotter implements TimedActor {
/** Construct an actor with the given container and name.
* @param container The container.
* @param name The name of this actor.
* @exception IllegalActionException If the actor cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the container already has an
* actor with this name.
*/
public TimedPlotter(CompositeEntity container, String name)
throws IllegalActionException, NameDuplicationException {
super(container, name);
// Create the input port and make it a multiport.
input = new TypedIOPort(this, "input", true, false);
input.setMultiport(true);
input.setTypeEquals(BaseType.DOUBLE);
}
///////////////////////////////////////////////////////////////////
//// ports and parameters ////
/** Input port, which has type DoubleToken. */
public TypedIOPort input;
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Read at most one input from each channel and plot it as a
* function of time.
* This is done in postfire to ensure that data has settled.
* @exception IllegalActionException If there is no director, or
* if the base class throws it.
* @return True if it is OK to continue.
*/
public boolean postfire() throws IllegalActionException {
double currentTimeValue;
int width = input.getWidth();
int offset = ((IntToken) startingDataset.getToken()).intValue();
for (int i = width - 1; i >= 0; i--) {
if (input.hasToken(i)) {
currentTimeValue = input.getModelTime(i).getDoubleValue();
DoubleToken currentToken = (DoubleToken) input.get(i);
double currentValue = currentToken.doubleValue();
// NOTE: We assume the superclass ensures this cast is safe.
((Plot) plot).addPoint(i + offset, currentTimeValue,
currentValue, true);
}
}
return super.postfire();
}
}