Results / TimeDataPlotter
Block Name: TimeDataPlotter

Code File Location: VisualSim/actor/lib/gui/TimedPlotter

Block Overview

o View or save the results of the simulation in a XY format.   

o Used to depict latency, throughput and other variables that vary against time. 

Description

This block plots the incoming data on the Y-Axis against the current simulation time on the X-axis. Every wire connected to this block input is considered a separate dataset and plotted separately. The block can display the plot during the simulation and/or save to file. The file name to save is entered in the block parameters.  The order of each dataset is the wire number that can be viewed by a mouse-over on the respective wire.

The block behavior is controlled as follows:

• If there is no PlotManager in the model, then the blocks will save or view based on the settings in the block. 
• If the PlotManager is included in the model, then the Configure Model will create the XML file.  The generated index file will list the Displays/Plotters with view/save and base file names.
• When the simulation is run with the PlotManager scenario, two updates are performed- the index file contains an unique identifier for the run and a set of outputs are written with the identifier as a suffix to the file names.  The unique identifier is a incremental number.  The unique run is determined by the matching of the parameter values from the list in the index file.
• If the parameter combination already exists, then the file is simply overwritten.  If the parameter combination does not exist then the XML is updated with the new number + parameter values.  In this case, the file is created and populated.

To understand the usage of the plotter, view the TimeDataPlotter Example in the BDE. To determine the right file format, view File Format demo.

Parameter	Explanation	Type	Example
fillOnWrapup	This(Checkbox) determines whether to fill the plot when wrapup is invoked.	-	-
legend	The legend is a comma-separated list of labels to attach to each dataset. The number of elements in this list should equal the number of input channels, although this is not enforced.	String	Read,Write
startingDataSet	The index number of the first dataset to start the display. All datasets with number prior to this are not displayed.	Integer	0
viewPlot	If this option is enabled, the plot will be displayed during the simulation.  This must be disabled during batch mode.	-	-
savePlot	If this option is enabled, then the plot will be saved to the File_Name.	-	-
fileName	This block accepts a file name as a parameter. There are a number of file path options available for this block.  To see the list, view the section on File Paths in Reference Guide document here. The file name is a concatenation of any number of individual strings and parameters, separated by "+".  To view the file path in a demo model, click here.	-	-

Port	Explanation	Type
input	This port can accept multiple dataset. Each dataset is associated with a unique color. The plot can accomodate up to 36 colors.	Double

---