Changes between Version 5 and Version 6 of ScriptBuilderSRS


Ignore:
Timestamp:
07/27/2017 06:35:30 PM (9 years ago)
Author:
jdalbey
Comment:

draft

Legend:

Unmodified
Added
Removed
Modified
  • ScriptBuilderSRS

    v5 v6  
    99== Table of Contents == 
    1010 
    11 1. Glossary     2[[BR]] 
    12 1. Script Builder Tool Requirements     4[[BR]] 
    13  1. Incidents,  Scripts, and Timelines  4[[BR]] 
    14  1. Script      Builder File I/O        5[[BR]] 
    15  1. Support for TMC Simulation Control  6[[BR]] 
    16  1. Support for Student Evaluation      7[[BR]] 
    17  1. Supporting  Realism in Training     10[[BR]] 
    18  1. Specifying  Expected Traffic Network Performance    11[[BR]] 
    19  1. Instructor  Support 11[[BR]] 
    20  1. Other       Training Goals  12[[BR]] 
    21 1. Instructor Electronic Notebook Requirements  13[[BR]] 
    22  1. General     Requirements    13[[BR]] 
    23  1. Simulation  Summary Window  14[[BR]] 
    24  1. Simulation  Script Window   14[[BR]] 
    25  1. CHP CAD     Terminal Window 15[[BR]] 
    26  1. ATMS Display        Window  15[[BR]] 
    27  1. Simulation  Area Reference Roadway Map Window       16[[BR]] 
     111. Glossary     [[BR]] 
     121. Script Builder Tool Requirements     [[BR]] 
     13 1. Incidents,  Scripts, and Timelines  [[BR]] 
     14 1. Script      Builder File I/O        [[BR]] 
     15 1. Support for TMC Simulation Control  [[BR]] 
     16 1. Support for Student Evaluation      [[BR]] 
     17 1. Supporting  Realism in Training     [[BR]] 
     18 1. Specifying  Expected Traffic Network Performance    [[BR]] 
     19 1. Instructor  Support [[BR]] 
     20 1. Other       Training Goals  [[BR]] 
     211. Instructor Electronic Notebook Requirements  [[BR]] 
     22 1. General     Requirements    [[BR]] 
     23 1. Simulation  Summary Window  [[BR]] 
     24 1. Simulation  Script Window   [[BR]] 
     25 1. CHP CAD     Terminal Window [[BR]] 
     26 1. ATMS Display        Window  [[BR]] 
     27 1. Simulation  Area Reference Roadway Map Window       [[BR]] 
    2828 
    2929== 1. Glossary == 
     
    6060 
    6161 Script:: A chronological list of hypothetical traffic incidents for training purposes that can be played through the Simulation Manager.  
    62  Script File::  A script saved to XML file in a format conformant with the Simulation Manager & Script XML Schema. An XML file containing all details for all events within one or more incidents. The events are saved in chronological order (not grouped by incident). 
    63  
     62 Script File::  A script saved to XML file in a format conformant with the Simulation Manager &   Script XML Schema. An XML file containing all details for all events within one or more incidents. The events are saved in chronological order (not grouped by incident). 
    6463 Timeline:: A horizontal line in a graphical display that represents the chronology of incidents in a script. 
    65  
    66 Traffic Dot     A colored dot as displayed on the ATMS with green indicating free-flow traffic, yellow indicating moderate reductions in speed/flow, and red indicating sever reductions in speed/flow. 
    67  
    68 TMT     Traffic Management Team  
     64 Traffic Dot:: A colored dot as displayed on the ATMS with green indicating free-flow traffic, yellow indicating moderate reductions in speed/flow, and red indicating sever reductions in speed/flow. 
     65 TMT::Traffic Management Team  
    6966 
    7067== 2.Script Builder Tool Requirements == 
     
    7269=== 2.1 Scripts, Timelines, and Incidents === 
    7370 
    74 ==== 1. Creating a new Script ==== 
    75  
    76 A new script may be created which presents an empty timeline. 
    77  
    78 ==== 1. Saving a Script ==== 
    79  
    80 Saving a script causes the script and all the incidents it contains to be saved in XML format to an external file. 
    81  
    82 Adding a new Incident  
     71====  2.1.1 Creating a new Script ==== 
     72 
     73Creating a new script shows an empty timeline available for incidents to be added or inserted. 
     74 
     75====  2.1.2 Saving a Script ==== 
     76 
     77Saving a script causes the script and all the incidents it contains to be saved in XML format to an external file in conformance with the standard as detailed in the *Simulation Manager & Script XML Schema.  (Look in Google Drive). 
     78 
     79==== 2.1.3 Adding a new Incident ====  
    8380 
    8481A new incident may be added to the script. When an incident is created the user will enter the properties of that incident: incident number, incident name, color of the incident's line, a description of the incident, the start time of the Incident, and the length of the incident. (Note, we are considering omitting incident number). 
    8582 
    86 Editing Incident Properties 
    87  
    88 An incident's properties may be modified after it has been created. 
     83==== 2.1.4 Editing Incident Properties ==== 
     84 
     85An incident's properties may be modified after it has been created. An incident's starting time may be adjusted. 
    8986 
    9087Editing Incident Events 
     
    10299Saving an Incident 
    103100 
    104 Saving an incident saves all the incident properties and the events it contains in XML format to an external file. 
     101Saving an incident saves all the incident properties and the events it contains in XML format to an external file.  Saving also includes all associated resources like audiofiles.  Saving will present a custom dialog (instead of a standard file chooser) that constrains the filename that can be used to store the incident data.  
     102 
     103Incident Extractor Wizard 
     104 
     105This wizard allows the user to load a script and extract incidents from it. 
    105106 
    106107Event Entry 
     
    128129The Script Builder shall utilize distinct icons to represent all events on the timeline.  The icons shall be sufficiently small so that they can be displayed on the incident lines in the timeline.  The icons shall be sufficiently distinctive from one another so that they may be easily differentiated from one another by the user.  Evaluation event icons shall be identical to their corresponding control event icons, except that they will be differentiated by a unique feature such as an easily visible addition to the icon, e.g. a checkmark, a dot, etc. 
    129130 
     131{{{ 
     132#!html 
     133<strike> 
    130134Merging Multiple Scripts onto Timeline 
    131135 
     
    134138Extracting a Script from the Timeline 
    135139 
    136 The Script Builder shall be capable of extracting a script from the timeline.  (I think this means exporting incidents,because the timeline has nothing to be extracted from it but incidents. Export includes all associated resources like audiofiles.)      
     140The Script Builder shall be capable of extracting a script from the timeline.  (I think this means exporting incidents,because the timeline has nothing to be extracted from it but incidents. )  
     141</strike>     
     142}}} 
    137143 
    138144Page Numbers on Scripts for instructors to use. Was latex. Perhaps PDF. Neal will find what was used before. 
     
    140146The Script Builder shall support the ability to put page numbers on generated script notebooks. 
    141147 
    142 2.2 ScriptBuilder File I/O 
    143  
    144  
    145  
    146 Script File Format 
    147  
    148 The Script Builder shall read from and save generated scripts to an XML file in conformance with the standard as detailed in the *Simulation Manager & Script XML Schema.  Look in Google Drive. * 
    149  
    150 Opening an existing Script File 
    151  
    152 The Script Builder shall allow the user to open ascript using standard Windows controls such as a pull-down menu (File-> Open) and/or an icon.  
    153  
    154 Savinga Script File 
    155  
    156 The Script Builder shall allow the user to save anscript to file with a name of their choice or save changes to anexisting script using standard Windows controls such as  pull-downmenus (File->Save and File->Save As) and/or an icon. 
    157  
    158 2.3 Supportfor TMC Simulation Control 
     148 
     149 
     1502.3 Support for TMC Simulation Control 
    159151 
    160152Simulation Control Events - General