Changes between Version 10 and Version 11 of ScriptBuilderSRS
- Timestamp:
- 07/02/2019 11:50:58 AM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ScriptBuilderSRS
v10 v11 1 1 = !ScriptBuilder Tool and Instructor Electronic Notebook = 2 3 4 Requirements, Concept Development, and Scope[[BR]] 5 California Polytechnic State University[[BR]] 6 San Luis Obispo, California[[BR]] 7 2 Requirements, Concept Development, and Scope[[BR]] California Polytechnic State University[[BR]] San Luis Obispo, California[[BR]] 8 3 9 4 == Table of Contents == 10 11 1. Glossary [[BR]] 12 1. [#two Script Builder Tool Requirements] [[BR]] 13 1. [#two-1 Scripts, Incidents, and Events] [[BR]] 14 1. [#two-2 Graphical User Interface Requirements] [[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]] 21 1. 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]] 5 1. Glossary [[BR]] 6 1. [#two Script Builder Tool Requirements] 7 1. [#two-1 Scripts, Incidents, and Events] [[BR]] 8 1. [#two-2 Graphical User Interface Requirements] [[BR]] 9 1. Support for TMC Simulation Control [[BR]] 10 1. Support for Student Evaluation [[BR]] 11 1. Supporting Realism in Training [[BR]] 12 1. Specifying Expected Traffic Network Performance [[BR]] 13 1. Instructor Support [[BR]] 14 1. Other Training Goals [[BR]] 15 1. Instructor Electronic Notebook Requirements 16 1. General Requirements [[BR]] 17 1. Simulation Summary Window [[BR]] 18 1. Simulation Script Window [[BR]] 19 1. CHP CAD Terminal Window [[BR]] 20 1. ATMS Display Window [[BR]] 21 1. Simulation Area Reference Roadway Map Window [[BR]] 28 22 29 23 == 1. Glossary == 30 31 ATMS:: Advanced Traffic Management System – a tool utilized within Caltrans 32 CHP CAD:: California Highway Patrol (CHP) Computer Aided Dispatch (CAD) 33 CCTV:: Closed circuit television – used to monitor roadways remotely from a TMC. 34 CMS:: Changeable Message Sign 35 Control Event:: Control events cause the TMC Simulation Manager to perform actions which affect the simulation environment as seen on the simulation floor, e.g. modify the Paramics simulation, play an audioclip, send a message to CHP CAD, etc. 24 ATMS:: Advanced Traffic Management System – a tool utilized within Caltrans 25 CHP CAD:: California Highway Patrol (CHP) Computer Aided Dispatch (CAD) 26 CCTV:: Closed circuit television – used to monitor roadways remotely from a TMC. 27 CMS:: Changeable Message Sign 28 Control Event:: Control events cause the TMC Simulation Manager to perform actions which affect the simulation environment as seen on the simulation floor, e.g. modify the Paramics simulation, play an audioclip, send a message to CHP CAD, etc. 36 29 Evaluation Event:: Evaluation events are used to prompt instructors to perform an evaluation action for students in training, e.g. grade their CMSmessage, phone response, etc. 37 30 Event:: An occurrence at a particular time of an incident. Control events and evaluation events are kinds of event. 38 31 Event Icon:: An image that represents an event. AKA Icon. 39 Incident:: A complete set of events associated with a specific incident number within the TMC Simulator. This ID number shall match the CHP CAD log identifier. 32 Incident:: A complete set of events associated with a specific incident number within the TMC Simulator. This ID number shall match the CHP CAD log identifier. 40 33 Noise:: Background events within a simulation which may not have a significant immediate effect on traffic but require attention and resources from traffic managers working in the TMC. Examples of noise are things like a stalled vehicle on the shoulder, sprinklers spraying in the roadway,maintenance crews working on roadway in structure, etc. 41 Icon:: An image that represents an event. AKA Event icon. 42 Incident Number:: A number that identifies an incident. 43 Incident Name:: A short name that is used to refer to an incident. 34 Icon:: An image that represents an event. AKA Event icon. 35 Incident Number:: A number that identifies an incident. 36 Incident Name:: A short name that is used to refer to an incident. 44 37 Incident Line:: A graphical line in the timeline. An incident line represents an incident. 45 38 LCS:: Lane Closure System – a tool used by Caltrans to manage lane closures within the highway system. 46 39 Paramics:: A tool which performs microscopic traffic simulation of the traffic network. Note that Paramics is planned for deprecation from the TMCsimulator. 47 Script:: A chronological list of hypothetical traffic incidents for training purposes that can be played through the Simulation Manager. 48 Script File:: 40 Script:: A chronological list of hypothetical traffic incidents for training purposes that can be played through the Simulation Manager. 41 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). 49 42 Timeline:: A horizontal line in a graphical display that represents the chronology of incidents in a script. 50 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. 51 TMT::Traffic Management Team 43 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. TMT::Traffic Management Team 52 44 53 45 == 2.Script Builder Tool Requirements == #two 54 55 46 === 2.1 Scripts, Incidents, and Events === #two-1 56 57 ==== 2.1.1 Creating a new Script ==== 58 47 ==== 2.1.1 Creating a new Script ==== 59 48 Creating a new script clears any current script and makes the workspace available for incidents to be added or inserted. A script title must be provided when a new script is created. 60 49 61 50 ==== 2.1.2 Load an existing Script ==== 62 63 51 Load an existing Script from a saved XML file and display an overview of all the incidents. (Clears any current script). 64 52 65 53 ==== Saving a Script ==== 66 67 54 Saving 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). 68 55 69 ==== Adding a new Incident ==== 70 56 ==== Adding a new Incident ==== 71 57 A 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). 72 58 73 59 ==== Update Incident Properties ==== 74 75 60 An incident's properties may be modified after it has been created, including adjusting starting time. 76 61 77 62 ==== Editing Incident Events ==== 78 79 63 Editing an incident makes it available for events to be added, modified, and removed. 80 64 81 65 ==== Deleting an Incident ==== 82 83 66 Erases all the incident properties and events from the timeline. 84 67 85 68 ==== Inserting an Incident ==== 86 87 69 Inserting an incident displays a pool of available incidents (on auxiliary storage) and allows the user to select one for inclusion in the script being edited. (Shall we disallow inserting the same incident twice in the same script?) 88 70 89 71 ==== Saving an Incident ==== 90 91 Saving 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. 72 Saving 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. 92 73 93 74 ==== Incident Extractor Wizard ==== 94 95 75 This wizard allows the user to load a script and extract incidents from it. (Elaboration needed). 96 76 97 77 ==== Add New Event ==== 98 99 78 The user shall be able to add events to an incident line by selecting the desired type of event using a button on the main GUI then placing the event to the desired location on the timeline. When the user places an event, dialog boxes will appear to allow the user to enter information regarding the event. The user shall be able to place events at any location on an incident line. 100 79 101 80 ==== Modify Event Group ==== 102 103 A group of events occurring at the same time may be modified. Each event appears in a separate tab and its properties individually updated. 81 A group of events occurring at the same time may be modified. Each event appears in a separate tab and its properties individually updated. 104 82 105 83 ==== Deleting Event ==== 106 107 84 The user shall be able to remove events from incidents, by right-clicking on the event's icon and selecting “remove” from a pop-up menu. The user shall be able to remove an event by clicking on it and pressing the delete key. 108 85 109 86 === 2.2 Graphical User Interface requirements === #two-2 110 111 87 See StoryBoards for illustration of proposed GUI screens. 112 88 113 The Script Builder shall allow the entry and modification of scripts using a timeline. The timeline will show each incident in the script as a line. Each event, represented by an icon,will be positioned on its corresponding incident's line. This display 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. 89 The Script Builder shall allow the entry and modification of scripts using a timeline. The timeline will show each incident in the script as a line. Each event, represented by an icon,will be positioned on its corresponding incident's line. This display 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. 114 90 115 91 All time shall be displayed in hours, minutes, and seconds from the beginning of the timeline, e.g. the beginning of the script. The time into the incident and the script shall be displayed to the user as they move their cursor along an incident within the timeline. 116 92 117 Details of an event shall be displayed in a floating tooltip which appears when the user places their cursor over the event's icon. All details of an event shall be editable when the user clicks on an event icon. 93 Details of an event shall be displayed in a floating tooltip which appears when the user places their cursor over the event's icon. All details of an event shall be editable when the user clicks on an event icon. 118 94 119 95 Color Coding of Incidents 120 96 121 Each incident line shall be color-coded. The color of each incident line shall be selectable by the user. A color may be shared by multiple lines. 97 Each incident line shall be color-coded. The color of each incident line shall be selectable by the user. A color may be shared by multiple lines. 122 98 123 99 Control Event and Evaluation Event Icons … … 137 113 </strike> 138 114 }}} 139 140 115 Page Numbers on Scripts for instructors to use. Was latex. Perhaps PDF. Neal will find what was used before. 141 116 142 117 The Script Builder shall support the ability to put page numbers on generated script notebooks. 143 118 144 145 146 119 === 2.3 Support for TMC Simulation Control === 147 148 120 Simulation Control Events - General 149 121 150 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 TMC Simulator 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. 151 152 Paramics Control Event 153 154 The Script shall allow for the entry of Paramics control events. Paramics control events allow modification of Paramics simulation parameters to create incidents, remove incidents,etc. 155 156 ATMS Driver Control Events 157 158 The Script Builder shall allow for control of the ATMS back-end directly, bypassing Paramics. Script Builder control shall provide the ability to initialize the ATMS from a traffic flow perspective and then create trends, e.g. traffic dots changing from to green to yellow to red as necessitated by the script. By GPS cooord? By freeway section? Ans: each dot is a series of sensors per freeway lane, so the ATMS aggregates sensor input and allows zooming to increase resolution. 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 TMC Simulator 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. 123 124 ~~Paramics Control Event~~ 125 126 ~~The Script shall allow for the entry of Paramics control events. Paramics control events allow modification of Paramics simulation parameters to create incidents, remove incidents,etc. ~~ 159 127 160 128 CHPCAD Control Event … … 164 132 Activity Log Control Event 165 133 166 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. 167 168 CCTV Control Event 169 170 The Script Builder shall allow for the entry of CCTV control events. CCTV control events allow direct control of TMCSimulator DVD players to play incident video, resume normal operations, etc. 171 172 CHP Radio, Caltrans Radio, TMT Radio ControlEvent 134 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?) 135 136 ~~CCTV Control Event~~ 137 138 ~~The Script Builder shall allow for the entry of CCTV control events. CCTV control events allow direct control of TMCSimulator DVD players to play incident video, resume normal operations, etc.~~ 139 140 CHP Radio, Caltrans Radio, TMT Radio ControlEvent 173 141 174 142 The Script Builder shall allow for the entry of radio 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, which includes “special instructions” noted below). 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. … … 176 144 Tow Truck Control Event 177 145 178 The Script Builder shall allow for the entry ofTow Truck Control Events. Tow Truck control events allow tows to be added to the CHP CAD log. 179 180 Unit Control 181 182 Event 146 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. 147 148 Unit Control Event 183 149 184 150 The Script Builder shall allow for the entry of Unit Control Events. Unit Control Events allow CHP units to be dispatched on the CHP CAD. … … 188 154 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. 189 155 190 Telephone Call 191 192 Control Event 193 194 The Script Builder shall allow for the entry of Telephone control events. Telephone Call control events allow the generation of “voice scripts” to be included in the instructor’s notebook which allow the instructor to make relevant telephone calls,e.g. radio reporter, Caltrans headquarters, etc. into the TMC at appropriate times during a simulation. SAMPLE? No. 156 Telephone Call Control Event 157 158 The Script Builder shall allow for the entry of Telephone control events. Telephone Call control events allow the generation of “voice scripts” to be included in the instructor’s notebook which allow the instructor to make relevant telephone calls, e.g. radio reporter, Caltrans headquarters, etc. into the TMC at appropriate times during a simulation. 195 159 196 160 Generic Run Script Event suggested by Neil so SimMgr can execute a predefined shell script at a given time. 161 162 (Future) Traffic Model Control Events 163 164 The Script Builder shall allow for control of the Traffic Model. Script Builder control shall provide the ability to create traffic events, e.g. traffic dots changing from to green to yellow to red as necessitated by the script. Will require some form of automated congestion generation. 197 165 198 166 === 2.4 Support for Student Evaluation === … … 201 169 (For version 1 it may be adequate to define a“generic” evaluation event that allows a prompt to instructor and then a choice of how to score: yes/no, 1-5, A-F, 0-100). 202 170 203 204 205 171 Decision Tree Support 206 172 207 Have they done X yes/no, have they done Y yes/no,have they done Z yes/no, 173 Have they done X yes/no, have they done Y yes/no,have they done Z yes/no, 208 174 209 175 probably only 3 levels, then assigns score or grade. … … 219 185 Traffic Network Scoring 220 186 221 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. 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. 222 188 223 189 Assignment of Scoring Metrics to Specific Instructors … … 233 199 The Script Builder shall support the ability to debrief students at the end of a training session by position, e.g.CHP CAD, ATMS, Maintenance Radio, PIO, MIO, Facilitator, etc. 234 200 235 Aggregate TMC Operator Functions 236 237 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. 201 Aggregate TMC Operator Functions 202 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. 238 204 239 205 Student Evaluation Events – General … … 281 247 Student Performance Evaluation Event 282 248 283 The Script Builder shall allow for instructors to evaluate student use of the TMC SimulatorCCTV camera selection and viewing capabilities. These evaluation events would allow instructors to document how trainees utilized available CCTV imagery as part of their verification of a reported incident. 249 The Script Builder shall allow for instructors to evaluate student use of the TMC SimulatorCCTV camera selection and viewing capabilities. These evaluation events would allow instructors to document how trainees utilized available CCTV imagery as part of their verification of a reported incident. 284 250 285 251 Telephone Utilization Student Performance Event … … 287 253 The Script Builder shall allow 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. 288 254 289 290 291 255 Sigalerts 292 256 … … 294 258 295 259 === 2.5 Supporting Realism in Training === 296 297 260 Background Noise 298 261 … … 305 268 Injection of Minor Incidents 306 269 307 The Script Builder shall support the automatic generation of secondary incidents if queue protection is not implemented by trainees as appropriate. This requirement implies that the Script Builder can encode for and the Simulation Manager shall be capable of dynamically adding an incident during a simulation. 270 The Script Builder shall support the automatic generation of secondary incidents if queue protection is not implemented by trainees as appropriate. This requirement implies that the Script Builder can encode for and the Simulation Manager shall be capable of dynamically adding an incident during a simulation. 308 271 309 272 Minor Incidents 310 273 311 The Script Builder shall be capable of generating a false incident which students will discover is such when the attempt to user available verification tools. Potential steps to implement a false incident are: 1.) start a log entry 2.) dispatch a unit 3.) survey area with surveillance tools, ATMS, etc. 4.)discover the incident does not exist. Comment 274 The Script Builder shall be capable of generating a false incident which students will discover is such when the attempt to user available verification tools. Potential steps to implement a false incident are: 1.) start a log entry 2.) dispatch a unit 3.) survey area with surveillance tools, ATMS, etc. 4.)discover the incident does not exist. Comment 312 275 313 276 (Minor incidents are simply incidents but narrower in scope than typical incidents. Ideally they are displayed at the bottom of the edit canvas. Perhaps be able to “flag” an incident as minor.) 314 277 315 278 === 2.6 Specifying Expected Traffic Network Performance === 316 317 279 Determining Queue Length - amount of traffic backup May be obsolete as we are replacing paramics. 318 280 … … 320 282 321 283 === 2.7 Instructor Support === 322 323 284 Assignment of Reporter Roles to Specific Instructors 324 285 … … 330 291 331 292 === 2.8 Other Training Goals === 332 333 293 Dedicated CHP CAD Training 334 294 … … 348 308 349 309 == 3.ATMS Driver == 350 351 310 3.1General Requirements 352 311 … … 367 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.? 368 327 369 Note: ATMS expects update every 30 sec or it willdisplay white dots instead of colored ones.328 Note: ATMS expects update every 30 sec or it willdisplay white dots instead of colored ones. 370 329 371 330 4.Instructor Electronic Notebook Requirements … … 397 356 The Instructor Electronic Notebook shall allowkeyboard input, either through an actual keyboard or an electronicscreen-based keyboard. 398 357 399 The Instructor Electronic Notebook shall allowinstructors to record voice messages during a simulation viaindividual microphones for the purposes capturing qualitativefeedback. 400 401 The Instructor Electronic Notebook shall becapable of automatically performing voice recognition functions forrecorded instructor qualitative feedback. Comment 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 402 361 403 362 Battery Powered Operation … … 423 382 Display and Highlighting of Events on RunningScript Window 424 383 425 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. 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. 426 385 427 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. … … 433 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. 434 393 435 The Instructor Electronic Notebook shall allow theinstructor to enter qualitative text via a keyboard. 394 The Instructor Electronic Notebook shall allow theinstructor to enter qualitative text via a keyboard. 436 395 437 396 Jumping to Different Simulation Times in theDisplay … … 439 398 The Instructor Electronic Notebook shall allow theuser to jump directly to the current event using a one-touch GUIaction. 440 399 441 The Instructor Electronic Notebook shall allow theuser to jump directly to a specified time as inputted by the user. 400 The Instructor Electronic Notebook shall allow theuser to jump directly to a specified time as inputted by the user. 442 401 443 402 4.4CHPCAD Terminal Window … … 445 404 Standard Functionality 446 405 447 The Instructor Electronic Notebook shall provide aCHP CAD terminal with functionality similar to that of the “standard”TMC Simulator CHP CAD terminal. 406 The Instructor Electronic Notebook shall provide aCHP CAD terminal with functionality similar to that of the “standard”TMC Simulator CHP CAD terminal. 448 407 449 408 The Instructor Electronic Notebook hall allow theinstructor to view all CHP CAD entries made by students. 450 409 451 The Instructor Electronic Notebook shall allow theinstructor to make CHP CAD entries during a simulation. 410 The Instructor Electronic Notebook shall allow theinstructor to make CHP CAD entries during a simulation. 452 411 453 412 The Instructor Electronic Notebook shallautomatically update as CHP CAD entries are made within the TMCsimulation environment.
