org.orekit.files.ccsds.ndm.adm.apm

Class ApmQuaternion

java.lang.Object

org.orekit.files.ccsds.ndm.adm.apm.ApmQuaternion

All Implemented Interfaces:

Section

public class ApmQuaternion
extends Object
implements Section

Container for Attitude Parameter Message quaternion logical block.

Since:

10.2

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
ApmQuaternion() Simple constructor.

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(Frame frame, PVCoordinatesProvider pvProvider) Get the attitude.
AttitudeEndoints	getEndpoints() Get the endpoints (i.e.
AbsoluteDate	getEpoch() Get the epoch of the data.
Quaternion	getQuaternion() Get the quaternion.
Quaternion	getQuaternionDot() Get the quaternion derivative.
boolean	hasRates() Check if the logical block includes rates.
void	setEpoch(AbsoluteDate epoch) Set the epoch of the data.
void	setQ(int index, double value) Set quaternion component.
void	setQDot(int index, double derivative) Set quaternion derivative component.
void	validate(double version) Check is all mandatory entries have been initialized.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApmQuaternion

public ApmQuaternion()

Simple constructor.

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 interface Section

Parameters:

version - format version

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

getEndpoints

public AttitudeEndoints getEndpoints()

Get the endpoints (i.e. frames A, B and their relationship).

Returns:

endpoints

getQuaternion

public Quaternion getQuaternion()

Get the quaternion.

Returns:

quaternion

setQ

public void setQ(int index,
                 double value)

Set quaternion component.

Parameters:

index - component index (0 is scalar part)

value - quaternion component

getQuaternionDot

public Quaternion getQuaternionDot()

Get the quaternion derivative.

Returns:

quaternion derivative

setQDot

public void setQDot(int index,
                    double derivative)

Set quaternion derivative component.

Parameters:

index - component index (0 is scalar part)

derivative - quaternion derivative component

hasRates

public boolean hasRates()

Check if the logical block includes rates.

Returns:

true if logical block includes rates

getAttitude

public Attitude getAttitude(Frame frame,
                            PVCoordinatesProvider pvProvider)

Get the attitude.

Parameters:

frame - reference frame with respect to which attitude must be defined (may be null if attitude is not orbit-relative and one wants attitude in the same frame as used in the attitude message)

pvProvider - provider for spacecraft position and velocity (may be null if attitude is not orbit-relative)

Returns:

attitude