DS_xTime_yData

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

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

Description

This Plotter block generates a timing diagram for a sequence of data structures placed on the input port. The plot will display high and low value for each dataset or signal. The block will only display a sequence of 0/0.0 and 1/1.0 values for the Y-axis. Each dataset is uniquely distinguished by the offset parameter value. The offset is the height from the 0.0 of the Y-axis. For a Offset of 4, the 0 value is at 4 and the 1 is at value 5. The Simulation Time is on the X-axis and the Datasets are on the Y-axis. The Field_Trace_Name is the legend on the Y-axis for the particular dataset and will be denoted at the Offset value + 0.2.

The legend name (Field_Trace_Name), Y-value (value to be plotted), dataset color(display point color) and dataset offset (from Y-axis point of 0.0) are all defined in the fields of the incoming data structure. The Y-value field can be a RegEx function.

Note: The Y_Value field name 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.

To understand the usage of the plotter, view the DS_xTime_yData_Plotter Example in the BDE.

Parameter	Explanation	Type
fillOnWrapup	This(Checkbox) determines whether to fill the plot when the simulation terminates.	-
legend	Field not used
startingDataSet	Field not used.
Field_Trace_Name	This is a unique legend for this Dataset and will be the displayed on the Y-axis of the Plot. This is a field of the incoming data structure. If no value is provided in this field, the Y-axis will not display any values. It must NOT be prefix with input.	String
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. If a field is used, it must be prefix with 'input.'. The value can be only 1 and 0 or 0.0 and 1.0.	integer
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"}.	String or Integer
Field_Offset	Field_Offset is a unique integer number of values from the Y-axis 0.0. A field must be of the format field_name. It must NOT be prefix with input.	-
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