Changes between Version 2 and Version 3 of ScriptBuilderSRS


Ignore:
Timestamp:
07/27/2017 05:11:42 PM (9 years ago)
Author:
jdalbey
Comment:

under construction

Legend:

Unmodified
Added
Removed
Modified

  • ScriptBuilderSRS

    v2 v3  
    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 
    9  
    10 Table of Contents 
    11  
    12  Glossary       2 
    13  
    14 \1. Script Builder Tool Requirements    4 
    15  
    16 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 
    31  
    32 \2. Instructor Electronic Notebook Requirements 13 
    33  
    34 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 
    49  
    50 ATMS    AdvancedTraffic Management System – a tool utilized within Caltrans 
    51  
    52 CHPCAD  California Highway Patrol (CHP) Computer Aided Dispatch (CAD) 
    53  
    54 CCTV    Closedcircuit television – used to monitor roadways remotely from a TMC. 
    55  
    56 CMS     ChangeableMessage Sign 
    57  
    58 ControlEvent    Control events cause the TMC Simulation Manager to performactions which affect the simulation environment as seen on thesimulation floor, e.g. modify the Paramics simulation, play an audioclip, send a message to CHP CAD, etc.   
    59  
    60 EvaluationEvent Evaluation events are used to prompt instructors to perform anevaluation action for students in training, e.g. grade their CMSmessage, phone response, etc. 
    61  
    62 Event   Anoccurrence at a particular time of an incident. Control events andevaluation events are kinds of event. 
    63  
    64 EventIcon       An image that represents an event. A/K/A Icon. 
    65  
    66 Incident        Acomplete set of events associated with a specific incident numberwithin the TMC Simulator.  This ID number shall match the CHP CAD logidentifier.  
    67  
    68 Noise   Backgroundevents within a simulation which may not have a significant immediateeffect on traffic but require attention and resources from trafficmanagers working in the TMC.  Examples of noise are things like astalled vehicle on the shoulder, sprinklers spraying in the roadway,maintenance crews working on roadway instructure, etc. 
    69  
    70 Icon    Animage that represents an event. A/K/A Event icon.  
    71  
    72 IncidentNumber  A number that identifies an incident.  
    73  
    74 IncidentName    A short name that is used to refer to an incident.  
    75  
    76 IncidentLine    A graphical line in the timeline. An incident line represents anincident. 
     1= !ScriptBuilder Tool and Instructor Electronic Notebook = 
     2 
     3 
     4Requirements, Concept Development, and Scope[[BR]] 
     5California Polytechnic State University[[BR]] 
     6San Luis Obispo, California[[BR]] 
     7 
     8 
     9== Table of Contents == 
     10 
     111. Glossary     2[[BR]] 
     122. Script Builder Tool Requirements     4[[BR]] 
     132.1 Incidents,  Scripts, and Timelines  4[[BR]] 
     142.2 Script      Builder File I/O        5[[BR]] 
     152.3 Support for TMC Simulation Control  6[[BR]] 
     162.4 Support for Student Evaluation      7[[BR]] 
     172.5 Supporting  Realism in Training     10[[BR]] 
     182.6 Specifying  Expected Traffic Network Performance    11[[BR]] 
     192.7 Instructor  Support 11[[BR]] 
     202.8 Other       Training Goals  12[[BR]] 
     213. Instructor Electronic Notebook Requirements  13[[BR]] 
     223.1 General     Requirements    13[[BR]] 
     233.2 Simulation  Summary Window  14[[BR]] 
     243.3 Simulation  Script Window   14[[BR]] 
     253.4 CHP CAD     Terminal Window 15[[BR]] 
     263.5 ATMS Display        Window  15[[BR]] 
     273.6 Simulation  Area Reference Roadway Map Window       16[[BR]] 
     28 
     29 
     30== 1. Glossary == 
     31 
     32ATMS    Advanced Traffic Management System – a tool utilized within Caltrans 
     33 
     34CHP CAD California Highway Patrol (CHP) Computer Aided Dispatch (CAD) 
     35 
     36CCTV    Closed circuit television – used to monitor roadways remotely from a TMC. 
     37 
     38CMS     Changeable Message Sign 
     39 
     40Control 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.   
     41 
     42Evaluation 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. 
     43 
     44Event   An occurrence at a particular time of an incident. Control events and evaluation events are kinds of event. 
     45 
     46Event Icon      An image that represents an event. AKA Icon. 
     47 
     48Incident        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.  
     49 
     50Noise   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. 
     51 
     52Icon    An image that represents an event. AKA Event icon.  
     53 
     54Incident Number A number that identifies an incident.  
     55 
     56Incident Name   A short name that is used to refer to an incident.  
     57 
     58Incident Line   A graphical line in the timeline. An incident line represents an incident. 
    7759 
    7860LCS     LaneClosure System – a tool used by Caltrans to manage lane closureswithin the highway system. 
    7961 
    80 Paramics        Atool which performs microscopic traffic simulation of the trafficnetwork.  Note that Paramics is planned for deprecation from the TMCsimulator. 
    81  
    82 Script  AnXML file containing all details for all events within one or moreincidents. 
    83  
    84 ScriptFile      A script saved to XML file in a format conformant with theSimulation Manager & Script XML Schema. 
    85  
    86 Timeline        Agraphical display of a script. 
    87  
    88 TrafficDot      A colored dot as displayed on the ATMS with green indicatingfree-flow traffic, yellow indicating moderate reductions inspeed/flow, and red indicating sever reductions in speed/flow. 
    89  
    90 TMT     TrafficManagement Team  
    91  
    92 2.Script Builder Tool Requirements 
    93  
    94 2.1Incidents,Scripts, and Timelines 
    95  
    96 Time-basedIncident Display 
    97  
    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.  
    99  
    100 All time shall be displayed in hours, minutes, andseconds from the beginning of the timeline, e.g. the beginning of thescript.  The time into the incident and the script shall be displayedto the user as they move their cursor along an incident within thetimeline. 
    101  
    102 Details of an event shall be displayed in afloating tooltip which appears when the user places their cursor overthe event's icon.  All details of an event shall be editable when theuser clicks on an event icon.  
     62Paramics        A tool which performs microscopic traffic simulation of the traffic network.  Note that Paramics is planned for deprecation from the TMCsimulator. 
     63 
     64Script  An XML file containing all details for all events within one or more incidents.  
     65 
     66Script File     A script saved to XML file in a format conformant with the Simulation Manager & Script XML Schema. 
     67 
     68Timeline        A graphical display of a script. 
     69 
     70Traffic 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. 
     71 
     72TMT     Traffic Management Team  
     73 
     74== 2.Script Builder Tool Requirements == 
     75 
     762.1 Incidents, Scripts, and Timelines 
     77 
     78Incident Description & Summary 
     79 
     80The Script Builder shall allow incidents to be entered. When an incident is entered, the user will enter information regarding that incident. Incident information shall include 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. 
     81 
     82Event Entry 
     83 
     84The 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. 
     85 
     86Event Removal 
     87 
     88The 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. 
     89 
     90Time-based Incident Display 
     91 
     92The 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.  
     93 
     94All 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. 
     95 
     96Details of an event shall be displayed in a floating tooltip which appears when the user places their cursor overthe event's icon.  All details of an event shall be editable when the user clicks on an event icon.  
    10397 
    10498Color Coding of Incidents 
    10599 
    106 Each incident line shall be color-coded.  Thecolor of each incident line shall be selectable by the user. A colormay be shared by multiple lines.  
     100Each 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.  
    107101 
    108102Control Event and Evaluation Event Icons 
    109103 
    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. 
    111  
    112 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. ) 
     104The 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. 
     105 
     106Merging Multiple Scripts onto Timeline 
     107 
     108The Script Builder shall be capable of merging multiple independent scripts into a single timeline.  A user shall be able to select which incidents to include into the timeline at import.  The start times of these incidents shall be selectable by the user.     (What I think I heard was there are two features needed:  import incident and merge script.  Import incident is used when building a new script by selecting from a pool of incidents in external files. Merge script actually merges the XML by chronology of events.  Unclear why the latter is needed because it seems to duplicate what can be done with import.  The saved incidents all start at time zero and can be assigned a relative start time when imported.  During editing the incident can be shifted along the  timeline. ) 
    115109 
    116110Extracting a Script from the Timeline 
    117111 
    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 
    121  
    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. 
    123  
    124 Event Entry 
    125  
    126 The user shall be able to add events to anincident line by selecting the desired type of event using a buttonon the main GUI then placing the event to the desired location on thetimeline.  When the user places an event,  dialog boxes will appearto allow the user to enter information regarding the event.  The usershall be able to place events at any location on an incident line. 
    127  
    128 Event Removal 
    129  
    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. 
    131  
    132 PageNumbers on Scripts for instructors to use. Was latex. Perhaps PDF.Neal will find what was used before. 
    133  
    134 The Script Builder shall support the ability toput page numbers on generated script notebooks. 
    135  
    136 2.2ScriptBuilder File I/O 
     112The Script Builder shall be capable of extracting a script from the timeline.  (I think this means exporting incidents,because the timeline has nothing to be extracted from it but incidents. Export includes all associated resources like audiofiles.)      
     113 
     114Page Numbers on Scripts for instructors to use. Was latex. Perhaps PDF. Neal will find what was used before. 
     115 
     116The Script Builder shall support the ability to put page numbers on generated script notebooks. 
     117 
     1182.2 ScriptBuilder File I/O 
    137119 
    138120 
    … …  
    140122Script File Format 
    141123 
    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 
     124The Script Builder shall read from and save generated scripts to an XML file in conformance with the standard as detailed in the *Simulation Manager & Script XML Schema.  Look in Google Drive. * 
     125 
     126Opening an existing Script File 
    145127 
    146128The 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.