DRCL J-Sim API

drcl.comp.tool
Class Plotter

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.comp.Component
          extended bydrcl.comp.Extension
              extended bydrcl.comp.tool.Plotter
All Implemented Interfaces:
java.lang.Cloneable, ObjectCloneable, ObjectDuplicable, java.io.Serializable

public class Plotter
extends Extension

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class drcl.comp.Component
Component.Locks
 
Field Summary
 
Fields inherited from class drcl.comp.Component
FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND
 
Constructor Summary
Plotter()
           
Plotter(java.lang.String id_)
           
 
Method Summary
 void addLegend(int plot_, int dataset_, java.lang.String legend_)
           
 int addPlot(int plot_, java.lang.String title_)
           
 void duplicate(java.lang.Object source_)
          Duplicates the content of source_, including ID, name, child components and connections among them, to this component.
 void exportEPS(int plot_, java.lang.String fileName_)
           
 void fill(int plot_)
           
 ptolemy.plot.Plot getPlot(int plot_)
           
 javax.swing.JFrame getPlotFrame(int plot_)
           
 float getRedrawProbability()
           
 java.lang.String info()
          Returns information regarding this component.
 boolean isLimitRedrawEnabled()
          Returns true if limited-redraw is enabled.
 boolean isOutputEnabled()
           
 boolean isPlotEnabled()
           
 void load(java.lang.String fname_)
           
 void load(java.lang.String fname_, int figID_, int setID_)
           
static void main(java.lang.String[] args)
           
 void plotMLLoad(java.lang.String fname_)
          Creates a new plot from a PlotML file.
 void plotMLLoad(java.lang.String fname_, int plotID_)
          Creates a new plot of the specified ID from a PlotML file.
 void plotMLLoad(java.net.URL base_, java.io.InputStream in_, int plotID_)
          Creates a new plot of the specified ID from a PlotML input stream.
 void plotMLOutput(int plot_)
           
 void plotMLOutput(int plot_, java.lang.String fname_)
           
 void plotMLOutput(int plot_, java.io.Writer writer_)
           
 void plotsLoad(java.io.Reader in_)
          Creates new plots from a Plots reader.
 void plotsOutput()
           
 void rawPlotLoad(java.io.Reader in_, int figID_, int setID_)
           
 void removePlot(int plot_)
           
 void repaint(int plot_)
           
 void reset()
          Resets the component for being used anew.
 void setFrameTitle(int plot_, java.lang.String title_)
           
 void setLegend(int plot_, int dataset_, java.lang.String legend_)
           
 void setLimitRedrawEnabled(boolean enabled_)
          If "limit-redraw" is enabled, plots are redrawn according to redraw probability (#setRedrawProbability(double)).
 void setOutputEnabled(boolean enabled_)
           
 void setPlotEnabled(boolean enabled_)
           
 void setRedrawProbability(float prob_)
           
 void setStepwise(int plot_, boolean enabled_)
           
 void setTitle(int plot_, java.lang.String title_)
           
 void setXLabel(int plot_, java.lang.String label_)
           
 void setXLog(int plot_, boolean enabled_)
           
 void setXRange(int plot_, double min_, double max_)
           
 void setYLabel(int plot_, java.lang.String label_)
           
 void setYLog(int plot_, boolean enabled_)
           
 void setYRange(int plot_, double min_, double max_)
           
 void show(int plot_)
          Re-displays the plot if it is not shown on the screen.
 void showAll()
          Re-displays all the plots if they are not shown on the screen.
 
Methods inherited from class drcl.comp.Extension
isExtensionEnabled, setExtensionEnabled
 
Methods inherited from class drcl.comp.Component
addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getID, getName, getParent, getPort, getPort, getRoot, getTime, iduplicate, isAncestorOf, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Plotter

public Plotter()

Plotter

public Plotter(java.lang.String id_)
Method Detail

reset

public void reset()
Description copied from class: Component
Resets the component for being used anew. All the internal variables must be set to the initial state. All the ports and child components are reset as well.

Overrides:
reset in class Component

duplicate

public void duplicate(java.lang.Object source_)
Description copied from class: Component
Duplicates the content of source_, including ID, name, child components and connections among them, to this component. Subclasses need to override this method to copy its own variables.

Specified by:
duplicate in interface ObjectDuplicable
Overrides:
duplicate in class Component

info

public java.lang.String info()
Description copied from class: Component
Returns information regarding this component. Subclasses should override this method to provide useful information at run time.

Overrides:
info in class Component

isPlotEnabled

public boolean isPlotEnabled()

setPlotEnabled

public void setPlotEnabled(boolean enabled_)

isOutputEnabled

public boolean isOutputEnabled()

setOutputEnabled

public void setOutputEnabled(boolean enabled_)

setLimitRedrawEnabled

public void setLimitRedrawEnabled(boolean enabled_)
If "limit-redraw" is enabled, plots are redrawn according to redraw probability (#setRedrawProbability(double)). This is by default enabled.


isLimitRedrawEnabled

public boolean isLimitRedrawEnabled()
Returns true if limited-redraw is enabled.


getRedrawProbability

public float getRedrawProbability()

setRedrawProbability

public void setRedrawProbability(float prob_)

addPlot

public int addPlot(int plot_,
                   java.lang.String title_)

getPlot

public ptolemy.plot.Plot getPlot(int plot_)

removePlot

public void removePlot(int plot_)

getPlotFrame

public javax.swing.JFrame getPlotFrame(int plot_)

fill

public void fill(int plot_)

repaint

public void repaint(int plot_)

show

public void show(int plot_)
Re-displays the plot if it is not shown on the screen.


showAll

public void showAll()
Re-displays all the plots if they are not shown on the screen.


addLegend

public void addLegend(int plot_,
                      int dataset_,
                      java.lang.String legend_)

setLegend

public void setLegend(int plot_,
                      int dataset_,
                      java.lang.String legend_)

exportEPS

public void exportEPS(int plot_,
                      java.lang.String fileName_)

setFrameTitle

public void setFrameTitle(int plot_,
                          java.lang.String title_)

setTitle

public void setTitle(int plot_,
                     java.lang.String title_)

setXLabel

public void setXLabel(int plot_,
                      java.lang.String label_)

setXLog

public void setXLog(int plot_,
                    boolean enabled_)

setXRange

public void setXRange(int plot_,
                      double min_,
                      double max_)

setYLabel

public void setYLabel(int plot_,
                      java.lang.String label_)

setYLog

public void setYLog(int plot_,
                    boolean enabled_)

setStepwise

public void setStepwise(int plot_,
                        boolean enabled_)

setYRange

public void setYRange(int plot_,
                      double min_,
                      double max_)

plotMLOutput

public void plotMLOutput(int plot_,
                         java.lang.String fname_)

plotMLOutput

public void plotMLOutput(int plot_,
                         java.io.Writer writer_)

plotMLOutput

public void plotMLOutput(int plot_)

plotsOutput

public void plotsOutput()

load

public void load(java.lang.String fname_)

load

public void load(java.lang.String fname_,
                 int figID_,
                 int setID_)

plotMLLoad

public void plotMLLoad(java.lang.String fname_)
Creates a new plot from a PlotML file.


plotMLLoad

public void plotMLLoad(java.lang.String fname_,
                       int plotID_)
Creates a new plot of the specified ID from a PlotML file.


plotMLLoad

public void plotMLLoad(java.net.URL base_,
                       java.io.InputStream in_,
                       int plotID_)
Creates a new plot of the specified ID from a PlotML input stream.


plotsLoad

public void plotsLoad(java.io.Reader in_)
Creates new plots from a Plots reader.


rawPlotLoad

public void rawPlotLoad(java.io.Reader in_,
                        int figID_,
                        int setID_)

main

public static void main(java.lang.String[] args)

DRCL J-Sim API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~