DS_xData_yData

Full Library / Result / Plotter / DS_XYPlotter
Block Name: DS_XYPlotter

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

Description

This Plotter displays points on the Plot using values from a data structure arriving on the input port. Fields of the Data Structure This plot displays a maximum of 29 individual datasets from 0 to 28.

The parameters of this block match the fields (or RegEx) of the incoming Data Structure to determine the coordinates, color and trace identifier (Dataset). All DataSets arrive on the same connection to the input port of this block and are differentiated by the color name or integer value. The legend for each dataset can be retrieved from the legend parameter (highest priority and overides everything else), Field_Trace_Name (next priority) or nothing, if both of them are empty. The legend is displayed on the right side of the plot display.

The X- and Y- values can be any RegEx function.

Note: Field names used in the X-, and the Y- parameter must contain the prefix 'input.'.

The block behavior is controlled as follows:

If there is no Post Processor, then the blocks will save or view based on the settings in the block.
If the Post Processor 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 Post Processor 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.

Refer DS_XY-Plotting Demo Model. To determine the right file format to use, check the DS_XY-FileFormat Demo. To just see the use, look at DS_XY demo.

Parameter	Explanation	Type
fillOnWrapup	This(Checkbox) determines whether to fill the plot when wrapup is invoked.	-
legend	The legend is a comma-separated list of strings that identifies each dataset. The names in this field are assigned in order of the colors. This gets the highest precedence in legend assignment for each dataset.	string
startingDataSet	The index number of the first dataset to start the display. All datasets with number prior to this are not displayed.	Integer
Field_Trace_Name	This is a field of the incoming data structure. This is a unique name for each dataset and is used if the Legend parameter is empty.	-
Field_X_Value	This is a RegEx field that can use parameters, memory, fields and any of the standard functions available in the RegEx language. The current simulation time is TNow. Field names must be prefix with 'input.'.	-
Field_Y_Value	This is a RegEx field that can use parameters, memory, fields and any of the standard functions available in the RegEx language. A latency can be written as TNow - input.TIME. Field names must be prefix with 'input.'.	-
Field_Color	Field_Color is the color of the dataset on the plot. The color can be a string or an integer value. The block supports 29 colors. The numbers are 0 to 28. The value can be a field of the incoming data structure and does not require a 'input.' prefix. The colors are in the following order: { "red","blue","cyan","black","orange","cadet_blue","coral","green", "brown","grey","bright_green","indigo","purple","pink","yellow","maroon", "navy_blue","pumpkin","rust","sapphire","burgundy","chocolate", "french_rose","lilac","gold","jade","moss_green","cornflower_blue","aquamarine"}.	-
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 the Basic technology 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
input	Input port has type general. This requires a data structure.

Created with the Personal Edition of HelpNDoc: Create iPhone web-based documentation

DS_xData_yData_Plotter

Description