Package org.orekit.files.iirv
Class IIRVMessage
java.lang.Object
org.orekit.files.iirv.IIRVMessage
Container for Improved Interrange Vector (IIRV) messages, implemented as a list of sequential
IIRVVector
instances.
The IIRV message consists of a series of sequential IIRVVectors that each contains ephemeris state data
at a particular epoch. The message body is defined as:
ttuuuuuuuqjjGIIRVarrrr<<≡≡
vs1ciiiibbnnndoyhhmmsssssccc<<≡≡
sxxxxxxxxxxxxsyyyyyyyyyyyyszzzzzzzzzzzzccc<<==
sxxxxxxxxxxxxsyyyyyyyyyyyyszzzzzzzzzzzzccc<<==
mmmmmmmmaaaaakkkksrrrrrrrccc<<==
ITERM oooo<<==
| 1 | tt |
2 characters | Constant | Message Type (Operations Data Message) | MessageTypeTerm |
|---|---|---|---|---|---|
uuuuuuu |
0000000 to 9999999 | Integer | Message ID | MessageIDTerm |
|
q |
1 character | String | Message Source | MessageSourceTerm |
|
jj |
|
String | Message class (10=nominal) | MessageClassTerm |
|
GIIRV |
"GIIRV" | Constant | Message ID | MessageStartConstantTerm |
|
a |
|
String | Origin identification | OriginIdentificationTerm |
|
rrrr |
|
String | Destination routing indicator | RoutingIndicatorTerm |
|
<< |
"\r\r" | Constant | Carriage returns | n/a | |
| == | "\n\n" | Constant | Line feeds | n/a | |
| 2 | v |
|
Integer | Vector type | VectorTypeTerm |
s |
|
Integer | Source of data | DataSourceTerm |
|
1 |
"1" = interrange message | Constant | Transfer type | TransferTypeConstantTerm |
|
c |
|
Integer | Coordinate system | CoordinateSystemTerm |
|
iiii |
0000-9999 | Integer | Support Identification Code (SIC) | SupportIdCodeTerm |
|
bb |
00-99 | Integer | Vehicle Identification Code (VIC) | VehicleIdCodeTerm |
|
nnn |
000-999 | Integer | Sequence number | SequenceNumberTerm |
|
doy |
001-366 | Integer | Day of year | DayOfYearTerm |
|
hhmmsssss |
000000000 - 235959999 | Integer | Vector epoch (in UTC) HH:mm:ss.SSS |
VectorEpochTerm |
|
ccc |
000-999 | Integer | Checksum for line 2 | CheckSumTerm |
|
<< |
"\r\r" | Constant | Carriage returns | n/a | |
| == | "\n\n" | Constant | Line feeds | n/a | |
| 3 | s |
|
Integer | Positive/negative sign | n/a |
xxxxxxxxxxxx |
0 - 9999999999999 | Integer | X component of position (m) | PositionVectorComponentTerm |
|
yyyyyyyyyyyy |
0 - 9999999999999 | Integer | Y component of position (m) | PositionVectorComponentTerm |
|
zzzzzzzzzzzz |
0 - 9999999999999 | Integer | Z component of position (m) | PositionVectorComponentTerm |
|
ccc |
000-999 | Integer | Checksum for line 3 | CheckSumTerm |
|
<< |
"\r\r" | Constant | Carriage returns | n/a | |
| == | "\n\n" | Constant | Line feeds | n/a | |
| 4 | s |
|
Integer | Positive/negative sign | n/a |
xxxxxxxxxxxx |
0 - 9999999999.999 | Double | X component of velocity (m/s) | VelocityVectorComponentTerm |
|
yyyyyyyyyyyy |
0 - 9999999999.999 | Double | Y component of velocity (m/s) | VelocityVectorComponentTerm |
|
zzzzzzzzzzzz |
0 - 9999999999.999 | Double | Z component of velocity (m/s) | VelocityVectorComponentTerm |
|
ccc |
000-999 | Integer | Checksum for line 4 | CheckSumTerm |
|
<< |
"\r\r" | Constant | Carriage returns | n/a | |
| == | "\n\n" | Constant | Line feeds | n/a | |
| 5 | mmmmmmmm |
0 - 99999999.9 | Double | Spacecraft mass (kg) | MassTerm |
aaaaa |
0 - 999.99 | Double | Average cross-sectional area (m^2) | CrossSectionalAreaTerm |
|
kkkk |
0 - 99.99 | Double | Drag coefficient (dimensionless) | DragCoefficientTerm |
|
srrrrrrr |
-99.99999 to 99.99999 | Double | Solar reflectivity coefficient (dimensionless) | SolarReflectivityCoefficientTerm |
|
ccc |
000-999 | Integer | Checksum for line 5 | CheckSumTerm |
|
<< |
"\r\r" | Constant | Carriage returns | n/a | |
| == | "\n\n" | Constant | Line feeds | n/a | |
| 6 | ITERM |
"ITERM" | Constant | End of message | MessageEndConstantTerm |
ITERM |
ASCII Space | Constant | Spare (blank) character | SpareConstantTerm |
|
oooo |
"GCQU" or "GAQD" | String | Originator routing indicator | OriginatorRoutingIndicatorTerm |
|
<< |
"\r\r" | Constant | Carriage returns | n/a | |
| == | "\n\n" | Constant | Line feeds | n/a | |
| 7-12 | Second IIRVVector in message |
||||
| 13-18 | Third IIRVVector in message |
||||
| ... | nth IIRVVector in message |
||||
- Since:
- 13.0
- Author:
- Nick LaFarge
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumOptions for how message metadata appears in the IIRV message file. -
Constructor Summary
ConstructorsConstructorDescriptionConstructor that initializes to an empty list of vectors.IIRVMessage(List<IIRVVector> vectors) Constructor from a list of IIRVIIRVVectors that monotonically increase in bothSequenceNumberTermand time (DayOfYearTermandVectorEpochTerm).IIRVMessage(IIRVMessage other) Copy constructor.IIRVMessage(IIRVVector... vectors) Constructor from a list of IIRVIIRVVectors that monotonically increase in bothSequenceNumberTermand time (DayOfYearTermandVectorEpochTerm). -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(IIRVVector v) Adds anIIRVVectorto the message (seeArrayList.add(Object)).booleanget(int i) Gets theIIRVVectorlocated at a given index in the message.Returns the satellite ID (set to the value of theVehicleIdCodeTerm).Gets the list of sequentialIIRVVectorinstances contained within the overall IIRV message.getVectorStrings(IIRVMessage.IncludeMessageMetadata includeMessageMetadataSetting) Converts theIIRVVectors contained in the message file into a list of their String representations.inthashCode()booleanisEmpty()Returns true if no vectors exist in the message.intsize()Returns the number of IIRV vectors contained in the message.toMessageString(IIRVMessage.IncludeMessageMetadata includeMessageMetadataSetting) Converts theIIRVVectors contained in the message file into a single String, where no deliminator included between each vector (the vectors already have trailing line carriage and line returns).
-
Constructor Details
-
IIRVMessage
public IIRVMessage()Constructor that initializes to an empty list of vectors. -
IIRVMessage
Constructor from a list of IIRVIIRVVectors that monotonically increase in bothSequenceNumberTermand time (DayOfYearTermandVectorEpochTerm).- Parameters:
vectors- list of sequentialIIRVVectors.
-
IIRVMessage
Constructor from a list of IIRVIIRVVectors that monotonically increase in bothSequenceNumberTermand time (DayOfYearTermandVectorEpochTerm).- Parameters:
vectors- list of sequential IIRV vectors.
-
IIRVMessage
Copy constructor.- Parameters:
other- otherIIRVMessageinstance.
-
-
Method Details
-
equals
-
hashCode
public int hashCode() -
add
Adds anIIRVVectorto the message (seeArrayList.add(Object)).- Parameters:
v- IIRV vector to add to the message
-
get
Gets theIIRVVectorlocated at a given index in the message.- Parameters:
i- index of the element to return- Returns:
- element at the given index
- See Also:
-
size
public int size()Returns the number of IIRV vectors contained in the message.- Returns:
- number of IIRV vectors contained in the message
- See Also:
-
isEmpty
public boolean isEmpty()Returns true if no vectors exist in the message.- Returns:
- true if no vectors exist in the message
- See Also:
-
getVectorStrings
public ArrayList<String> getVectorStrings(IIRVMessage.IncludeMessageMetadata includeMessageMetadataSetting) Converts theIIRVVectors contained in the message file into a list of their String representations.- Parameters:
includeMessageMetadataSetting- Setting for when message metadata terms appear in the created IIRV message- Returns:
- list of
IIRVVectorstrings for each vector the message - See Also:
-
toMessageString
Converts theIIRVVectors contained in the message file into a single String, where no deliminator included between each vector (the vectors already have trailing line carriage and line returns).- Parameters:
includeMessageMetadataSetting- Setting for when message metadata terms appear in the created IIRV message- Returns:
- String containing all
IIRVVectors for the IIRV message - See Also:
-
getVectors
Gets the list of sequentialIIRVVectorinstances contained within the overall IIRV message.- Returns:
- list of sequential
IIRVVectorinstances contained within the overall IIRV message.
-
getSatelliteID
Returns the satellite ID (set to the value of theVehicleIdCodeTerm).- Returns:
- the satellite ID
- See Also:
-