APMFile (ORbit Extrapolation KIT 10.2 API)

java.lang.Object
- org.orekit.files.ccsds.NDMFile
- - org.orekit.files.ccsds.ADMFile
  - - org.orekit.files.ccsds.APMFile

```
public class APMFile
extends ADMFile
```
This class stocks all the information of the Attitude Parameter Message (APM) File parsed by APMParser. It contains the header and the metadata and a the data lines.

Since:

10.2

Author:

Bryan Cazabonne

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class APMFile.APMManeuver
Maneuver in an APM file.

Nested Classes
Modifier and Type	Class and Description
`static class`	`APMFile.APMManeuver` Maneuver in an APM file.

Constructor Summary

Constructors
Constructor and Description

APMFile()
APMFile constructor.

Constructors
Constructor and Description
`APMFile()` APMFile constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addManeuver(APMFile.APMManeuver maneuver)` Add a maneuver.
`String`	`getAttitudeQuaternionDirection()` Get the rotation direction of the attitude quaternion.
`AbsoluteDate`	`getEpoch()` Get the epoch of the data.
`List<String>`	`getEpochComment()` Get the comment for epoch.
`List<String>`	`getEulerComment()` Get the comment for Euler angles.
`String`	`getEulerDirection()` Get the rotation direction of the attitude Euler angles (A2B or B2A).
`String`	`getEulerFrameAString()` Get the reference frame specifying one frame of the transformation.
`String`	`getEulerFrameBString()` Get the reference frame specifying the second portion of the transformation.
`String`	`getEulerRotSeq()` Get the rotation order of Euler angles (X=1, Y=2, Z=3).
`boolean`	`getHasManeuver()` Get boolean testing whether the APM contains at least one maneuver.
`double`	`getI11()` Get the moment of Inertia about the 1-axis (N.m²).
`double`	`getI12()` Get the moment of Inertia about the 1 and 2 axes (N.m²).
`double`	`getI13()` Get the moment of Inertia about the 1 and 3 axes (N.m²).
`double`	`getI22()` Get the moment of Inertia about the 2-axis (N.m²).
`double`	`getI23()` Get the moment of Inertia about the 2 and 3 axes (N.m²).
`double`	`getI33()` Get the moment of Inertia about the 3-axis (N.m²).
`String`	`getInertiaRefFrameString()` Get the coordinate system for the inertia tensor.
`APMFile.APMManeuver`	`getManeuver(int index)` Get a maneuver.
`List<APMFile.APMManeuver>`	`getManeuvers()` Get a list of all maneuvers.
`ADMMetaData`	`getMetaData()` Get the meta data.
`List<String>`	`getMetaDataComment()` Get the comment for meta-data.
`int`	`getNbManeuvers()` Get the number of maneuvers present in the APM.
`double`	`getNutation()` Get the nutation angle of spin axis (rad).
`double`	`getNutationPeriod()` Get the body nutation period of the spin axis (s).
`double`	`getNutationPhase()` Get the inertial nutation phase (rad).
`Quaternion`	`getQuaternion()` Get the quaternion.
`Quaternion`	`getQuaternionDot()` Get the derivative of the quaternion.
`String`	`getQuaternionFrameAString()` Get the reference frame specifying one frame of the transformation.
`String`	`getQuaternionFrameBString()` Get the reference frame specifying the second portion of the transformation.
`String`	`getRateFrameString()` Get the frame of reference in which the Euler angles are expressed.
`Vector3D`	`getRotationAngles()` Get the coordinates of the Euler angles (rad).
`Vector3D`	`getRotationRates()` Get the rates of the Euler angles (rad/s).
`List<String>`	`getSpacecraftComment()` Get the comment for spacecraft.
`double`	`getSpinAlpha()` Get the right ascension of spin axis vector (rad).
`double`	`getSpinAngle()` Get the phase of the satellite about the spin axis (rad).
`double`	`getSpinAngleVel()` Get the angular velocity of satellite around spin axis (rad/s).
`List<String>`	`getSpinComment()` Get the comment for spin data.
`double`	`getSpinDelta()` Get the declination of the spin axis vector (rad).
`String`	`getSpinDirection()` Get the rotation direction of the Spin angles.
`String`	`getSpinFrameAString()` Get the reference frame specifying one frame of the transformation (spin).
`String`	`getSpinFrameBString()` Get the reference frame specifying the second portion of the transformation (spin).
`void`	`setAttitudeQuaternionDirection(String direction)` Set the rotation direction of the attitude quaternion.
`void`	`setEpoch(AbsoluteDate epoch)` Set the epoch of the data.
`void`	`setEpochComment(List<String> comment)` Set the comment for epoch.
`void`	`setEulerComment(List<String> comment)` Set the comment for Euler angles.
`void`	`setEulerDirection(String direction)` Set the rotation direction of the attitude Euler angles (A2B or B2A).
`void`	`setEulerFrameAString(String frame)` Set the reference frame specifying one frame of the transformation.
`void`	`setEulerFrameBString(String frame)` Set the reference frame specifying the second portion of the transformation.
`void`	`setEulerRotSeq(String eulerRotSeq)` Set the rotation order for Euler angles (X=1, Y=2, Z=3).
`void`	`setI11(double i11)` Set the moment of Inertia about the 1-axis (N.m²).
`void`	`setI12(double i12)` Set the moment of Inertia about the 1 and 2 axes (N.m²).
`void`	`setI13(double i13)` Set the moment of Inertia about the 1 and 3 axes (N.m²).
`void`	`setI22(double i22)` Set the moment of Inertia about the 2-axis (N.m²).
`void`	`setI23(double i23)` Set the moment of Inertia about the 2 and 3 axes (N.m²).
`void`	`setI33(double i33)` Set the moment of Inertia about the 3-axis (N.m²).
`void`	`setInertiaRefFrameString(String frame)` Set the coordinate system for the inertia tensor.
`void`	`setNutation(double nutation)` Set the nutation angle of spin axis (rad).
`void`	`setNutationPeriod(double period)` Set the body nutation period of the spin axis (s).
`void`	`setNutationPhase(double nutationPhase)` Set the inertial nutation phase (rad).
`void`	`setQuaternion(Quaternion q)` Set the quaternion.
`void`	`setQuaternionDot(Quaternion qDot)` Set the derivative of the quaternion.
`void`	`setQuaternionFrameAString(String frameA)` Set the reference frame specifying one frame of the transformation.
`void`	`setQuaternionFrameBString(String frameB)` Set the reference frame specifying the second portion of the transformation.
`void`	`setRateFrameString(String frame)` Set the frame of reference in which the Euler angles are expressed.
`void`	`setRotationAngles(Vector3D rotationAngles)` Set the coordinates of the Euler angles (rad).
`void`	`setRotationRates(Vector3D rotationRates)` Set the rates of the Euler angles (rad/s).
`void`	`setSpacecraftComment(List<String> comment)` Set the comment for spacecraft.
`void`	`setSpinAlpha(double spinAlpha)` Set the right ascension of spin axis vector (rad).
`void`	`setSpinAngle(double spinAngle)` Set the phase of the satellite about the spin axis (rad).
`void`	`setSpinAngleVel(double spinAngleVel)` Set the angular velocity of satellite around spin axis (rad/s).
`void`	`setSpinComment(List<String> comment)` Set the comment for spin data.
`void`	`setSpinDelta(double spinDelta)` Set the declination of the spin axis vector (rad).
`void`	`setSpinDirection(String direction)` Set the rotation direction of the Spin angles.
`void`	`setSpinFrameAString(String frame)` Set the reference frame specifying one frame of the transformation (spin).
`void`	`setSpinFrameBString(String frame)` Set the reference frame specifying the second portion of the transformation (spin).

Methods inherited from class org.orekit.files.ccsds.NDMFile
getConventions, getCreationDate, getDataContext, getFormatVersion, getHeaderComment, getMissionReferenceDate, getMu, getOriginator, setConventions, setCreationDate, setDataContext, setFormatVersion, setHeaderComment, setMissionReferenceDate, setMu, setOriginator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - APMFile
```
public APMFile()
```
    APMFile constructor.
- Method Detail
  - getMetaData
```
public ADMMetaData getMetaData()
```
    Get the meta data.
    
    Returns:
    
    meta data
  - getEpoch
```
public AbsoluteDate getEpoch()
```
    Get the epoch of the data.
    
    Returns:
    
    epoch the epoch
  - setEpoch
```
public void setEpoch(AbsoluteDate epoch)
```
    Set the epoch of the data.
    
    Parameters:
    
    epoch - the epoch to be set
  - getQuaternionFrameAString
```
public String getQuaternionFrameAString()
```
    Get the reference frame specifying one frame of the transformation.
    
    Returns:
    
    the reference frame A
  - setQuaternionFrameAString
```
public void setQuaternionFrameAString(String frameA)
```
    Set the reference frame specifying one frame of the transformation.
    
    Parameters:
    
    frameA - the frame to be set
  - getQuaternionFrameBString
```
public String getQuaternionFrameBString()
```
    Get the reference frame specifying the second portion of the transformation.
    
    Returns:
    
    the reference frame B
  - setQuaternionFrameBString
```
public void setQuaternionFrameBString(String frameB)
```
    Set the reference frame specifying the second portion of the transformation.
    
    Parameters:
    
    frameB - the frame to be set
  - getAttitudeQuaternionDirection
```
public String getAttitudeQuaternionDirection()
```
    Get the rotation direction of the attitude quaternion.
    
    Returns:
    
    the rotation direction of the attitude quaternion
  - setAttitudeQuaternionDirection
```
public void setAttitudeQuaternionDirection(String direction)
```
    Set the rotation direction of the attitude quaternion.
    
    Parameters:
    
    direction - rotation direction to be set
  - getQuaternion
```
public Quaternion getQuaternion()
```
    Get the quaternion.
    
    Returns:
    
    quaternion
  - setQuaternion
```
public void setQuaternion(Quaternion q)
```
    Set the quaternion.
    
    Parameters:
    
    q - quaternion to set
  - getQuaternionDot
```
public Quaternion getQuaternionDot()
```
    Get the derivative of the quaternion.
    
    Returns:
    
    the derivative of the quaternion
  - setQuaternionDot
```
public void setQuaternionDot(Quaternion qDot)
```
    Set the derivative of the quaternion.
    
    Parameters:
    
    qDot - quaternion to set
  - getEulerFrameAString
```
public String getEulerFrameAString()
```
    Get the reference frame specifying one frame of the transformation.
    
    Returns:
    
    reference frame A
  - setEulerFrameAString
```
public void setEulerFrameAString(String frame)
```
    Set the reference frame specifying one frame of the transformation.
    
    Parameters:
    
    frame - the frame to be set
  - getEulerFrameBString
```
public String getEulerFrameBString()
```
    Get the reference frame specifying the second portion of the transformation.
    
    Returns:
    
    reference frame B
  - setEulerFrameBString
```
public void setEulerFrameBString(String frame)
```
    Set the reference frame specifying the second portion of the transformation.
    
    Parameters:
    
    frame - the frame to be set
  - getEulerDirection
```
public String getEulerDirection()
```
    Get the rotation direction of the attitude Euler angles (A2B or B2A).
    
    Returns:
    
    the rotation direction
  - setEulerDirection
```
public void setEulerDirection(String direction)
```
    Set the rotation direction of the attitude Euler angles (A2B or B2A).
    
    Parameters:
    
    direction - direction to be set
  - getEulerRotSeq
```
public String getEulerRotSeq()
```
    Get the rotation order of Euler angles (X=1, Y=2, Z=3).
    
    Returns:
    
    rotation order
  - setEulerRotSeq
```
public void setEulerRotSeq(String eulerRotSeq)
```
    Set the rotation order for Euler angles (X=1, Y=2, Z=3).
    
    Parameters:
    
    eulerRotSeq - order to be setS
  - getRateFrameString
```
public String getRateFrameString()
```
    Get the frame of reference in which the Euler angles are expressed.
    
    Returns:
    
    the frame of reference
  - setRateFrameString
```
public void setRateFrameString(String frame)
```
    Set the frame of reference in which the Euler angles are expressed.
    
    Parameters:
    
    frame - frame to be set
  - getRotationAngles
```
public Vector3D getRotationAngles()
```
    Get the coordinates of the Euler angles (rad).
    
    Returns:
    
    rotation angles
  - setRotationAngles
```
public void setRotationAngles(Vector3D rotationAngles)
```
    Set the coordinates of the Euler angles (rad).
    
    Parameters:
    
    rotationAngles - coordinates to be set
  - getRotationRates
```
public Vector3D getRotationRates()
```
    Get the rates of the Euler angles (rad/s).
    
    Returns:
    
    rotation rates
  - setRotationRates
```
public void setRotationRates(Vector3D rotationRates)
```
    Set the rates of the Euler angles (rad/s).
    
    Parameters:
    
    rotationRates - coordinates to be set
  - getSpinFrameAString
```
public String getSpinFrameAString()
```
    Get the reference frame specifying one frame of the transformation (spin).
    
    Returns:
    
    reference frame
  - setSpinFrameAString
```
public void setSpinFrameAString(String frame)
```
    Set the reference frame specifying one frame of the transformation (spin).
    
    Parameters:
    
    frame - frame to be set
  - getSpinFrameBString
```
public String getSpinFrameBString()
```
    Get the reference frame specifying the second portion of the transformation (spin).
    
    Returns:
    
    reference frame
  - setSpinFrameBString
```
public void setSpinFrameBString(String frame)
```
    Set the reference frame specifying the second portion of the transformation (spin).
    
    Parameters:
    
    frame - frame to be set
  - getSpinDirection
```
public String getSpinDirection()
```
    Get the rotation direction of the Spin angles.
    
    Returns:
    
    the rotation direction
  - setSpinDirection
```
public void setSpinDirection(String direction)
```
    Set the rotation direction of the Spin angles.
    
    Parameters:
    
    direction - rotation direction to be set
  - getSpinAlpha
```
public double getSpinAlpha()
```
    Get the right ascension of spin axis vector (rad).
    
    Returns:
    
    the right ascension of spin axis vector
  - setSpinAlpha
```
public void setSpinAlpha(double spinAlpha)
```
    Set the right ascension of spin axis vector (rad).
    
    Parameters:
    
    spinAlpha - value to be set
  - getSpinDelta
```
public double getSpinDelta()
```
    Get the declination of the spin axis vector (rad).
    
    Returns:
    
    the declination of the spin axis vector (rad).
  - setSpinDelta
```
public void setSpinDelta(double spinDelta)
```
    Set the declination of the spin axis vector (rad).
    
    Parameters:
    
    spinDelta - value to be set
  - getSpinAngle
```
public double getSpinAngle()
```
    Get the phase of the satellite about the spin axis (rad).
    
    Returns:
    
    the phase of the satellite about the spin axis
  - setSpinAngle
```
public void setSpinAngle(double spinAngle)
```
    Set the phase of the satellite about the spin axis (rad).
    
    Parameters:
    
    spinAngle - value to be set
  - getSpinAngleVel
```
public double getSpinAngleVel()
```
    Get the angular velocity of satellite around spin axis (rad/s).
    
    Returns:
    
    the angular velocity of satellite around spin axis
  - setSpinAngleVel
```
public void setSpinAngleVel(double spinAngleVel)
```
    Set the angular velocity of satellite around spin axis (rad/s).
    
    Parameters:
    
    spinAngleVel - value to be set
  - getNutation
```
public double getNutation()
```
    Get the nutation angle of spin axis (rad).
    
    Returns:
    
    the nutation angle of spin axis
  - setNutation
```
public void setNutation(double nutation)
```
    Set the nutation angle of spin axis (rad).
    
    Parameters:
    
    nutation - the nutation angle to be set
  - getNutationPeriod
```
public double getNutationPeriod()
```
    Get the body nutation period of the spin axis (s).
    
    Returns:
    
    the body nutation period of the spin axis
  - setNutationPeriod
```
public void setNutationPeriod(double period)
```
    Set the body nutation period of the spin axis (s).
    
    Parameters:
    
    period - the nutation period to be set
  - getNutationPhase
```
public double getNutationPhase()
```
    Get the inertial nutation phase (rad).
    
    Returns:
    
    the inertial nutation phase
  - setNutationPhase
```
public void setNutationPhase(double nutationPhase)
```
    Set the inertial nutation phase (rad).
    
    Parameters:
    
    nutationPhase - the nutation phase to be set
  - getInertiaRefFrameString
```
public String getInertiaRefFrameString()
```
    Get the coordinate system for the inertia tensor.
    
    Returns:
    
    the coordinate system for the inertia tensor
  - setInertiaRefFrameString
```
public void setInertiaRefFrameString(String frame)
```
    Set the coordinate system for the inertia tensor.
    
    Parameters:
    
    frame - frame to be set
  - getI11
```
public double getI11()
```
    Get the moment of Inertia about the 1-axis (N.m²).
    
    Returns:
    
    the moment of Inertia about the 1-axis.
  - setI11
```
public void setI11(double i11)
```
    Set the moment of Inertia about the 1-axis (N.m²).
    
    Parameters:
    
    i11 - moment of Inertia about the 1-axis
  - getI22
```
public double getI22()
```
    Get the moment of Inertia about the 2-axis (N.m²).
    
    Returns:
    
    the moment of Inertia about the 2-axis.
  - setI22
```
public void setI22(double i22)
```
    Set the moment of Inertia about the 2-axis (N.m²).
    
    Parameters:
    
    i22 - moment of Inertia about the 2-axis
  - getI33
```
public double getI33()
```
    Get the moment of Inertia about the 3-axis (N.m²).
    
    Returns:
    
    the moment of Inertia about the 3-axis.
  - setI33
```
public void setI33(double i33)
```
    Set the moment of Inertia about the 3-axis (N.m²).
    
    Parameters:
    
    i33 - moment of Inertia about the 3-axis
  - getI12
```
public double getI12()
```
    Get the moment of Inertia about the 1 and 2 axes (N.m²).
    
    Returns:
    
    the moment of Inertia about the 1 and 2 axes.
  - setI12
```
public void setI12(double i12)
```
    Set the moment of Inertia about the 1 and 2 axes (N.m²).
    
    Parameters:
    
    i12 - moment of Inertia about the 1 and 2 axes
  - getI13
```
public double getI13()
```
    Get the moment of Inertia about the 1 and 3 axes (N.m²).
    
    Returns:
    
    the moment of Inertia about the 1 and 3 axes.
  - setI13
```
public void setI13(double i13)
```
    Set the moment of Inertia about the 1 and 3 axes (N.m²).
    
    Parameters:
    
    i13 - moment of Inertia about the 1 and 3 axes
  - getI23
```
public double getI23()
```
    Get the moment of Inertia about the 2 and 3 axes (N.m²).
    
    Returns:
    
    the moment of Inertia about the 2 and 3 axes.
  - setI23
```
public void setI23(double i23)
```
    Set the moment of Inertia about the 2 and 3 axes (N.m²).
    
    Parameters:
    
    i23 - moment of Inertia about the 2 and 3 axes
  - getEpochComment
```
public List<String> getEpochComment()
```
    Get the comment for epoch.
    
    Returns:
    
    comment for epoch
  - setEpochComment
```
public void setEpochComment(List<String> comment)
```
    Set the comment for epoch.
    
    Parameters:
    
    comment - comment to set
  - getEulerComment
```
public List<String> getEulerComment()
```
    Get the comment for Euler angles.
    
    Returns:
    
    comment for Euler angles
  - setEulerComment
```
public void setEulerComment(List<String> comment)
```
    Set the comment for Euler angles.
    
    Parameters:
    
    comment - comment to set
  - getSpinComment
```
public List<String> getSpinComment()
```
    Get the comment for spin data.
    
    Returns:
    
    comment for spin data
  - setSpinComment
```
public void setSpinComment(List<String> comment)
```
    Set the comment for spin data.
    
    Parameters:
    
    comment - comment to set
  - getSpacecraftComment
```
public List<String> getSpacecraftComment()
```
    Get the comment for spacecraft.
    
    Returns:
    
    comment for spacecraft
  - setSpacecraftComment
```
public void setSpacecraftComment(List<String> comment)
```
    Set the comment for spacecraft.
    
    Parameters:
    
    comment - comment to set
  - getNbManeuvers
```
public int getNbManeuvers()
```
    Get the number of maneuvers present in the APM.
    
    Returns:
    
    the number of maneuvers
  - getManeuvers
```
public List<APMFile.APMManeuver> getManeuvers()
```
    Get a list of all maneuvers.
    
    Returns:
    
    unmodifiable list of all maneuvers.
  - getManeuver
```
public APMFile.APMManeuver getManeuver(int index)
```
    Get a maneuver.
    
    Parameters:
    
    index - maneuver index, counting from 0
    
    Returns:
    
    maneuver
  - addManeuver
```
public void addManeuver(APMFile.APMManeuver maneuver)
```
    Add a maneuver.
    
    Parameters:
    
    maneuver - maneuver to be set
  - getHasManeuver
```
public boolean getHasManeuver()
```
    Get boolean testing whether the APM contains at least one maneuver.
    
    Returns:
    
    true if APM contains at least one maneuver false otherwise
  - getMetaDataComment
```
public List<String> getMetaDataComment()
```
    Get the comment for meta-data.
    
    Returns:
    
    comment for meta-data

Class APMFile

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.orekit.files.ccsds.NDMFile

Methods inherited from class java.lang.Object

Constructor Detail

APMFile

Method Detail

getMetaData

getEpoch

setEpoch

getQuaternionFrameAString

setQuaternionFrameAString

getQuaternionFrameBString

setQuaternionFrameBString

getAttitudeQuaternionDirection

setAttitudeQuaternionDirection

getQuaternion

setQuaternion

getQuaternionDot

setQuaternionDot

getEulerFrameAString

setEulerFrameAString

getEulerFrameBString

setEulerFrameBString

getEulerDirection

setEulerDirection

getEulerRotSeq

setEulerRotSeq

getRateFrameString

setRateFrameString

getRotationAngles

setRotationAngles

getRotationRates

setRotationRates

getSpinFrameAString

setSpinFrameAString

getSpinFrameBString

setSpinFrameBString

getSpinDirection

setSpinDirection

getSpinAlpha

setSpinAlpha

getSpinDelta

setSpinDelta

getSpinAngle

setSpinAngle

getSpinAngleVel

setSpinAngleVel

getNutation

setNutation

getNutationPeriod

setNutationPeriod

getNutationPhase

setNutationPhase

getInertiaRefFrameString

setInertiaRefFrameString

getI11

setI11

getI22

setI22

getI33

setI33

getI12

setI12

getI13

setI13

getI23

setI23

getEpochComment

setEpochComment

getEulerComment

setEulerComment

getSpinComment

setSpinComment

getSpacecraftComment

setSpacecraftComment

getNbManeuvers

getManeuvers