Class AemMetadata
- java.lang.Object
-
- org.orekit.files.ccsds.section.CommentsContainer
-
- org.orekit.files.ccsds.section.Metadata
-
- org.orekit.files.ccsds.ndm.adm.AdmMetadata
-
- org.orekit.files.ccsds.ndm.adm.aem.AemMetadata
-
- All Implemented Interfaces:
Section
public class AemMetadata extends AdmMetadata
This class gathers the meta-data present in the Attitude Data Message (ADM).- Since:
- 10.2
- Author:
- Bryan Cazabonne
-
-
Constructor Summary
Constructors Constructor Description AemMetadata(int defaultInterpolationDegree)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AttitudeType
getAttitudeType()
Get the format of the data lines in the message.AttitudeEndpoints
getEndpoints()
Get the endpoints (i.e.RotationOrder
getEulerRotSeq()
Get the rotation order of Euler angles.FrameFacade
getFrameAngvelFrame()
Get frame in which angular velocities are specified.int
getInterpolationDegree()
Get the interpolation degree.String
getInterpolationMethod()
Get the interpolation method to be used.int
getInterpolationSamples()
Get the number of samples to use in interpolation.AbsoluteDate
getStart()
Get the start date of this ephemeris segment.AbsoluteDate
getStartTime()
Get start of total time span covered by attitude data.AbsoluteDate
getStop()
Get the end date of this ephemeris segment.AbsoluteDate
getStopTime()
Get end of total time span covered by attitude data.AbsoluteDate
getUseableStartTime()
Get start of useable time span covered by attitude data.AbsoluteDate
getUseableStopTime()
Get end of useable time span covered by ephemerides data.Boolean
isFirst()
Get the flag for the placement of the quaternion QC in the attitude data.boolean
isSpacecraftBodyRate()
Check if rates are specified in spacecraft body frame.boolean
rateFrameIsA()
Check if rates are specified inframe A
.void
setAngvelFrame(FrameFacade angvelFrame)
Set frame in which angular velocities are specified.void
setAttitudeType(AttitudeType type)
Set the format of the data lines in the message.void
setEulerRotSeq(RotationOrder eulerRotSeq)
Set the rotation order for Euler angles.void
setInterpolationDegree(int interpolationDegree)
Set the interpolation degree.void
setInterpolationMethod(String interpolationMethod)
Set the interpolation method to be used.void
setIsFirst(boolean isFirst)
Set the flag for the placement of the quaternion QC in the attitude data.void
setRateFrameIsA(boolean rateFrameIsA)
Set the frame in which rates are specified.void
setStartTime(AbsoluteDate startTime)
Set start of total time span covered by attitude data.void
setStopTime(AbsoluteDate stopTime)
Set end of total time span covered by attitude data.void
setUseableStartTime(AbsoluteDate useableStartTime)
Set start of useable time span covered by attitude data.void
setUseableStopTime(AbsoluteDate useableStopTime)
Set end of useable time span covered by ephemerides data.void
validate(double version)
Check is all mandatory entries have been initialized.-
Methods inherited from class org.orekit.files.ccsds.ndm.adm.AdmMetadata
getCenter, getHasCreatableBody, getLaunchNumber, getLaunchPiece, getLaunchYear, getObjectID, getObjectName, setCenter, setObjectID, setObjectName
-
Methods inherited from class org.orekit.files.ccsds.section.Metadata
getLaunchNumber, getLaunchPiece, getLaunchYear, getTimeSystem, setTimeSystem
-
Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer
acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments, setComments
-
-
-
-
Method Detail
-
validate
public void validate(double version)
Check is all mandatory entries have been initialized.This method should throw an exception if some mandatory entries are missing or not compatible with version number.
- Specified by:
validate
in interfaceSection
- Overrides:
validate
in classAdmMetadata
- Parameters:
version
- format version
-
getEndpoints
public AttitudeEndpoints getEndpoints()
Get the endpoints (i.e. frames A, B and their relationship).- Returns:
- endpoints
-
rateFrameIsA
public boolean rateFrameIsA()
Check if rates are specified inframe A
.- Returns:
- true if rates are specified in
frame A
-
setRateFrameIsA
public void setRateFrameIsA(boolean rateFrameIsA)
Set the frame in which rates are specified.- Parameters:
rateFrameIsA
- if true, rates are specified inframe A
-
setAngvelFrame
public void setAngvelFrame(FrameFacade angvelFrame)
Set frame in which angular velocities are specified.- Parameters:
angvelFrame
- frame in which angular velocities are specified- Since:
- 12.0
-
getFrameAngvelFrame
public FrameFacade getFrameAngvelFrame()
Get frame in which angular velocities are specified.- Returns:
- frame in which angular velocities are specified
- Since:
- 12.0
-
isSpacecraftBodyRate
public boolean isSpacecraftBodyRate()
Check if rates are specified in spacecraft body frame.Mandatory entries
must have been initialized properly to non-null values before this method is called, otherwiseNullPointerException
will be thrown.- Returns:
- true if rates are specified in spacecraft body frame
-
getAttitudeType
public AttitudeType getAttitudeType()
Get the format of the data lines in the message.- Returns:
- the format of the data lines in the message
-
setAttitudeType
public void setAttitudeType(AttitudeType type)
Set the format of the data lines in the message.- Parameters:
type
- format to be set
-
isFirst
public Boolean isFirst()
Get the flag for the placement of the quaternion QC in the attitude data.- Returns:
- true if QC is the first element in the attitude data, false if not initialized
-
setIsFirst
public void setIsFirst(boolean isFirst)
Set the flag for the placement of the quaternion QC in the attitude data.- Parameters:
isFirst
- true if QC is the first element in the attitude data
-
getEulerRotSeq
public RotationOrder getEulerRotSeq()
Get the rotation order of Euler angles.- Returns:
- rotation order
-
setEulerRotSeq
public void setEulerRotSeq(RotationOrder eulerRotSeq)
Set the rotation order for Euler angles.- Parameters:
eulerRotSeq
- order to be set
-
getStartTime
public AbsoluteDate getStartTime()
Get start of total time span covered by attitude data.- Returns:
- the start time
-
setStartTime
public void setStartTime(AbsoluteDate startTime)
Set start of total time span covered by attitude data.- Parameters:
startTime
- the time to be set
-
getStopTime
public AbsoluteDate getStopTime()
Get end of total time span covered by attitude data.- Returns:
- the stop time
-
setStopTime
public void setStopTime(AbsoluteDate stopTime)
Set end of total time span covered by attitude data.- Parameters:
stopTime
- the time to be set
-
getUseableStartTime
public AbsoluteDate getUseableStartTime()
Get start of useable time span covered by attitude data.- Returns:
- the useable start time
-
setUseableStartTime
public void setUseableStartTime(AbsoluteDate useableStartTime)
Set start of useable time span covered by attitude data.- Parameters:
useableStartTime
- the time to be set
-
getUseableStopTime
public AbsoluteDate getUseableStopTime()
Get end of useable time span covered by ephemerides data.- Returns:
- the useable stop time
-
setUseableStopTime
public void setUseableStopTime(AbsoluteDate useableStopTime)
Set end of useable time span covered by ephemerides data.- Parameters:
useableStopTime
- the time to be set
-
getStart
public AbsoluteDate getStart()
Get the start date of this ephemeris segment.- Returns:
- ephemeris segment start date.
-
getStop
public AbsoluteDate getStop()
Get the end date of this ephemeris segment.- Returns:
- ephemeris segment end date.
-
getInterpolationMethod
public String getInterpolationMethod()
Get the interpolation method to be used.- Returns:
- the interpolation method
-
setInterpolationMethod
public void setInterpolationMethod(String interpolationMethod)
Set the interpolation method to be used.- Parameters:
interpolationMethod
- the interpolation method to be set
-
getInterpolationDegree
public int getInterpolationDegree()
Get the interpolation degree.- Returns:
- the interpolation degree
-
setInterpolationDegree
public void setInterpolationDegree(int interpolationDegree)
Set the interpolation degree.- Parameters:
interpolationDegree
- the interpolation degree to be set
-
getInterpolationSamples
public int getInterpolationSamples()
Get the number of samples to use in interpolation.- Returns:
- the number of points to use for interpolation.
-
-