mirror of
https://github.com/nasa/trick.git
synced 2025-06-24 01:28:46 +00:00
Initial commit of everything.
This commit is contained in:
5
doxygen/requirements/acronyms.dox_in
Normal file
5
doxygen/requirements/acronyms.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL1 List of Acronyms:
|
||||
|
||||
*/
|
9
doxygen/requirements/adaptation.dox_in
Normal file
9
doxygen/requirements/adaptation.dox_in
Normal file
@ -0,0 +1,9 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Adaptation Requirements
|
||||
|
||||
LEVEL3 Trick source code shall use a POSIX compliant API when accessing POSIX
|
||||
threads (pthreads), mutual exclusions (mutexes), signals, interrupts, and
|
||||
clock routines. [Trick-151]
|
||||
|
||||
*/
|
38
doxygen/requirements/applicable_docs.dox_in
Normal file
38
doxygen/requirements/applicable_docs.dox_in
Normal file
@ -0,0 +1,38 @@
|
||||
/**
|
||||
@page LEVEL1 Applicable and Reference Documents
|
||||
|
||||
@section LEVEL2 Applicable Documents
|
||||
The following documents are reference documents utilized in the development of this
|
||||
SRS. These documents do not form a part of this SRS and are not controlled by their
|
||||
reference herein.
|
||||
|
||||
<center>
|
||||
<table>
|
||||
<tr><th>Document Number</th><th>Revision/ Release Date</th><th>Document Title</th></tr>
|
||||
<tr><td></td><td></td><td></td></tr>
|
||||
</table>
|
||||
</center>
|
||||
|
||||
@section LEVEL2 Reference Documents
|
||||
The following documents are reference documents utilized in the development of this SRS.
|
||||
These documents do not form a part of this SRS and are not controlled by their reference
|
||||
herein.
|
||||
|
||||
<center>
|
||||
<table>
|
||||
<tr><th>Document Number</th><th>Revision/ Release Date</th><th>Document Title</th></tr>
|
||||
<tr><td></td><td></td><td></td></tr>
|
||||
</table>
|
||||
</center>
|
||||
|
||||
@section LEVEL2 Order of Precedence
|
||||
In the event of a conflict between the text of this specification and an applicable
|
||||
document cited herein, the text of this specification takes precedence.
|
||||
|
||||
All specifications, standards, exhibits, drawings or other documents that are invoked
|
||||
as "applicable" in this specification are incorporated as cited. All documents that are
|
||||
referred to by an applicable document are considered to be for guidance and information
|
||||
only, with the exception of Interface Control Documents (ICD) which will have their
|
||||
applicable documents considered to be incorporated as cited.
|
||||
|
||||
*/
|
8
doxygen/requirements/design_constraints.dox_in
Normal file
8
doxygen/requirements/design_constraints.dox_in
Normal file
@ -0,0 +1,8 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Design and Implementation Constraints
|
||||
|
||||
LEVEL3 Trick shall not preclude that which cannot be precluded unless Trick is
|
||||
precluded from not precluding the unprecludable.
|
||||
|
||||
*/
|
10
doxygen/requirements/environment.dox_in
Normal file
10
doxygen/requirements/environment.dox_in
Normal file
@ -0,0 +1,10 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Environment Requirements
|
||||
|
||||
LEVEL3 UNIX env?<br>
|
||||
LEVEL3 Trick shall plant a tree for every successful simulation built.<br>
|
||||
LEVEL3 Trick shall be dolphin safe.<br>
|
||||
LEVEL3 Trick shall recycle.<br>
|
||||
|
||||
*/
|
5
doxygen/requirements/functional_requirements.dox_in
Normal file
5
doxygen/requirements/functional_requirements.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Functional Requirements
|
||||
|
||||
*/
|
5
doxygen/requirements/internal_data.dox_in
Normal file
5
doxygen/requirements/internal_data.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Internal Data Requirements
|
||||
|
||||
*/
|
22
doxygen/requirements/introduction.dox_in
Normal file
22
doxygen/requirements/introduction.dox_in
Normal file
@ -0,0 +1,22 @@
|
||||
/**
|
||||
@page LEVEL1 Introduction
|
||||
|
||||
@section LEVEL2 Purpose
|
||||
This document establishes the Software Requirements Specification for the Trick
|
||||
Software.
|
||||
|
||||
@section LEVEL2 Scope
|
||||
This specification defines the functional, performance, and interface requirements
|
||||
for the Trick Software.
|
||||
|
||||
@section LEVEL2 Office of Primary Responsibility
|
||||
The Software Requirements Specification (SRS) is the responsibility of the
|
||||
National Aeronautics and Space Administration (NASA) Johnson Space Center (JSC)
|
||||
Engineering Directorate Automation, Robotics and Simulations Division (ER).
|
||||
|
||||
@section LEVEL2 Change Authority
|
||||
All changes to this document will be processed in accordance with somebody important.
|
||||
(Is there a board/person that has to approve the CR to baseline and update this document?).
|
||||
|
||||
*/
|
||||
|
5
doxygen/requirements/logistics.dox_in
Normal file
5
doxygen/requirements/logistics.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Logistics Related Requirements
|
||||
|
||||
*/
|
84
doxygen/requirements/main_page.dox_in
Normal file
84
doxygen/requirements/main_page.dox_in
Normal file
@ -0,0 +1,84 @@
|
||||
/**
|
||||
@page requirements Trick Requirements
|
||||
|
||||
@subpage r01 "1 Introduction"<br>
|
||||
|
||||
@subpage r02 "2 Applicable and Reference Documents"<br>
|
||||
|
||||
@subpage r03 "3 Software Description"<br>
|
||||
@subpage r0301 "3.1 Functional Requirements"<br>
|
||||
@subpage r030101 "3.1.1 Executive Scheduler"<br>
|
||||
@subpage r030102 "3.1.2 Scheduled Job Queue"<br>
|
||||
@subpage r030103 "3.1.3 Realtime Synchronization"<br>
|
||||
@subpage r030104 "3.1.4 Realtime Clock"<br>
|
||||
@subpage r030105 "3.1.5 Sleep Timer"<br>
|
||||
@subpage r030106 "3.1.6 Command Line Arguments"<br>
|
||||
@subpage r0302 "3.2 Required States and Modes"<br>
|
||||
@subpage r0303 "3.3 Software Interfaces"<br>
|
||||
@subpage r0304 "3.4 Internal Data Requirements"<br>
|
||||
@subpage r0305 "3.5 Adaptation Requirements"<br>
|
||||
@subpage r0306 "3.6 Safety Requirements"<br>
|
||||
@subpage r0307 "3.7 Performance and Timing Requirements"<br>
|
||||
@subpage r0308 "3.8 Security and Privacy Requirements"<br>
|
||||
@subpage r0309 "3.9 Environment Requirements"<br>
|
||||
@subpage r0310 "3.10 Computer Resource Requirements"<br>
|
||||
@subpage r0311 "3.11 Design and Implementation Constraints"<br>
|
||||
@subpage r0312 "3.12 Personnel Related Requirements"<br>
|
||||
@subpage r0313 "3.13 Training Related Requirements"<br>
|
||||
@subpage r0314 "3.14 Logistics Related Requirements"<br>
|
||||
@subpage r0315 "3.15 Packaging Related Requirements"<br>
|
||||
@subpage r0316 "3.16 Precedence and Criticality Requirements"<br>
|
||||
|
||||
@subpage r04 "4 Traceability to Parent Requirements"<br>
|
||||
|
||||
@subpage r05 "5 Releases"<br>
|
||||
|
||||
@subpage r06 "6 Support"<br>
|
||||
|
||||
@subpage r07 "7 List of Acronyms"<br>
|
||||
|
||||
*/
|
||||
|
||||
// section 1
|
||||
#include "introduction.dox_in"
|
||||
|
||||
// section 2
|
||||
#include "applicable_docs.dox_in"
|
||||
|
||||
// section 3
|
||||
#include "software_description.dox_in"
|
||||
#include "functional_requirements.dox_in"
|
||||
#include "sim_services/Executive/requirements.dox_in"
|
||||
#include "sim_services/ScheduledJobQueue/requirements.dox_in"
|
||||
#include "sim_services/RealtimeSync/requirements.dox_in"
|
||||
#include "sim_services/Clock/requirements.dox_in"
|
||||
#include "sim_services/Timer/requirements.dox_in"
|
||||
#include "sim_services/CommandLineArguments/requirements.dox_in"
|
||||
#include "required_states.dox_in"
|
||||
#include "software_interfaces.dox_in"
|
||||
#include "internal_data.dox_in"
|
||||
#include "adaptation.dox_in"
|
||||
#include "safety.dox_in"
|
||||
#include "performance.dox_in"
|
||||
#include "security.dox_in"
|
||||
#include "environment.dox_in"
|
||||
#include "resource.dox_in"
|
||||
#include "design_constraints.dox_in"
|
||||
#include "personnel.dox_in"
|
||||
#include "training.dox_in"
|
||||
#include "logistics.dox_in"
|
||||
#include "packaging.dox_in"
|
||||
#include "precedence.dox_in"
|
||||
|
||||
// section 4
|
||||
#include "traceability.dox_in"
|
||||
|
||||
// section 5
|
||||
#include "releases.dox_in"
|
||||
|
||||
// section 6
|
||||
#include "support.dox_in"
|
||||
|
||||
// section 7
|
||||
#include "acronyms.dox_in"
|
||||
|
5
doxygen/requirements/packaging.dox_in
Normal file
5
doxygen/requirements/packaging.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Packaging Requirements
|
||||
|
||||
*/
|
5
doxygen/requirements/performance.dox_in
Normal file
5
doxygen/requirements/performance.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Performance and Timing Requirements
|
||||
|
||||
*/
|
5
doxygen/requirements/personnel.dox_in
Normal file
5
doxygen/requirements/personnel.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Persionnel Related Requirements
|
||||
|
||||
*/
|
5
doxygen/requirements/precedence.dox_in
Normal file
5
doxygen/requirements/precedence.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Precedence and Criticality of Requirements
|
||||
|
||||
*/
|
5
doxygen/requirements/releases.dox_in
Normal file
5
doxygen/requirements/releases.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL1 Releases
|
||||
|
||||
*/
|
5
doxygen/requirements/required_states.dox_in
Normal file
5
doxygen/requirements/required_states.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Required States and Modes
|
||||
|
||||
*/
|
5
doxygen/requirements/resource.dox_in
Normal file
5
doxygen/requirements/resource.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Computer Resource Requirements
|
||||
|
||||
*/
|
9
doxygen/requirements/safety.dox_in
Normal file
9
doxygen/requirements/safety.dox_in
Normal file
@ -0,0 +1,9 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Safety Requirements
|
||||
|
||||
There are no safety requirements for this software. Any simulations that use
|
||||
trick functions to control hazards are responsible for maintaining their safety
|
||||
requirements.
|
||||
|
||||
*/
|
5
doxygen/requirements/security.dox_in
Normal file
5
doxygen/requirements/security.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Security and Privacy Requirements
|
||||
|
||||
*/
|
5
doxygen/requirements/software_description.dox_in
Normal file
5
doxygen/requirements/software_description.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
@page LEVEL1 Software Description
|
||||
|
||||
*/
|
||||
|
5
doxygen/requirements/software_interfaces.dox_in
Normal file
5
doxygen/requirements/software_interfaces.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Software Interfaces
|
||||
|
||||
*/
|
7
doxygen/requirements/support.dox_in
Normal file
7
doxygen/requirements/support.dox_in
Normal file
@ -0,0 +1,7 @@
|
||||
|
||||
/**
|
||||
@page LEVEL1 Support
|
||||
|
||||
LEVEL2 Trick core team will provide support to users of the Trick software.
|
||||
|
||||
*/
|
7
doxygen/requirements/traceability.dox_in
Normal file
7
doxygen/requirements/traceability.dox_in
Normal file
@ -0,0 +1,7 @@
|
||||
|
||||
/**
|
||||
@page LEVEL1 Traceability to Parent Requirements
|
||||
|
||||
There are no formal parent requirements that flow into this SRS.
|
||||
|
||||
*/
|
5
doxygen/requirements/training.dox_in
Normal file
5
doxygen/requirements/training.dox_in
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
/**
|
||||
@page LEVEL2 Training Related Requirements
|
||||
|
||||
*/
|
Reference in New Issue
Block a user