Changes between Version 15 and Version 16 of ScriptBuilderSRS


Ignore:
Timestamp:
11/20/2019 12:56:20 PM (6 years ago)
Author:
jdalbey
Comment:

clean up typos and formatting

Legend:

Unmodified
Added
Removed
Modified

  • ScriptBuilderSRS

    v15 v16  
    101101The 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. 
    102102 
    103 {{{ 
    104 #!html 
    105 <strike> 
    106103Merging Multiple Scripts onto Timeline 
    107104 
    … …  
    110107Extracting a Script from the Timeline 
    111108 
    112 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. )  
    113 </strike>     
    114 }}} 
    115 Page Numbers on Scripts for instructors to use. Was latex. Perhaps PDF. Neal will find what was used before. 
    116  
    117 The Script Builder shall support the ability to put page numbers on generated script notebooks. 
     109The 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. )  
    118110 
    119111=== 2.3 Support for TMC Simulation Control === #two-3 
    120112Simulation Control Events - Overview 
    121113 
    122 The Script Builder shall allow for insertion of control events which drive TMC simulator systems, including ~~the Paramics traffic simulator~~, the CHP CAD simulator, the TMC Simulator Audio System, the Activity Log, and ~~the CCTV video playback system~~. When the user adds a control event, a dialog box shall be presented to the user allowing entry of details regarding the added event. The details regarding the added event are specified by the XML element corresponding to the added event. These XML elements are found in the TMC Simulator XML Script Schema. 
     114The Script Builder shall allow for insertion of control events which drive TMC simulator systems, including ~~the Paramics traffic simulator~~, the CHP CAD simulator, the TMC Simulator Audio System, the Activity Log, the Electronic Instructor Notebook, and ~~the CCTV video playback system~~. When the user adds a control event, a dialog box shall be presented to the user allowing entry of details regarding the added event. The details regarding the added event are specified by the XML element corresponding to the added event. These XML elements are found in the TMC Simulator XML Script Schema. 
    123115 
    124116~~Paramics Control Event~~ 
    … …  
    132124Tow Truck Control Event 
    133125 
    134 The Script Builder shall allow for the  entry of Tow Truck Control Events.   Tow Truck control events allow tows  to be added to the CHP CAD log. Where do these appear in CAD Client? 
     126The Script Builder shall allow for the  entry of Tow Truck Control Events.   Tow Truck control events allow tows to be added to the CHP CAD log. '''Where do these appear in CAD Client?''' 
    135127 
    136128Witness Control Event 
    137129 
    138 The Script Builder shall allow for the  entry of Witness Control Events.  Witness Control Events allow witness  reports to be added to the CHP CAD log. Where do these appear in CAD Client? 
     130The Script Builder shall allow for the  entry of Witness Control Events.  Witness Control Events allow witness  reports to be added to the CHP CAD log. '''Where do these appear in CAD Client?''' 
    139131 
    140132Unit Control Event 
    … …  
    148140CHP Radio, Caltrans Radio, TMT Radio Control Event 
    149141 
    150 The Script Builder shall allow for the entry of radio control events.  Radio control events  can be CHP, Caltrans, or TMT Events. The Script Builder will be able to generate a printable “voice-actor script” from the XML to support the recording of the radio traffic based upon the radio Event. The“voice-actor script” will include the following: the specific words to be read by the voice actor, including call numbers, etc.,the file name that the voice recording should be saved as, any special instructions to the actor(s), and actor identifier to ensure that all recordings for a given role in the field are made by the same person. 
     142The Script Builder shall allow for the entry of radio control events.  Radio control events  can be CHP, Caltrans, or TMT Events. The Script Builder will be able to generate a printable “voice-actor script” from the XML to support the recording of the radio traffic based upon the radio Event. The “voice-actor script” will include the following: the specific words to be read by the voice actor, including call numbers, etc., the file name that the voice recording should be saved as, any special instructions to the actor(s), and actor identifier to ensure that all recordings for a given role in the field are made by the same person. 
    151143 
    152144Telephone Call Control Event 
    … …  
    156148Activity Log Control Event 
    157149 
    158 The Script Builder shall allow for  the entry of Activity Log control events.  Activity Log control events  allow automated entries and hence automatic population of the TMC  Simulator Activity Log, as if it were entered by TMC operators.(Ask  Neil: Is this still required?) 
     150The Script Builder shall allow for the entry of Activity Log control events.  Activity Log control events  allow automated entries and hence automatic population of the TMC  Simulator Activity Log, as if it were entered by TMC operators. '''(Ask  Neil: Is this still required?)''' 
    159151 
    160152Generic Run Script Event suggested by Neil so Sim Mgr can execute a predefined shell script at a given time. 
    … …  
    171163Decision Tree Support 
    172164 
    173 Have they done X yes/no, have they done Y yes/no,have they done Z yes/no, 
     165Have they done X yes/no, have they done Y yes/no, have they done Z yes/no, 
    174166 
    175167probably only 3 levels, then assigns score or grade. 
    176168 
    177 The Script Builder shall support the concept of a decision tree for script that it is used to build.  The content/structure of the decision tree will be developed in conjunction with the development of the script while using the Script Builder, allowing the team designing the new script to articulate what preferred decisions to be made by the students in the simulator are.   It is anticipated that information such as this decision tree will provide some of the basis for a future trainee scoring scheme. Note that this section required further fleshing out. 
    178  
    179 Support for Instructor Electronic Notebooks  Prototype? (Just the paperbinders) 
    180  
    181 “Support” means the design should be able to accommodate these events but probably won't be part of version 1. 
    182  
    183 The Script Builder output shall support the use of electronic script notebooks, allowing the existing instructor notebooks to be replaced with electronic versions running on a devices uch as an iPad, tablet computer, etc.  All files required for operation of the Instructors Electronic Notebook shall be generated by the Script Builder.   Web interface to app syncs with script. 
     169The Script Builder shall support the concept of a decision tree for script that it is used to build.  The content/structure of the decision tree will be developed in conjunction with the development of the script while using the Script Builder, allowing the team designing the new script to articulate what preferred decisions to be made by the students in the simulator are.   It is anticipated that information such as this decision tree will provide some of the basis for a future trainee scoring scheme. Note that this section requires further elaboration. 
     170 
     171Support for Instructor Electronic Notebooks 
     172 
     173The xml files generated by the Script Builder should be able to used as input by Electronic Notebook without any modification. 
    184174 
    185175Traffic Network Scoring 
    186176 
    187 The Script Builder shall support trainee scoring aggregated by highway, direction, time, and speed.  (not sure about the speed here) The end result of such a scheme is that performance will be scored based on the activity in the traffic network, hence indirectly scoring trainee actions as these actions will affect the traffic network score. 
     177The Script Builder shall support trainee scoring aggregated by highway, direction, time, and speed.  (not sure about the speed here) The end result of such a scheme is that performance will be scored based on the activity in the traffic network, hence indirectly scoring trainee actions as these actions will affect the traffic network score.  `Unclear about this.` 
    188178 
    189179Assignment of Scoring Metrics to Specific Instructors 
    … …  
    201191Aggregate TMC Operator Functions 
    202192 
    203 The Script Builder shall support the ability to aggregate multiple TMC operator functions into a individual positions, allowing the TMC simulator to be run with a smaller groupof trainees on the floor.  All scoring, trainee debriefing functionality, etc. shall be aggregated so that scoring options are coherent with position aggregation, which will be set via GUI controls. 
     193The Script Builder shall support the ability to aggregate multiple TMC operator functions into a individual positions, allowing the TMC simulator to be run with a smaller group of trainees on the floor.  All scoring, trainee debriefing functionality, etc. shall be aggregated so that scoring options are coherent with position aggregation, which will be set via GUI controls. 
    204194 
    205195Student Evaluation Events – General 
    … …  
    231221Student Performance Evaluation Event 
    232222 
    233 The Script Builder shallallow for instructors to evaluate student use of Changeable MessageSigns. 
     223The Script Builder shallallow for instructors to evaluate student use of Changeable Message Signs.  (and HAR?) 
    234224 
    235225Facilitator 
    … …  
    255245Sigalerts 
    256246 
    257 The Script Builder shall allow for instructors toevaluate student use of SigAlerts as appropriate to the simulationenvironment. 
     247The Script Builder shall allow for instructors toevaluate student use of SigAlerts as appropriate to the simulation environment. 
    258248 
    259249=== 2.5 Supporting Realism in Training === 
    260250Background Noise 
    261251 
    262 The Script Builder shall allow background noise to be added to a script.  Background noise will not be attached to an incident.  It enhances the realism of the simulation by adding unimportant and unrelated events.  Background noise shall include maintenance radio chatter audio clips, lane closures, TMCAL logs,etc.  Specific background noise events will include animals in the roadway, a wild sprinkler on the freeway, a vehicle with a flat tire,etc. 
     252The Script Builder shall allow background noise to be added to a script.  Background noise will not be attached to an incident.  It enhances the realism of the simulation by adding unimportant and unrelated events.  Background noise shall include maintenance radio chatter audio clips, lane closures, TMCAL logs, etc.  Specific background noise events will include animals in the roadway, a wild sprinkler on the freeway, a vehicle with a flat tire,etc. 
    263253 
    264254Automatic Generation of Organization Chart for Training District (D14 – SantaLucia) Not Needed by Fall 
    … …  
    284274Assignment of Reporter Roles to Specific Instructors 
    285275 
    286 The Script Builder shall allow reporter roles tobe assigned to individual instructors. 
     276The Script Builder shall allow reporter roles to be assigned to individual instructors. 
    287277 
    288278Color Coding Instructor Manuals 
    289279 
    290 The Script Builder shall support showing instructor roles in the instructor manuals using a unique identifiersuch as color. 
     280The Script Builder shall support showing instructor roles in the instructor manuals using a unique identifier such as color. 
    291281 
    292282=== 2.8 Other Training Goals === 
    … …  
    308298 
    309299== 3.ATMS Driver == 
    310 3.1General Requirements 
     300  3.1General Requirements 
    311301 
    312302Control of the ATMS 
    313303 
    314 The ATMS Driver shall allow direct control trafficspeed data into the ATMS. 
     304The ATMS Driver shall allow direct control traffic speed data into the ATMS. 
    315305 
    316306Interface Description 
    317307 
    318 The ATMS Driver shall control the ATMS based onthe yet to be obtained interface descriptions from Caltrans. 
     308The ATMS Driver shall control the ATMS based on the yet to be obtained interface descriptions from Caltrans. 
    319309 
    320310Simulation Manager Interface 
    321311 
    322 The ATMS Driver shall receive all control from theSimulation Manager 
     312The ATMS Driver shall receive all control from the Simulation Manager 
    323313 
    324314Traffic Modeling Capability 
    325315 
    326 Do we want the ATMS Driver to have some trafficmodeling capability or should all control come from the SimulationManager?  Maybe we want to have the simulation manager give itcommands for a section of roadway such as: initiate free-flow trafficon roadway segment x, begin backing up traffic at rate y on roadwaysegment z, etc.? 
    327  
    328   Note: ATMS expects update every 30 sec or it willdisplay white dots instead of colored ones. 
     316Do we want the ATMS Driver to have some trafficmodeling capability or should all control come from the SimulationManager?  Maybe we want to have the simulation manager give it commands for a section of roadway such as: initiate free-flow trafficon roadway segment x, begin backing up traffic at rate y on roadwaysegment z, etc.? 
     317 
     318  Note: ATMS expects update every 30 sec or it will display white dots instead of colored ones. 
    329319 
    3303204.Instructor Electronic Notebook Requirements 
    331321 
    332 4.1GeneralRequirements 
     3224.1 General Requirements 
    333323 
    334324Information Displays 
    335325 
    336 The Instructor Electronic Notebook shall havedisplays of a simulation summary, the simulation script as it isprogressing, a TMC Simulator CHP CAD terminal, an ATMS display, and anavigable roadway map, e.g. Mapquest, Google Maps, etc. 
    337  
    338 The Instructor Electronic Notebook shall displaythe current simulation time in hours, minutes, and seconds on aprominent clock which is always visible. 
     326The Instructor Electronic Notebook shall have displays of a simulation summary, the simulation script as it is progressing, a TMC Simulator CHP CAD terminal, an ATMS display, and a navigable roadway map, e.g. Mapquest, Google Maps, etc. 
     327 
     328The Instructor Electronic Notebook shall display the current simulation time in hours, minutes, and seconds on a prominent clock which is always visible. 
    339329 
    340330Touch Screen Display 
    341331 
    342 The Instructor Electronic Notebook shall utilize atouch-screen display allowing user interaction  via finger touch,stylus, etc. as is appropriate to the platform selected. 
     332The Instructor Electronic Notebook shall utilize atouch-screen display allowing user interaction  via finger touch, stylus, etc. as is appropriate to the platform selected. 
    343333 
    344334Instructor Login and Simulator Operation Duties 
    345335 
    346 The Instructor Electronic Notebook shallautomatically synchronize to the script that the TMC SimulationManager is running. 
    347  
    348 The Instructor Electronic Notebook shall allow theoperator to log in as a specific instructor, binding them topre-determined TMC Simulation support roles and evaluationresponsibilities. 
     336The Instructor Electronic Notebook shall automatically synchronize to the script that the TMC SimulationManager is running. 
     337 
     338The Instructor Electronic Notebook shall allow the operator to log in as a specific instructor, binding them to pre-determined TMC Simulation support roles and evaluation responsibilities. 
    349339 
    350340Indoor Operation 
    351341 
    352 The Instructor Electronic Notebook shall bereadable and useable in all indoor lighting conditions. 
     342The Instructor Electronic Notebook shall be readable and useable in all indoor lighting conditions. 
    353343 
    354344Keyboard and Voice Input 
    355345 
    356 The Instructor Electronic Notebook shall allowkeyboard input, either through an actual keyboard or an electronicscreen-based keyboard. 
    357  
    358 The Instructor Electronic Notebook shall allowinstructors to record voice messages during a simulation viaindividual microphones for the purposes capturing qualitativefeedback. 
    359  
    360 The Instructor Electronic Notebook shall becapable of automatically performing voice recognition functions forrecorded instructor qualitative feedback.  Comment 
     346The Instructor Electronic Notebook shall allow keyboard input, either through an actual keyboard or an electronic screen-based keyboard. 
     347 
     348The Instructor Electronic Notebook shall allow instructors to record voice messages during a simulation via individual microphones for the purposes capturing qualitative feedback. 
     349 
     350The Instructor Electronic Notebook shall be capable of automatically performing voice recognition functions for recorded instructor qualitative feedback.  Comment 
    361351 
    362352Battery Powered Operation 
    363353 
    364 The Instructor Electronic Notebook shall becapable of battery powered operation for periods of at least eighthours. 
     354The Instructor Electronic Notebook shall be capable of battery powered operation for periods of at least eight hours. 
    365355 
    366356Finger Size Accessibility 
    367357 
    368 The Instructor Electronic Notebook shallaccommodate a variety of finger sizes for instructor input of dataand navigation between displays/windows.  Small and large fingersshall work equally well for making GUI selections. 
    369  
    370 4.2SimulationSummary Window 
     358The Instructor Electronic Notebook shall accommodate a variety of finger sizes for instructor input of data and navigation between displays/windows.  Small and large fingers shall work equally well for making GUI selections. 
     359 
     3604.2 Simulation Summary Window 
    371361 
    372362Listing of Incidents 
    373363 
    374 The Instructor Electronic Notebook shall provide alisting of all incidents in the script that is running at the presenttime on the Simulation Manager. 
     364The Instructor Electronic Notebook shall provide a listing of all incidents in the script that is running at the present time on the Simulation Manager. 
    375365 
    376366Incident Information Displayed 
    377367 
    378 The Instructor Electronic Notebook shall the timethe incident starts, the incident number, the name of the incident,and the description of the incident.  Incident summaries shall beable to be collapsed and expanded with simple GUI controls. 
    379  
    380 4.3SimulationScript Window 
    381  
    382 Display and Highlighting of Events on RunningScript Window 
    383  
    384 The Instructor Electronic Notebook shall displaythe events in the script. Each event shall be displayed within aclearly delineated boundary. Using simple GUI controls, the usershall be able to collapse and expand any event. The current eventshall be highlighted with a colored header bar. 
    385  
    386 The Instructor Electronic Notebook shall allow theall the events belonging an incident in the script window to becollapsed or expanded using simple GUI controls. 
     368The Instructor Electronic Notebook shall display the time the incident starts, the incident number, the name of the incident, and the description of the incident.  Incident summaries shall be able to be collapsed and expanded with simple GUI controls. 
     369 
     3704.3 Simulation Script Window 
     371 
     372Display and Highlighting of Events on Running Script Window 
     373 
     374The Instructor Electronic Notebook shall display the events in the script. Each event shall be displayed within a clearly delineated boundary. Using simple GUI controls, the user shall be able to collapse and expand any event. The current event shall be highlighted with a colored header bar. 
     375 
     376The Instructor Electronic Notebook shall allow all the events belonging to an incident in the script window to be collapsed or expanded using simple GUI controls. 
    387377 
    388378Student Evaluations Performed by Instructor 
    389379 
    390 The Instructor Electronic Notebook shallautomatically prompt the user with pop-up windows for quantitativeand qualitative student evaluations which are currently required bythe instructor logged into the given Instructor Electronic Notebook. Instructors shall only be shown pop-up windows that are applicable tothem. 
    391  
    392 The Instructor Electronic Notebook shall allow theinstructor to enter quantitative scoring, e.g. on a scale of 1 to 5,with simple one-touch GUI actions. 
    393  
    394 The Instructor Electronic Notebook shall allow theinstructor to enter qualitative text via a keyboard. 
    395  
    396 Jumping to Different Simulation Times in theDisplay 
    397  
    398 The Instructor Electronic Notebook shall allow theuser to jump directly to the current event using a one-touch GUIaction. 
    399  
    400 The Instructor Electronic Notebook shall allow theuser to jump directly to a specified time as inputted by the user. 
    401  
    402 4.4CHPCAD Terminal Window 
     380The Instructor Electronic Notebook shall automatically prompt the user with pop-up windows for quantitative and qualitative student evaluations which are currently required by the instructor logged into the given Instructor Electronic Notebook. Instructors shall only be shown pop-up windows that are applicable to them. 
     381 
     382The Instructor Electronic Notebook shall allow the instructor to enter quantitative scoring, e.g. on a scale of 1 to 5, with simple one-touch GUI actions. 
     383 
     384The Instructor Electronic Notebook shall allow the instructor to enter qualitative text via a keyboard. 
     385 
     386Jumping to Different Simulation Times in the Display 
     387 
     388The Instructor Electronic Notebook shall allow the user to jump directly to the current event using a one-touch GUI action. 
     389 
     390The Instructor Electronic Notebook shall allow the user to jump directly to a specified time as inputted by the user. 
     391 
     3924.4 CHPCAD Terminal Window 
    403393 
    404394Standard Functionality 
    405395 
    406 The Instructor Electronic Notebook shall provide aCHP CAD terminal with functionality similar to that of the “standard”TMC Simulator CHP CAD terminal. 
    407  
    408 The Instructor Electronic Notebook hall allow theinstructor to view all CHP CAD entries made by students. 
    409  
    410 The Instructor Electronic Notebook shall allow theinstructor to make CHP CAD entries during a simulation. 
    411  
    412 The Instructor Electronic Notebook shallautomatically update as CHP CAD entries are made within the TMCsimulation environment. 
     396The Instructor Electronic Notebook shall provide a CHP CAD terminal with functionality similar to that of the “standard”TMC Simulator CHP CAD terminal. 
     397 
     398The Instructor Electronic Notebook hall allow the instructor to view all CHP CAD entries made by students. 
     399 
     400The Instructor Electronic Notebook shall allow the instructor to make CHP CAD entries during a simulation. 
     401 
     402The Instructor Electronic Notebook shall automatically update as CHP CAD entries are made within the TMC simulation environment. 
    413403 
    414404Flexibility in CHP CAD Control Implementation 
    415405 
    416 The Instructor Electronic Notebook may utilizedifferent CHP CAD controls than those used by the “standard” CHPCAD window as required by the limitations and capabilities of thespecific device used for the Instructor Electronic Notebook. 
    417  
    418 4.5ATMSDisplay Window 
     406The Instructor Electronic Notebook may utilize different CHP CAD controls than those used by the “standard” CHPCAD window as required by the limitations and capabilities of the specific device used for the Instructor Electronic Notebook. 
     407 
     4084.5 ATMS Display Window 
    419409 
    420410Display Simulation Roadway Area 
    421411 
    422 The Instructor Electronic Notebook shall providean ATMS display window which allows instructors to see vehicledetector status of roadways in the simulation area. 
     412The Instructor Electronic Notebook shall provide an ATMS display window which allows instructors to see vehicle detector status of roadways in the simulation area. 
    423413 
    424414Limited ATMS Functionality 
    425415 
    426 The Instructor Electronic Notebook ATMS displayshall not be zoomable. 
    427  
    428 The Instructor Electronic Notebook shall not allowcontrol of various field devices, e.g. CMS, CCTV. 
    429  
    430 4.6SimulationArea Reference Roadway Map Window 
    431  
    432 The Instructor Electronic Notebook shall provide aroadway map with incidents from the simulation area clearly markedfor instructor reference. 
     416The Instructor Electronic Notebook ATMS display shall not be zoomable. 
     417 
     418The Instructor Electronic Notebook shall not allow control of various field devices, e.g. CMS, CCTV. 
     419 
     4204.6 Simulation Area Reference Roadway Map Window 
     421 
     422The Instructor Electronic Notebook shall provide a roadway map with incidents from the simulation area clearly marked for instructor reference. 
    433423 
    434424Limited Functionality 
    435425 
    436 The Instructor Electronic Notebook shall not bezoomable. 
     426The Instructor Electronic Notebook shall not be zoomable.