| Home → Documentation Home → Data Products → DP Session File Format |
|---|
Since Trick 10, the DP Session file is changed to XML format. The Session XML Document Type Definitions(DTD) is defined as following:
Session.dtd
<!-- Trick DP Session definition -->
<!-- V 1.0 -->
<!ELEMENT tstart (#PCDATA)>
<!ELEMENT tstop (#PCDATA)>
<!ELEMENT frequency (#PCDATA)>
<!ELEMENT file (#PCDATA)>
<!ELEMENT dir (#PCDATA)>
<!ELEMENT timename (#PCDATA)>
<!ELEMENT run (dir)>
<!ELEMENT product_files (file+)>
<!ELEMENT session ((tstart|tstop|frequency)*, run+, product_files)>
<!ATTLIST run timename CDATA #IMPLIED>
<!ATTLIST session version CDATA #REQUIRED>
<!-- session@presentation attribute
"simple" - One curve per plot. #plots = #runs x #plot_specifications
"comparison" - Multiple runs per plot.
"delta" - difference of two runs.
"contrast" - some weird thing Danny dreamed up.
-->
<!ATTLIST session presentation CDATA #REQUIRED>
<!-- session@mode attribute
Indicates a restriction on what in a DP file.
"plot" - means that only the plots described in a DP file may be created.
"table" - means that only tables described in a DP file may be created.
default - all plots and tables in the DP may be created.
-->
<!ATTLIST session mode CDATA #IMPLIED>
<!ATTLIST session device CDATA #IMPLIED>
<!ATTLIST session gnuplot_terminal CDATA #IMPLIED>
<!ATTLIST session machine CDATA #IMPLIED>
<!ATTLIST session port CDATA #IMPLIED>
The session element is required and is the root element of the Session XML file. It encloses all the other elements.
The optional tstart, tstop child elements of session specify the data within this range gets plotted.
The optional frequency child element of session specifies the delta time between data points for display purposes. If it is smaller than the delta time of the recorded data or if it is not defined, then the recorded data frequency is used. If it is greater than the recorded data delta time, then it is used. It is specified in seconds.
The required run child element of session can occur once or more times. It specifies a simulation RUN_ directory as dir stated from which to retrieve data.
By default, the time name for each run is sys.exec.out.time, however, an optional attribute of each run - timename can be specified if a different name other than the default one is desired.
The required product_files child element of session can only occur once. It specifies product specification file(s) to use for this session. Any number (but at least one) of product specification files may be specified through its file element. In other words, it can have one or more file elements. In general the product specification files specify the type of product parameters to display for the product, and the display attributes for each parameter. Product specification files are discussed in greater detail in Section @ref DPProductFileFormat "6.2 DP Product File Format".
The required version attribute of session specifies the version of this file.
The required presentation attribute of session is only useful when more than one data set is specified. It can be Simple|Comparison|Delta|Contrast. The Simple option will display the data products independently for all data sets specified. The parison option will display the data from all data sets in the same display. The Delta option subtracts the nth data set data from the first data set data and presents the result for data sets 2 through n in the same display. Simple is the default option.
@anchor session_device The device attribute of session specifies the visualization device for data output. By default, the output data is displayed on the user's current login terminal screen. Device types are currently Terminal (default), Printer, and File. @li In order for Printer to work, you need to set your system variables as stated in "Plot Printing".
The gnuplot_terminal attribute of session instructs gnuplot to use the given terminal device for output. The terminals supported are X11, postscript color, postscript, png, eps, and aqua (X11 is the default). The "postscript" terminal yields black-n-white printable files. Thpng will create an image in Portable Network Graphics format. The aqua terminal is for Macintosh and uses native Aqua for plot display.
The optional machine, port attributes of session specify the name of a machine and the port number for plotting.
DP Session File Example
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE session PUBLIC "-//Tricklab//DTD Session V1.0//EN" "Session.dtd">
<session device="Terminal" gnuplot_terminal="" mode="Plot" presentation="Simple" version="1.0">
<tstart>-1.0E20</tstart>
<tstop>1.0E20</tstop>
<frequency>0.0</frequency>
<run>
<dir>/users/hchen/trick_sims/trunk/SIM_Ball++_L1/RUN_realtime</dir>
</run>
<run>
<dir>/users/hchen/trick_sims/trunk/SIM_Ball++_L1/RUN_test</dir>
</run>
<product_files>
<file>/users/hchen/trick_sims/trunk/SIM_Ball++_L1/DP_Product/DP_test_4.xml</file>
<file>/users/hchen/trick_sims/trunk/SIM_Ball++_L1/DP_Product/DP_test_5.xml</file>
</product_files>
</session>