Explore
Known Bugs
JIRA ID | Summary | Recommendation |
GMT-585 | Multiple redundant properties/fields for epoch | |
GMT-1098 | Tab key navigation fails | |
GMT-1346 | Add ability for user-defined parameters | |
GMT-1439 | Parameter design for multiple dependency | |
GMT-1483 | Ability to Calculate and Output Sun Vector to any point | |
GMT-1899 | Beta Angle is Off by about .003 degrees | |
GMT-1933 | Earth Fixed RA changed from 0-360 to -180-180 measurement | |
GMT-2011 | Larger angular momentum errors in 09/15 build | |
GMT-2318 | STM Parameters are wrong when using Coordinate System other than EarthMJ2000Eq | |
GMT-2475 | Provide a parameter to check convergence status of a VF13 optimizer | |
GMT-2673 | User Reported: Parameter Select Dialog Box Silently Changes User's Selected Object | |
GMT-2755 | ParameterCreateDialog does not close properly after adding string parameter on Mac |
Failing Tests
Failing tests listed as of 09/11/2012.
JIRA ID | Test | Summary | Rec. |
| |||
| |||
| |||
| |||
CSParams_Uranus1_2Body_UranusFixed | |||
CSParams_Saturn1_2Body_SaturnFixed | |||
CSParams_Pluto1_2Body_PlutoFixed | |||
CSParams_Neptune1_2Body_NeptuneMJ2000Ec | |||
CSParams_Neptune1_2Body_NeptuneFixed | |||
CSParams_Hyperbolic_2Body | |||
CSParams_GEO_2Body |
Other Findings
JIRA ID | Summary | Rec. |
Inconsistent naming: RadApo/RadPer and VelApoapsis/RadPeriapsis | ||
ParameterSelectDialog is badly named | ||
ParameterSelectDialog string consistency issues | ||
ParameterSelectDialog doesn't remove item from available list once chosen |
Requirements
ID | Requirements |
FRR-38.1.0 | The system shall allow the user to calculate or set the following object properties with respect to any celestial body in FRR-16: |
FRR-38.1.1.0 | 1) Spacecraft and orbit parameters |
FRR-38.1.1.1 | 1. Altitude (read only) |
FRR-38.1.1.2 | 2. Beta angle (read only) |
FRR-38.1.1.3 | 3. C3 energy (read only) |
FRR-38.1.1.4 | 4. Eccentric anomaly (read/write) |
FRR-38.1.1.5 | 5. Eccentricity (read/write) |
FRR-38.1.1.6 | 6. Orbit energy (read only) |
FRR-38.1.1.7 | 7. Magnitude of angular momentum (read only) |
FRR-38.1.1.8 | 8. Latitude (read only) |
FRR-38.1.1.8 | 9. Longitude (read only) |
FRR-38.1.1.10 | 10. Local sidereal time (read only) |
FRR-38.1.1.11 | 11. Mean anomaly (read/write) |
FRR-38.1.1.12 | 12. Mean hour angle (read only) |
FRR-38.1.1.13 | 13. Mean motion (read only) |
FRR-38.1.1.14 | 14. Orbit period (read only) |
FRR-38.1.1.15 | 15. Radius of apogee (read/write) |
FRR-38.1.1.16 | 16. Radius of perigee (read/write) |
FRR-38.1.1.17 | 17. Magnitude of position vector (read only) |
FRR-38.1.1.18 | 18. Orbit semi-latus rectum (read only) |
FRR-38.1.1.19 | 19. Orbit semi major axis (read/write) |
FRR-38.1.1.20 | 20. True anomaly (read/write) |
FRR-38.1.1.21 | 21. Velocity at apoapsis (read only) |
FRR-38.1.1.22 | 22. Velocity at periapsis (read only) |
FRR-38.2.0 | The system shall allow the user to calculate the following object properties with respect to any coordinate system in FR-xxx: |
FRR-38.2.1.0 | 1) Spacecraft and orbit parameters |
FRR-38.2.1.1 | 1. Argument of periapsis (read/write) |
FRR-38.2.1.2 | 2. Azimuth (read/write) |
FRR-38.2.1.3 | 3. B dot T (read only) |
FRR-38.2.1.4 | 4. B dot R (read only) |
FRR-38.2.1.5 | 5. B vector angle (read only) |
FRR-38.2.1.6 | 6. B vector magnitude (read only) |
FRR-38.2.1.7 | 7. Declination (read/write) |
FRR-38.2.1.8 | 8. Declination of velocity (read/write) |
FRR-38.2.1.9 | 9. Flight path angle (read/write) |
FRR-38.2.1.10 | 10. Hyperbolic anomaly (read/write) |
FRR-38.2.1.11 | 11. Orbit angular momentum components (read only) |
FRR-38.2.1.12 | 12. Orbit inclination (read/write) |
FRR-38.2.1.13 | 13. Orbits transition matrix (read only) |
FRR-38.2.1.14 | 14. 3x3 partitions of Orbit STM (read only) |
FRR-38.2.1.15 | 15. Right ascension (read/write) |
FRR-38.2.1.16 | 16. Right ascension of the ascending node (read/write) |
FRR-38.2.1.17 | 17. Right ascension of velocity (read/write) |
FRR-38.2.1.18 | 18. Magnitude of velocity (read/write) |
FRR-38.2.1.19 | 19. Components of velocity (read/write) |
FRR-38.2.1.20 | 20. Components of position (read/write) |
FRR-38.2.1.21 | 21. Right Asencsion of Outgoing Aysptote (read/write) |
FRR-38.2.1.22 | 22. Declination of Outgoing Aysptote (read/write) |
FRR-38.3.0 | The system shall allow the user to calculate the following object properties: |
FRR-38.3.1.0 | 1) Spacecraft and orbit parameters |
FRR-38.3.1.3 | 3. Spacecraft Angular velocity components (read/write) |
FRR-38.3.1.4 | 4. Drag coefficient (read/write) |
FRR-38.3.1.5 | 5. SRP coefficient (read/write) |
FRR-38.3.1.6 | 6. Direction cosine matrix components ( read/write) |
FRR-38.3.1.7 | 7. Drag area (read/write) |
FRR-38.3.1.8 | 8. Dry mass (read/write) |
FRR-38.3.1.9 | 9. Elapsed days (read only) |
FRR-38.3.1.10 | 10. Elapsed seconds (read only) |
FRR-38.3.1.11 | 11. Euler angles for any sequence (read/write) |
FRR-38.3.1.12 | 12. Euler angle rates for any sequence (read/write) |
FRR-38.3.1.13 | 13. Quaternion components (read/write) |
FRR-38.3.1.14 | 14. SRP area (read/write) |
FRR-38.3.1.15 | 15. Epoch in TAI modified Julian (read/write) |
FRR-38.3.1.16 | 16. Epoch in TAI Gregorian (read/write) |
FRR-38.3.1.19 | 19. Epoch in TDB modified Julian (read/write) |
FRR-38.3.1.20 | 20. Epoch in TDB Gregorian (read/write) |
FRR-38.3.1.21 | 21. Epoch in TT modified Julian (read/write) |
FRR-38.3.1.22 | 22. Epoch in TT Gregorian (read/write) |
FRR-38.3.1.23 | 23. Epoch in UTC modified Julian (read/write) |
FRR-38.3.1.24 | 24. Epoch in UTC Gregorian (read/write) |
FRR-38.3.1.25 | 25. Spacecraft total mass (read only) |
FRR-38.3.1.26 | 26. Modified Rodriguez parameters (read/write) |
FRR-38.3.1.27 | 27. Euler Angles (read/write) |
FRR-38.3.1.28 | 28. Euler Angle Rates (read/write) |
FRR-38.3.2.0 | 2) Impulsive burn parameters |
FRR-38.3.2.1 | 1. Element1 (read/write) |
FRR-38.3.2.2 | 2. Element2 (read/write) |
FRR-38.3.2.3 | 3. Element3 (read/write) |
FRR-38.3.2.4 | 4. Velocity component (read/write) |
FRR-38.3.2.5 | 5. Normal component (read/write) |
FRR-38.3.2.6 | 6. Binormal component (read/write) |
FRR-38.3.3.0 | 3) Tank Properties |
FRR-38.3.3.1 | 1. Pressure (read/write) |
FRR-38.3.3.2 | 2. Volume (read/write) |
FRR-38.3.3.3 | 3. Fuel Density (read/write) |
FRR-38.3.3.4 | 4. Fuel Mass (read/write) |
FRR-38.3.3.5 | 5. Temperature (read/write) |
FRR-38.3.3.6 | 6. RefTemperature (read/write |
Interface/Functional Spec
Overview
Data property available for use by commands
Description
Parameters are named resource properties that can be used to obtain data for use by Mission Sequence commands. Unlike resource fields, which can be set in the initialization portion of a script (or in the GUI's Resources tree), parameters are derived properties that can only be used to get data, not store it. There is some overlap between the two categories, however: the ECC property of Spacecraft is both a field (i.e. settable during initialization) and a parameter (i.e. usable by Mission Sequence commands).
Parameters are classified as one of three types: central-body-dependent parameters, coordinate-system-dependent parameters, and standalone parameters. Standalone parameters are the simplest type, in that they have no dependencies. The ElapsedSecs parameter of Spacecraft is an example of this; it is simple referenced as Spacecraft.ElapsedSecs
.
Central-body-dependent parameters, as the name suggests, have a value that is dependent on the chosen celestial body. The Altitude parameter of Spacecraft is an example of this. To reference this parameter, you must specify a central body, such as Spacecraft.Mars.Altitude
. Any built-in central body or user-defined Asteroid, Comet, Moon, or Planet is valid as a dependency.
Likewise, coordinate-system-dependent parameters have a value that is dependent on the chosen coordinate system. The DEC parameter of Spacecraft is an example of this. To reference this parameter, you must specify the name of a CoordinateSystem resource, such as Spacecraft.EarthFixed.DEC
. Any default or user-defined CoordinateSystem resource is valid as a dependency.
The nuances of fields and parameters in GMAT are explored in more detail in the script language documentation, and the individual parameters are documented along with the resources their parent resources. The GUI, however, has a parameter selection interface that is common to all parameters. This interface is documented in GUI, below.
See Also: Script Language, FuelTank, ImpulsiveBurn, Spacecraft
GUI
Parameters can be used as input in several places throughout GMAT, such as the ReportFile and XYPlot resources and the If/Else, Propagate, and Report commands. In the GUI, all of these use a common interface called the ParameterSelectDialog that allows for interactive parameter selection. A basic ParameterSelectDialog window looks like the following:
The ParameterSelectDialog window is used to build a parameter, along with any dependencies, for use in a command or resource. Some resources and commands have different requirements for the types of parameters that can be used, so the ParameterSelectDialog can take slightly different forms, depending on where it's used. This section will describe the generic interface, then mention any resource- or command-specific exceptions.
General Usage
The first step in choosing a parameter is to select the object (or resource) type from the Object Type list in the upper right. Five types can appear in this list: Spacecraft, ImpulsiveBurn, Variable, Array, and String.
Once you've selected a type, The Object List box is populated with all existing resources of that type. Use this list to choose the specific resource you'd like to reference.
If the Spacecraft type is selected, the Attached Hardware List appears below the Object List. This list displays any hardware (such as FuelTank resources) attached to the selected Spacecraft. If the Array type is selected, Row and Col boxes appear. Use these to specify a row and column to select an individual array element, or check Select Entire Object to choose the entire array.
Once a resource is selected, the Object Properties list is populated with all available parameters provided by that resource. Some resources, such as instances of Variable or Array, are themselves parameters, so this list remains empty.
Parameters with different dependency types are commingled in the Object Properties list. When you select one, the appropriate dependency (if any) appears below the list. For example, after selecting the Spacecraft AOP parameter, a Coordinate System list appears. After selecting the Spacecraft Apoapsis parameter, a Central Body list appears. And after selecting the Spacecraft Cd parameter, no dependency list appears.
To select a parameter, select the appropriate Object Type, the specific resource from the Object List or Attached Hardware List, the desired parameter from the Object Properties list, and the required dependency, and add it to the Selected Value(s) list on the right. There are six buttons available to control this list:
- UP: Move the selected item in the Selected Value(s) list up one position (if allowed).
- DN: Move the selected item in the Selected Value(s) list down one position (if allowed).
- ->: Add the selected item in the Object Properties list to the Selected Value(s) list.
- <-: Remove the selected item in the Selected Value(s) list.
- =>: Add all items to the Selected Value(s) list.
- <=: Remove all items from the Selected Value(s) list.
When finished, the Selected Value(s) list contains the final selected parameters. Click OK to accept the selection.
Special Considerations
Some resources and commands (such as the Propagate command Parameter argument) only accept a single parameter as input; in this context the ParameterSelectDialog only allows one parameter in the Selected Value(s) list and does not allow use of the UP, DN, and => buttons.
In some instances (such as in the Vary command), only parameters that are also fields (and so can be set in the Mission Sequence) can be used. In this case only the allowed parameters will be shown in the Object Properties list.
In the Propagate command Parameter argument, only parameters of Spacecraft can be used. In this case only Spacecraft will be shown in the Object Type list.
Parameters
These tables will be transferred to the individual resource pages in the final documentation.
C1 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C1 |
C2 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C2 |
C3 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C3 |
C4 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C4 |
C5 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C5 |
C6 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C6 |
C7 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C7 |
C8 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C8 |
C9 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C9 |
C10 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C10 |
C11 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C11 |
C12 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C12 |
C13 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C13 |
C14 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C14 |
C15 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C15 |
C16 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Thrust Coefficient C16 |
K1 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K1 |
K2 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K2 |
K3 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K3 |
K4 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K4 |
K5 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K5 |
K6 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K6 |
K7 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K7 |
K8 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K8 |
K9 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K9 |
K10 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K10 |
K11 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K11 |
K12 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K12 |
K13 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K13 |
K14 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K14 |
K15 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K15 |
K16 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | Impulse Coefficient K16 |
ThrustDirection1 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | ThrustDirection1 |
ThrustDirection2 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | ThrustDirection2 |
ThrustDirection3 | Spacecraft | AttachedObject (Thruster) | Y | Y | Y | ThrustDirection3 |
Spacecraft
Parameter | Description | ||
ElapsedSecs | Spacecraft | Y | N |
ElapsedDays | Spacecraft | Y | N |
A1ModJulian | Spacecraft | Y | Y |
A1Gregorian | Spacecraft | Y | Y |
TAIModJulian | Spacecraft | Y | Y |
TAIGregorian | Spacecraft | Y | Y |
TTModJulian | Spacecraft | Y | Y |
TTGregorian | Spacecraft | Y | Y |
TDBModJulian | Spacecraft | Y | Y |
TDBGregorian | Spacecraft | Y | Y |
UTCModJulian | Spacecraft | Y | Y |
UTCGregorian | Spacecraft | Y | Y |
X | Spacecraft | Y | Y |
Y | Spacecraft | Y | Y |
Z | Spacecraft | Y | Y |
VX | Spacecraft | Y | Y |
VY | Spacecraft | Y | Y |
VZ | Spacecraft | Y | Y |
SMA | Spacecraft | Y | Y |
ECC | Spacecraft | Y | Y |
INC | Spacecraft | Y | Y |
RAAN | Spacecraft | Y | Y |
AOP | Spacecraft | Y | Y |
TA | Spacecraft | Y | Y |
MA | Spacecraft | Y | Y |
EA | Spacecraft | Y | Y |
HA | Spacecraft | Y | Y |
MM | Spacecraft | Y | N |
VelApoapsis | Spacecraft | Y | N |
VelPeriapsis | Spacecraft | Y | N |
Apoapsis | Spacecraft | Y | N |
Periapsis | Spacecraft | Y | N |
OrbitPeriod | Spacecraft | Y | N |
RadApo | Spacecraft | Y | Y |
RadPer | Spacecraft | Y | Y |
C3Energy | Spacecraft | Y | N |
Energy | Spacecraft | Y | N |
RMAG | Spacecraft | Y | Y |
RA | Spacecraft | Y | Y |
DEC | Spacecraft | Y | Y |
VMAG | Spacecraft | Y | Y |
RAV | Spacecraft | Y | Y |
DECV | Spacecraft | Y | Y |
AZI | Spacecraft | Y | Y |
FPA | Spacecraft | Y | Y |
SemilatusRectum | Spacecraft | Y | N |
HMAG | Spacecraft | Y | N |
HX | Spacecraft | Y | N |
HY | Spacecraft | Y | N |
HZ | Spacecraft | Y | N |
DLA | Spacecraft | Y | N |
RLA | Spacecraft | Y | N |
Altitude | Spacecraft | Y | N |
MHA | Spacecraft | Y | N |
Longitude | Spacecraft | Y | N |
Latitude | Spacecraft | Y | N |
LST | Spacecraft | Y | N |
BetaAngle | Spacecraft | Y | N |
BdotT | Spacecraft | Y | N |
BdotR | Spacecraft | Y | N |
BVectorMag | Spacecraft | Y | N |
BVectorAngle | Spacecraft | Y | N |
DCM11 | Spacecraft | Y | Y |
DCM12 | Spacecraft | Y | Y |
DCM13 | Spacecraft | Y | Y |
DCM21 | Spacecraft | Y | Y |
DCM22 | Spacecraft | Y | Y |
DCM23 | Spacecraft | Y | Y |
DCM31 | Spacecraft | Y | Y |
DCM32 | Spacecraft | Y | Y |
DCM33 | Spacecraft | Y | Y |
EulerAngle1 | Spacecraft | Y | Y |
EulerAngle2 | Spacecraft | Y | Y |
EulerAngle3 | Spacecraft | Y | Y |
MRP1 | Spacecraft | Y | Y |
MRP2 | Spacecraft | Y | Y |
MRP3 | Spacecraft | Y | Y |
Q1 | Spacecraft | Y | N |
Q2 | Spacecraft | Y | N |
Q3 | Spacecraft | Y | N |
Q4 | Spacecraft | Y | N |
Quaternion | Spacecraft | Y | Y |
AngularVelocityX | Spacecraft | Y | Y |
AngularVelocityY | Spacecraft | Y | Y |
AngularVelocityZ | Spacecraft | Y | Y |
EulerAngleRate1 | Spacecraft | Y | Y |
EulerAngleRate2 | Spacecraft | Y | Y |
EulerAngleRate3 | Spacecraft | Y | Y |
DryMass | Spacecraft | Y | Y |
Cd | Spacecraft | Y | Y |
Cr | Spacecraft | Y | Y |
DragArea | Spacecraft | Y | Y |
SRPArea | Spacecraft | Y | Y |
TotalMass | Spacecraft | Y | N |
OrbitSTM | Spacecraft | Y | N |
OrbitSTMA | Spacecraft | Y | N |
OrbitSTMB | Spacecraft | Y | N |
OrbitSTMC | Spacecraft | Y | N |
OrbitSTMD | Spacecraft | Y | N |
ImpulsiveBurn
Parameter | Description | ||
Element1 | ImpulsiveBurn | Y | Y |
Element2 | ImpulsiveBurn | Y | Y |
Element3 | ImpulsiveBurn | Y | Y |
V | ImpulsiveBurn | Y | Y |
N | ImpulsiveBurn | Y | Y |
B | ImpulsiveBurn | Y | Y |
FuelTank
Parameter | Description | ||
FuelMass | Spacecraft | Y | Y |
Volume | Spacecraft | Y | Y |
FuelDensity | Spacecraft | Y | Y |
Pressure | Spacecraft | Y | Y |
Temperature | Spacecraft | Y | Y |
RefTemperature | Spacecraft | Y | Y |
DutyCycle | Spacecraft | Y | Y |
ThrustScaleFactor | Spacecraft | Y | Y |
GravitationalAccel | Spacecraft | Y | Y |
Examples
Describe the example with a short sentence two and include minimal script for example below
Create Spacecraft aSat; Create ForceModel aForceModel; Create Propagator aProp; aProp.FM = aForceModel; aProp.Type = PrinceDormand78; aProp.InitialStepSize = 60; aProp.Accuracy = 1e-011; aProp.MinStep = 0; aProp.MaxStep = 86400; aProp.MaxStepAttempts = 50; aProp.StopIfAccuracyIsViolated = true; BeginMissionSequence Propagate aProp(aSat) {aSat.ElapsedDays = .2};
Test Procedures
Assumptions
If you are making assumptions about how tests will be performed or that other test areas will cover some of this functionality describe that here.
Existing Tests
Describe existing test types using a row for each class of test.
Priority | Status | Summary |
Recommended Additional Tests
Nominal Tests
Priority | Status | Summary |
[for Resources only] Cloning the resource in the Mission Sequence, using all non-default values in all field configurations | ||
Edge/Corner/Stres
Priority | Status | Summary |
Unique Validation
Priority | Status | Summary |
Unique Mode Tests
Priority | Status | Summary |
Unique GUI Tests
These are tests that are unique to the GUI interface for this feature that are not covered by the standard GUI test template and procedures.
Priority | Status | Summary |
Contents: