Changes between Version 7 and Version 8 of ScriptBuilderSRS


Ignore:
Timestamp:
07/28/2017 05:56:57 AM (9 years ago)
Author:
jdalbey
Comment:

draft

Legend:

Unmodified
Added
Removed
Modified
  • ScriptBuilderSRS

    v7 v8  
    3232 CHP CAD::      California Highway Patrol (CHP) Computer Aided Dispatch (CAD) 
    3333 CCTV:: Closed circuit television – used to monitor roadways remotely from a TMC. 
    34  
    35 CMS     Changeable Message Sign 
    36  
    37 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.   
    38  
    39 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. 
    40  
    41 Event   An occurrence at a particular time of an incident. Control events and evaluation events are kinds of event. 
    42  
    43 Event Icon      An image that represents an event. AKA Icon. 
    44  
    45 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.  
    46  
    47 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. 
    48  
    49 Icon    An image that represents an event. AKA Event icon.  
    50  
    51 Incident Number A number that identifies an incident.  
    52  
    53 Incident Name   A short name that is used to refer to an incident.  
    54  
    55 Incident Line   A graphical line in the timeline. An incident line represents an incident. 
    56  
    57 LCS     Lane Closure System – a tool used by Caltrans to manage lane closures within the highway system. 
    58  
    59 Paramics        A tool which performs microscopic traffic simulation of the traffic network.  Note that Paramics is planned for deprecation from the TMCsimulator. 
    60  
     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.   
     36 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 Event:: An occurrence at a particular time of an incident. Control events and evaluation events are kinds of event. 
     38 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.  
     40 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.  
     44 Incident Line:: A graphical line in the timeline. An incident line represents an incident. 
     45 LCS:: Lane Closure System – a tool used by Caltrans to manage lane closures within the highway system. 
     46 Paramics:: A tool which performs microscopic traffic simulation of the traffic network.  Note that Paramics is planned for deprecation from the TMCsimulator. 
    6147 Script:: A chronological list of hypothetical traffic incidents for training purposes that can be played through the Simulation Manager.  
    6248 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). 
     
    7157====  2.1.1 Creating a new Script ==== 
    7258 
    73 Creating a new script shows an empty timeline available for incidents to be added or inserted. 
     59Creating 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. 
    7460 
    7561==== 2.1.2 Load an existing Script ==== 
    7662 
    77 Load an existing Script from a saved XML file and display it as a timeline. 
     63Load an existing Script from a saved XML file and display an overview of all the incidents. (Clears any current script). 
    7864 
    7965==== Saving a Script ==== 
     
    8571A 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). 
    8672 
    87 ==== Editing Incident Properties ==== 
     73==== Update Incident Properties ==== 
    8874 
    8975An incident's properties may be modified after it has been created, including adjusting starting time. 
    9076 
    91 Editing Incident Events 
     77==== Editing Incident Events ==== 
    9278 
    9379Editing an incident makes it available for events to be added, modified, and removed. 
    9480 
    95 Deleting an Incident 
     81==== Deleting an Incident ==== 
    9682 
    9783Erases all the incident properties and events from the timeline. 
    9884 
    99 Inserting an Incident 
     85==== Inserting an Incident ==== 
    10086 
    10187Inserting 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?) 
    10288 
    103 Saving an Incident 
     89==== Saving an Incident ==== 
    10490 
    10591Saving 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.  
    10692 
    107 Incident Extractor Wizard 
     93==== Incident Extractor Wizard ==== 
    10894 
    10995This wizard allows the user to load a script and extract incidents from it.  (Elaboration needed). 
     
    121107The 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. 
    122108 
    123 Graphical User Interface showing Time-based Incident Display 
     109=== Graphical User Interface showing Time-based Incident Display === 
    124110 
    125111The 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.  
     
    156142 
    157143 
    158 2.3 Support for TMC Simulation Control 
     144== 2.3 Support for TMC Simulation Control == 
    159145 
    160146Simulation Control Events - General 
     
    208194Generic Run Script Event suggested by Neil so SimMgr can execute a predefined shell script at a given time. 
    209195 
    210 2.4Supportfor Student Evaluation (ALL INSTRUCTOR NOTEBOOK) or grading sheets. None of this requires anything by Simulation mgr. 
    211  
    212 (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). 
    213  
    214  
    215  
    216 DecisionTree Support 
     196== 2.4 Supportfor Student Evaluation == 
     197(ALL INSTRUCTOR NOTEBOOK) or grading sheets. None of this requires anything by Simulation mgr. 
     198 
     199(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). 
     200 
     201 
     202 
     203Decision Tree Support 
    217204 
    218205Have they done X yes/no, have they done Y yes/no,have they done Z yes/no,  
    219206 
    220 probably only 3 levels, then assigns score orgrade. 
    221  
    222 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. 
    223  
    224 Supportfor Instructor Electronic Notebooks  Prototype? (Just the paperbinders) 
     207probably only 3 levels, then assigns score or grade. 
     208 
     209The 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 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. 
     210 
     211Support for Instructor Electronic Notebooks  Prototype? (Just the paperbinders) 
    225212 
    226213“Support” means the design should be able toaccommodate these events but probably won't be part of version 1. 
     
    228215The 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. 
    229216 
    230 TrafficNetwork Scoring 
     217Traffic Network Scoring 
    231218 
    232219The 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.  
    233220 
    234 Assignmentof Scoring Metrics to Specific Instructors 
     221Assignment of Scoring Metrics to Specific Instructors 
    235222 
    236223The 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. 
    237224 
    238 AssociateScore with Feedback 
     225Associate Score with Feedback 
    239226 
    240227The 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” 
    241228 
    242 Debriefby Position 
     229Debrief by Position 
    243230 
    244231The 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.