Changes between Version 1 and Version 2 of ScriptBuilderSRS
- Timestamp:
- 07/25/2017 02:57:09 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ScriptBuilderSRS
v1 v2 1 **TMCSimulation Manager Enhancements** 2 3 4 5 **ScriptBuilder Tool** 6 7 **and** 8 9 **InstructorElectronic Notebook** 10 11 12 13 **Requirements,** 14 15 **ConceptDevelopment, and ** 16 17 **Scope** 18 19 **CaliforniaPolytechnic State University** 20 21 **SanLuis Obispo, California** 1 ScriptBuilder Tool and Instructor Electronic Notebook 2 3 4 Requirements, Concept Development, and Scope 5 6 California Polytechnic State University 7 8 San Luis Obispo, California 22 9 23 10 Table of Contents … … 27 14 \1. Script Builder Tool Requirements 4 28 15 29 1.1 Incidents, Scripts, and Timelines 430 31 1.2 Script Builder File I/O 532 33 1.3 Support for TMC Simulation Control 634 35 1.4 Support for Student Evaluation 736 37 1.5 Supporting Realism in Training 1038 39 1.6 Specifying Expected Traffic Network Performance 1140 41 1.7 Instructor Support 1142 43 1.8 Other Training Goals 1216 1.1 Incidents, Scripts, and Timelines 4 17 18 1.2 Script Builder File I/O 5 19 20 1.3 Support for TMC Simulation Control 6 21 22 1.4 Support for Student Evaluation 7 23 24 1.5 Supporting Realism in Training 10 25 26 1.6 Specifying Expected Traffic Network Performance 11 27 28 1.7 Instructor Support 11 29 30 1.8 Other Training Goals 12 44 31 45 32 \2. Instructor Electronic Notebook Requirements 13 46 33 47 2.1 General Requirements 1348 49 2.2 Simulation Summary Window 1450 51 2.3 Simulation Script Window 1452 53 2.4 CHP CAD Terminal Window 1554 55 2.5 ATMS Display Window 1556 57 2.6 Simulation Area Reference Roadway Map Window 1658 59 # 60 61 #1.Glossary34 2.1 General Requirements 13 35 36 2.2 Simulation Summary Window 14 37 38 2.3 Simulation Script Window 14 39 40 2.4 CHP CAD Terminal Window 15 41 42 2.5 ATMS Display Window 15 43 44 2.6 Simulation Area Reference Roadway Map Window 16 45 46 47 48 1.Glossary 62 49 63 50 ATMS AdvancedTraffic Management System – a tool utilized within Caltrans … … 95 82 Script AnXML file containing all details for all events within one or moreincidents. 96 83 97 ScriptFile A script saved to XML file in a format conformant with the *Simulation Manager & Script XML Schema*.84 ScriptFile A script saved to XML file in a format conformant with theSimulation Manager & Script XML Schema. 98 85 99 86 Timeline Agraphical display of a script. … … 103 90 TMT TrafficManagement Team 104 91 105 #2.Script Builder Tool Requirements106 107 ##2.1Incidents,Scripts, and Timelines108 109 ###Time-basedIncident Display92 2.Script Builder Tool Requirements 93 94 2.1Incidents,Scripts, and Timelines 95 96 Time-basedIncident Display 110 97 111 98 The Script Builder shall allow the entry andmodification of scripts using a timeline. The timeline will show eachincident in the script as a line. Each event, represented by an icon,will be positioned on its corresponding incident's line. Thisdisplay shall show all individual events within a script, e.g. CADdata population, radio traffic, instructor/student phone call, etc.,with icons for each type of event. … … 123 110 The Script Builder shall utilize distinct icons torepresent all events on the timeline. The icons shall besufficiently small so that they can be displayed on the incidentlines in the timeline. The icons shall be sufficiently distinctivefrom one another so that they may be easily differentiated from oneanother by the user. Evaluation event icons shall be identical totheir corresponding control event icons, except that they will bedifferentiated by a unique feature such as an easily visible additionto the icon, e.g. a checkmark, a dot, etc. 124 111 125 ###MergingMultiple Scripts onto Timeline126 127 The Script Builder shall be capable of mergingmultiple independent scripts into a single timeline. A user shall beable to select which incidents to include into the timeline atimport. The start times of these incidents shall be selectable bythe user. 128 129 ###Extracting a Script from the Timeline130 131 The Script Builder shall be capable of extractinga script from the timeline. 132 133 ###IncidentDescription & Summary112 MergingMultiple Scripts onto Timeline 113 114 The Script Builder shall be capable of mergingmultiple independent scripts into a single timeline. A user shall beable to select which incidents to include into the timeline atimport. The start times of these incidents shall be selectable bythe user. (What I think I heard was there are two featuresneeded: import incident and merge script. Import incident is usedwhen building a new script by selecting from a pool of incidents inexternal files. Merge script actually merges the XML by chronology ofevents. Unclear why the latter is needed because it seems toduplicate what can be done with import. The saved incidents allstart at time zero and can be assigned a relative start time whenimported. During editing the incident can be shifted along thetimeline. ) 115 116 Extracting a Script from the Timeline 117 118 The Script Builder shall be capable of extractinga script from the timeline. (I think this means exporting incidents,because the timeline has nothing to be extracted from it butincidents. Export includes all associated resources like audiofiles.) 119 120 IncidentDescription & Summary 134 121 135 122 The Script Builder shall allow incidents to beentered. When an incident is entered, the user will enter informationregarding that incident. Incident information shall include incidentnumber, incident name, color of the incident's line, a description ofthe incident, the start time of the Incident, and the length of theincident. … … 143 130 The user shall be able to remove events fromincidents, by right-clicking on the event's icon and selecting“remove” from a pop-up menu. The user shall be able to remove anevent by clicking on it and pressing the delete key. 144 131 145 ### PageNumbers on Scripts 132 PageNumbers on Scripts for instructors to use. Was latex. Perhaps PDF.Neal will find what was used before. 146 133 147 134 The Script Builder shall support the ability toput page numbers on generated script notebooks. 148 135 149 ##2.2ScriptBuilder File I/O150 151 ### 152 153 ###Script File Format154 155 The Script Builder shall read from and savegenerated scripts to an XML file in conformance with the standard asdetailed in the *Simulation Manager & Script XML Schema. *156 157 ###Openingan existing Script File136 2.2ScriptBuilder File I/O 137 138 139 140 Script File Format 141 142 The Script Builder shall read from and savegenerated scripts to an XML file in conformance with the standard asdetailed in the *Simulation Manager & Script XML Schema. Lookin Google Drive. * 143 144 Openingan existing Script File 158 145 159 146 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. 160 147 161 ###Savinga Script File148 Savinga Script File 162 149 163 150 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. 164 151 165 ## 2.3Supportfor TMC Simulation Control152 2.3 Supportfor TMC Simulation Control 166 153 167 154 Simulation Control Events - General 168 155 169 The Script Builder shall allow for insertion ofcontrol events which drive TMC simulator systems, including theParamics traffic simulator, the CHP CAD simulator, the TMC SimulatorAudio System, the Activity Log, and the TMC Simulator CCTV videoplayback system. When the user adds a control event, a dialog boxshall be presented to the user allowing entry of details regardingthe added event. The details regarding the added event are specifiedby the XML element corresponding to the added event. These XMLelements are found in the *TMC Simulator XML Script Schema*.170 171 ### ParamicsControl Event156 The Script Builder shall allow for insertion ofcontrol events which drive TMC simulator systems, including theParamics traffic simulator, the CHP CAD simulator, the TMC SimulatorAudio System, the Activity Log, and the TMC Simulator CCTV videoplayback system. When the user adds a control event, a dialog boxshall be presented to the user allowing entry of details regardingthe added event. The details regarding the added event are specifiedby the XML element corresponding to the added event. These XMLelements are found in the TMC Simulator XML Script Schema. 157 158 Paramics Control Event 172 159 173 160 The Script shall allow for the entry of Paramicscontrol events. Paramics control events allow modification ofParamics simulation parameters to create incidents, remove incidents,etc. … … 175 162 ATMS Driver Control Events 176 163 177 The Script Builder shall allow for control of theATMS back-end directly, bypassing Paramics. Script Builder controlshall provide the ability to initialize the ATMS from a traffic flowperspective and then create trends, e.g. traffic dots changing fromto green to yellow to red as necessitated by the script. 178 179 ###CHPCAD Control Event164 The Script Builder shall allow for control of theATMS back-end directly, bypassing Paramics. Script Builder controlshall provide the ability to initialize the ATMS from a traffic flowperspective and then create trends, e.g. traffic dots changing fromto green to yellow to red as necessitated by the script. By GPScooord? By freeway section? Ans: each dot is a series of sensorsper freeway lane, so the ATMS aggregates sensor input and allowszooming to increase resolution. 165 166 CHPCAD Control Event 180 167 181 168 The Script Builder shall allow for the entry ofCHP CAD control events. CHP CAD Control Events allow automatedentries and hence automatic population of the data into the TMCSimulator CHP CAD database, as if it were typed by a CHP Dispatcher. … … 191 178 CHP Radio, Caltrans Radio, TMT Radio ControlEvent 192 179 193 The Script Builder shall allow for the entry ofradio control events. Radio control events can be CHP, Caltrans, orTMT Events. The Script Builder will be able to generate a printable“voice-actor script” to support the recording of the radiotraffic based upon the radio Event. The “voice-actor script” willinclude the following: the specific words to be read by the voiceactor, including call numbers, etc., the file name that the voicerecording should be saved as, any special instructions to theactor(s), and actor identifier to ensure that all recordings for agiven role in the field are made by thesame person.180 The Script Builder shall allow for the entry ofradio control events. Radio control events can be CHP, Caltrans, orTMT Events. The Script Builder will be able to generate a printable“voice-actor script” sample? (No, but it's just the XML, whichincludes “special instructions” noted below). to support therecording of the radio traffic based upon the radio Event. The“voice-actor script” will include the following: the specificwords to be read by the voice actor, including call numbers, etc.,the file name that the voice recording should be saved as, anyspecial instructions to the actor(s), and actor identifier to ensurethat all recordings for a given role in the field are made by thesame person. 194 181 195 182 Tow Truck Control Event … … 198 185 199 186 Unit Control 187 200 188 Event 201 189 … … 207 195 208 196 Telephone Call 197 209 198 Control Event 210 199 211 The Script Builder shall allow for the entry ofTelephone control events. Telephone Call control events allow thegeneration of “voice scripts” to be included in the instructor’snotebook which allow the instructor to make relevant telephone calls,e.g. radio reporter, Caltrans headquarters, etc. into the TMC atappropriate times during a simulation. 212 213 ## 2.4Supportfor Student Evaluation 214 215 ### DecisionTree Support 200 The Script Builder shall allow for the entry ofTelephone control events. Telephone Call control events allow thegeneration of “voice scripts” to be included in the instructor’snotebook which allow the instructor to make relevant telephone calls,e.g. radio reporter, Caltrans headquarters, etc. into the TMC atappropriate times during a simulation. SAMPLE? No. 201 202 Generic Run Script Event suggested by Neil so SimMgr can execute a predefined shell script at a given time. 203 204 2.4Supportfor Student Evaluation (ALL INSTRUCTOR NOTEBOOK) or grading sheets. None of this requires anything by Simulation mgr. 205 206 (For version 1 it may be adequate to define a“generic” evaluation event that allows a prompt to instructorand then a choice of how to score: yes/no, 1-5, A-F, 0-100). 207 208 209 210 DecisionTree Support 211 212 Have they done X yes/no, have they done Y yes/no,have they done Z yes/no, 213 214 probably only 3 levels, then assigns score orgrade. 216 215 217 216 The Script Builder shall support the concept of adecision tree for script that it is used to build. Thecontent/structure of the decision tree will be developed inconjunction with the development of the script while using the ScriptBuilder, allowing the team designing the new script to articulatewhat preferred decisions to be made by the students in the simulatorare. It is anticipated that information such as this decision treewill provide some of the basis for a future trainee scoring scheme. Note that this section required further fleshing out. 218 217 219 ### Supportfor Instructor Electronic Notebooks 220 221 The Script Builder output shall support the use ofelectronic script notebooks, allowing the existing instructornotebooks to be replaced with electronic versions running on a devicesuch as an iPad, tablet computer, etc. All files required foroperation of the Instructors Electronic Notebook shall be generatedby the Script Builder. 222 223 ### TrafficNetwork Scoring 218 Supportfor Instructor Electronic Notebooks Prototype? (Just the paperbinders) 219 220 “Support” means the design should be able toaccommodate these events but probably won't be part of version 1. 221 222 The Script Builder output shall support the use ofelectronic script notebooks, allowing the existing instructornotebooks to be replaced with electronic versions running on a devicesuch as an iPad, tablet computer, etc. All files required foroperation of the Instructors Electronic Notebook shall be generatedby the Script Builder. Web interface to app syncs with script. 223 224 TrafficNetwork Scoring 224 225 225 226 The Script Builder shall support trainee scoringaggregated by highway, direction, time, and speed. (not sure aboutthe speed here) The end result of such a scheme is that performancewill be scored based on the activity in the traffic network, henceindirectly scoring trainee actions as these actions will affect thetraffic network score. 226 227 227 ###Assignmentof Scoring Metrics to Specific Instructors228 Assignmentof Scoring Metrics to Specific Instructors 228 229 229 230 The Script Builder shall support the generation ofa script notebook with evaluation events and other evaluation metricsassigned to specific instructors. Other evaluation metrics includesitems to score such as CMS signs, HAR messages, queue protection,etc. 230 231 231 ###AssociateScore with Feedback232 AssociateScore with Feedback 232 233 233 234 The Script Builder shall support the ability toassociate a quantitative score assigned to trainees with feedback,e.g. “Here is your score, here is what you did do correctly, andhere is what you did not do” 234 235 235 ###Debriefby Position236 Debriefby Position 236 237 237 238 The Script Builder shall support the ability todebrief students at the end of a training session by position, e.g.CHP CAD, ATMS, Maintenance Radio, PIO, MIO, Facilitator, etc. … … 243 244 Student Evaluation Events – General 244 245 245 The Script Builder shall allow for insertion ofEvaluation Events which allow instructors to quantitatively andqualitatively measure the performance of student trainees in the TMCSimulator. These Evaluation Events create points in the TMCSimulator instructor notebooks, which can either be printed orelectronic, where instructors will be prompted to evaluate studentperformance in their use of any TMC Simulator system. Instructorevaluations will be a quantified numerical rating, such as a scalefrom 1 to 5, and a written qualitative rating where the instructorcan give direct commentary regarding student performance. Specificmeasures of performance available for each event are articulatedwithin the* * ***TMC Simulator XML Script Schema*. Eachcriteria to evaluate each Evaluation Event is specified in the** ***TMCSimulator XML Script Schema*.246 The Script Builder shall allow for insertion ofEvaluation Events which allow instructors to quantitatively andqualitatively measure the performance of student trainees in the TMCSimulator. These Evaluation Events create points in the TMCSimulator instructor notebooks, which can either be printed orelectronic, where instructors will be prompted to evaluate studentperformance in their use of any TMC Simulator system. Instructorevaluations will be a quantified numerical rating, such as a scalefrom 1 to 5, and a written qualitative rating where the instructorcan give direct commentary regarding student performance. Specificmeasures of performance available for each event are articulatedwithin the* ***TMC Simulator XML Script Schema. Eachcriteria to evaluate each Evaluation Event is specified in the* ***TMCSimulator XML Script Schema. 246 247 247 248 ATMS Utilization 249 248 250 Student Performance Evaluation Event 249 251 … … 251 253 252 254 Activity Log 255 253 256 Utilization Student Performance Evaluation Event 254 257 … … 256 259 257 260 CHP CAD 261 258 262 Utilization Student Performance Evaluation Event 259 263 … … 263 267 264 268 CMS Utilization 269 265 270 Student Performance Evaluation Event 266 271 … … 268 273 269 274 Facilitator 275 270 276 Student Performance Evaluation Event 271 277 … … 277 283 278 284 CCTV Utilization 285 279 286 Student Performance Evaluation Event 280 287 … … 285 292 The Script Builder shallallow for instructors to evaluate student use of the telephone.Telephone evaluation events shall allow instructors to determine ifstudents have provided them complete answers to their phone calls,including information such as callback numbers, number of lanesclosed, fatalities, etc. 286 293 287 ### 288 289 ###Sigalerts294 295 296 Sigalerts 290 297 291 298 The Script Builder shall allow for instructors toevaluate student use of SigAlerts as appropriate to the simulationenvironment. 292 299 293 ##2.5SupportingRealism in Training294 295 ###BackgroundNoise300 2.5SupportingRealism in Training 301 302 BackgroundNoise 296 303 297 304 The Script Builder shall allow background noise tobe added to a script. Background noise will not be attached to anincident. It enhances the realism of the simulation by addingunimportant and unrelated events. Background noise shall includemaintenance radio chatter audio clips, lane closures, TMCAL logs,etc. Specific background noise events will include animals in theroadway, a wild sprinkler on the freeway, a vehicle with a flat tire,etc. 298 305 299 ### AutomaticGeneration of Organization Chart for Training District (D14 – SantaLucia) 306 AutomaticGeneration of Organization Chart for Training District (D14 – SantaLucia) Not Needed by Fall 300 307 301 308 The Script Builder shall support the automaticgeneration of an organizational chart which will be used by bothstudents and instructors in the back room and be coherent with allevents in the generated instructor scripts. 302 309 303 ###Injectionof Minor Incidents304 305 The Script Builder shall support the automaticgeneration of secondary incidents if queue protection is notimplemented by trainees as appropriate. This requirement impliesthat the Script Builder can encode for and the Simulation Managershall be capable of dynamically adding an incident during asimulation. 306 307 ###MinorIncidents310 Injectionof Minor Incidents 311 312 The Script Builder shall support the automaticgeneration of secondary incidents if queue protection is notimplemented by trainees as appropriate. This requirement impliesthat the Script Builder can encode for and the Simulation Managershall be capable of dynamically adding an incident during asimulation. 313 314 MinorIncidents 308 315 309 316 The Script Builder shall be capable of generatinga false incident which students will discover is such when theattempt to user available verification tools. Potential steps toimplement a false incident are: 1.) start a log entry 2.) dispatch aunit 3.) survey area with surveillance tools, ATMS, etc. 4.)discover the incident does not exist. Comment 310 317 311 ## 2.6SpecifyingExpected Traffic Network Performance 312 313 ### DeterminingQueue Length 318 (Minor incidents are simply incidents but narrowerin scope than typical incidents. Ideally they are displayed at thebottom of the edit canvas. Perhaps be able to “flag” an incidentas minor.) 319 320 2.6SpecifyingExpected Traffic Network Performance 321 322 DeterminingQueue Length - amount of traffic backup May be obsolete as we arereplacing paramics. 314 323 315 324 The Script Builder shall allow the desired queuelength for an incident to be specified. Potential methods toaccomplish this feature are yet to be determined. Please note thatthis is related to the ATMS Driver and the control it asserts uponthe ATMS. 316 325 317 ##2.7InstructorSupport318 319 ###Assignmentof Reporter Roles to Specific Instructors326 2.7InstructorSupport 327 328 Assignmentof Reporter Roles to Specific Instructors 320 329 321 330 The Script Builder shall allow reporter roles tobe assigned to individual instructors. 322 331 323 ###ColorCoding Instructor Manuals332 ColorCoding Instructor Manuals 324 333 325 334 The Script Builder shall support showinginstructor roles in the instructor manuals using a unique identifiersuch as color. 326 335 327 ##2.8OtherTraining Goals328 329 ###DedicatedCHP CAD Training336 2.8OtherTraining Goals 337 338 DedicatedCHP CAD Training 330 339 331 340 The Script Builder shall be capable of supportingthe development of CAD scripts, which the Simulation Manager can useto populate the CAD for the purpose of CAD specific training. 332 341 333 ###EOCTraining342 EOCTraining 334 343 335 344 The Script Builder shall support EOC training. 336 345 337 ###Trainingfor TMC & District Management346 Trainingfor TMC & District Management 338 347 339 348 The Script Builder shall support the developmentof training scenarios customized to TMC and District Management. 340 349 341 ###GeneralizedTransportation Training350 GeneralizedTransportation Training 342 351 343 352 The Script Builder shall support the developmentof training scripts related to other modes of transportation, e.g.buses, trains, etc. 344 353 345 #3.ATMS Driver346 347 ##3.1General Requirements348 349 ###Control of the ATMS354 3.ATMS Driver 355 356 3.1General Requirements 357 358 Control of the ATMS 350 359 351 360 The ATMS Driver shall allow direct control trafficspeed data into the ATMS. 352 361 353 ###Interface Description362 Interface Description 354 363 355 364 The ATMS Driver shall control the ATMS based onthe yet to be obtained interface descriptions from Caltrans. 356 365 357 ###Simulation Manager Interface366 Simulation Manager Interface 358 367 359 368 The ATMS Driver shall receive all control from theSimulation Manager 360 369 361 ###Traffic Modeling Capability370 Traffic Modeling Capability 362 371 363 372 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.? 364 373 365 366 367 #4.Instructor Electronic Notebook Requirements368 369 ##4.1GeneralRequirements374 Note: ATMS expects update every 30 sec or it willdisplay white dots instead of colored ones. 375 376 4.Instructor Electronic Notebook Requirements 377 378 4.1GeneralRequirements 370 379 371 380 Information Displays … … 405 414 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. 406 415 407 ##4.2SimulationSummary Window416 4.2SimulationSummary Window 408 417 409 418 Listing of Incidents … … 415 424 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. 416 425 417 ##4.3SimulationScript Window426 4.3SimulationScript Window 418 427 419 428 Display and Highlighting of Events on RunningScript Window … … 437 446 The Instructor Electronic Notebook shall allow theuser to jump directly to a specified time as inputted by the user. 438 447 439 ##4.4CHPCAD Terminal Window448 4.4CHPCAD Terminal Window 440 449 441 450 Standard Functionality … … 453 462 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. 454 463 455 ##4.5ATMSDisplay Window464 4.5ATMSDisplay Window 456 465 457 466 Display Simulation Roadway Area … … 465 474 The Instructor Electronic Notebook shall not allowcontrol of various field devices, e.g. CMS, CCTV. 466 475 467 ##4.6SimulationArea Reference Roadway Map Window476 4.6SimulationArea Reference Roadway Map Window 468 477 469 478 The Instructor Electronic Notebook shall provide aroadway map with incidents from the simulation area clearly markedfor instructor reference.
