org.orekit.files.ccsds

Class AEMFile.AttitudeEphemeridesBlock

java.lang.Object

org.orekit.files.ccsds.AEMFile.AttitudeEphemeridesBlock

Enclosing class:

AEMFile

public class AEMFile.AttitudeEphemeridesBlock
extends Object

The Attitude Ephemerides Blocks class contain metadata and the list of attitude data lines.

Constructor Summary

Constructors

Constructor and Description
AttitudeEphemeridesBlock() Constructor.

Method Summary

Modifier and Type	Method and Description
List<TimeStampedAngularCoordinates>	getAngularCoordinates() Get an unmodifiable list of attitude data lines.
List<TimeStampedAngularCoordinates>	getAttitudeDataLines() Get the list of attitude data lines.
List<String>	getAttitudeDataLinesComment() Get the attitude data lines comment.
String	getAttitudeDirection() Get the rotation direction of the attitude.
String	getAttitudeType() Get the format of the data lines in the message.
String	getEulerRotSeq() Get the rotation sequence of the Euler angles (e.g., 312, where X=1, Y=2, Z=3).
String	getFrameCenterString() Get the name of the center of the coordinate system the ephemeris is provided in.
int	getInterpolationDegree() Get the interpolation degree.
String	getInterpolationMethod() Get the interpolation method to be used.
ADMMetaData	getMetaData() Get the meta-data for the block.
String	getRateFrameString() Get the rate frame specifier as it appeared in the file.
String	getRefFrameAString() Get the reference frame A specifier as it appeared in the file.
String	getRefFrameBString() Get the reference frame B specifier as it appeared in the file.
RotationOrder	getRotationOrder() Get the rotation order for Euler angles.
AbsoluteDate	getStart() Get the start date of this attitude data segment.
AbsoluteDate	getStartTime() Get start of total time span covered by attitude data.
AbsoluteDate	getStop() Get the end date of this attitude data segment.
AbsoluteDate	getStopTime() Get end of total time span covered by attitude data.
TimeScale	getTimeScale() Get the time scale for this data segment.
String	getTimeScaleString() Get the time scale for this data segment.
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.
void	setAttitudeDataLinesComment(List<String> ephemeridesDataLinesComment) Set the attitude data lines comment.
void	setAttitudeDirection(String direction) Set the rotation direction of the attitude.
void	setAttitudeType(String type) Set the format of the data lines in the message.
void	setEulerRotSeq(String eulerRotSeq) Set the rotation sequence of the Euler angles (e.g., 312, where X=1, Y=2, Z=3).
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	setRateFrameString(String frame) Set the rate frame name.
void	setRefFrameAString(String frame) Set the reference frame A name.
void	setRefFrameBString(String frame) Set the reference frame B name.
void	setRotationOrder(RotationOrder order) Set the rotation order for Euler angles.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttitudeEphemeridesBlock

public AttitudeEphemeridesBlock()

Constructor.

Method Detail

getAttitudeDataLines

public List<TimeStampedAngularCoordinates> getAttitudeDataLines()

Get the list of attitude data lines.

Returns:

a list of data

getAngularCoordinates

public List<TimeStampedAngularCoordinates> getAngularCoordinates()

Get an unmodifiable list of attitude data lines.

Returns:

a list of attitude data

getMetaData

public ADMMetaData getMetaData()

Get the meta-data for the block.

Returns:

meta-data for the block

getFrameCenterString

public String getFrameCenterString()

Get the name of the center of the coordinate system the ephemeris is provided in. This may be a natural origin, such as the center of the Earth, another satellite, etc.

Returns:

the name of the frame center

getRefFrameAString

public String getRefFrameAString()

Get the reference frame A specifier as it appeared in the file.

Returns:

the frame name as it appeared in the file (A).

setRefFrameAString

public void setRefFrameAString(String frame)

Set the reference frame A name.

Parameters:

frame - specifier as it appeared in the file.

getRefFrameBString

public String getRefFrameBString()

Get the reference frame B specifier as it appeared in the file.

Returns:

the frame name as it appeared in the file (B).

setRefFrameBString

public void setRefFrameBString(String frame)

Set the reference frame B name.

Parameters:

frame - specifier as it appeared in the file.

getRateFrameString

public String getRateFrameString()

Get the rate frame specifier as it appeared in the file.

Returns:

the rate frame name.

setRateFrameString

public void setRateFrameString(String frame)

Set the rate frame name.

Parameters:

frame - specifier as it appeared in the file.

getAttitudeDirection

public String getAttitudeDirection()

Get the rotation direction of the attitude.

Returns:

the rotation direction of the attitude

setAttitudeDirection

public void setAttitudeDirection(String direction)

Set the rotation direction of the attitude.

Parameters:

direction - rotation direction to be set

getAttitudeType

public String 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(String 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

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 String getEulerRotSeq()

Get the rotation sequence of the Euler angles (e.g., 312, where X=1, Y=2, Z=3).

Returns:

the rotation sequence of the Euler angles

setEulerRotSeq

public void setEulerRotSeq(String eulerRotSeq)

Set the rotation sequence of the Euler angles (e.g., 312, where X=1, Y=2, Z=3).

Parameters:

eulerRotSeq - rotation sequence to be set

getTimeScaleString

public String getTimeScaleString()

Get the time scale for this data segment.

Returns:

the time scale identifier, as specified in the file, or null if the data file does not specify a time scale.

getTimeScale

public TimeScale getTimeScale()

Get the time scale for this data segment.

Returns:

the time scale for this data. Never null.

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 attitude data segment.

Returns:

attitude data segment start date.

getStop

public AbsoluteDate getStop()

Get the end date of this attitude data segment.

Returns:

attitude data 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

getAttitudeDataLinesComment

public List<String> getAttitudeDataLinesComment()

Get the attitude data lines comment.

Returns:

the comment

setAttitudeDataLinesComment

public void setAttitudeDataLinesComment(List<String> ephemeridesDataLinesComment)

Set the attitude data lines comment.

Parameters:

ephemeridesDataLinesComment - the comment to be set

getRotationOrder

public RotationOrder getRotationOrder()

Get the rotation order for Euler angles.

Returns:

rotation order

setRotationOrder

public void setRotationOrder(RotationOrder order)

Set the rotation order for Euler angles.

Parameters:

order - the rotation order to be set