Package org.orekit.files.ccsds.ndm.adm

Enum AttitudeType

java.lang.Object

java.lang.Enum<AttitudeType>

org.orekit.files.ccsds.ndm.adm.AttitudeType

All Implemented Interfaces:

Serializable, Comparable<AttitudeType>

public enum AttitudeType
extends Enum<AttitudeType>

Enumerate for ADM attitude type.

Since:

10.2

Author:

Bryan Cazabonne

Enum Constant Summary

Enum Constants

Enum Constant	Description
EULER_ANGLE	Euler angles.
EULER_ANGLE_ANGVEL	Euler angles and angular velocity.
EULER_ANGLE_DERIVATIVE	Euler angles and rotation rate.
QUATERNION	Quaternion.
QUATERNION_ANGVEL	Quaternion and angular velocity.
QUATERNION_DERIVATIVE	Quaternion and derivatives.
QUATERNION_EULER_RATES	Quaternion and Euler angles rates (only in ADM V1).
SPIN	Spin.
SPIN_NUTATION	Spin and nutation.
SPIN_NUTATION_MOMENTUM	Spin and momentum.

Method Summary

Modifier and Type	Method	Description
abstract TimeStampedAngularCoordinates	build(boolean isFirst, boolean isExternal2SpacecraftBody, RotationOrder eulerRotSequence, boolean isSpacecraftBodyRate, AbsoluteDate date, double... components)	Get the angular coordinates corresponding to the attitude data.
String[]	createDataFields(boolean isFirst, boolean isExternal2SpacecraftBody, RotationOrder eulerRotSequence, boolean isSpacecraftBodyRate, TimeStampedAngularCoordinates attitude)	Get the attitude data fields corresponding to the attitude type.
abstract double[]	generateData(boolean isFirst, boolean isExternal2SpacecraftBody, RotationOrder eulerRotSequence, boolean isSpacecraftBodyRate, TimeStampedAngularCoordinates attitude)	Generate the attitude data corresponding to the attitude type.
AngularDerivativesFilter	getAngularDerivativesFilter()	Get the angular derivative filter corresponding to the attitude data.
String	getName(double formatVersion)	Get the type name for a given format version.
TimeStampedAngularCoordinates	parse(boolean isFirst, boolean isExternal2SpacecraftBody, RotationOrder eulerRotSequence, boolean isSpacecraftBodyRate, ContextBinding context, String[] fields)	Get the angular coordinates corresponding to the attitude data.
static AttitudeType	parseType(String typeSpecification)	Parse an attitude type.
String	toString()
static AttitudeType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttitudeType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

QUATERNION

public static final AttitudeType QUATERNION

Quaternion.

QUATERNION_DERIVATIVE

public static final AttitudeType QUATERNION_DERIVATIVE

Quaternion and derivatives.

QUATERNION_EULER_RATES

public static final AttitudeType QUATERNION_EULER_RATES

Quaternion and Euler angles rates (only in ADM V1).

QUATERNION_ANGVEL

public static final AttitudeType QUATERNION_ANGVEL

Quaternion and angular velocity.

EULER_ANGLE

public static final AttitudeType EULER_ANGLE

Euler angles.

EULER_ANGLE_DERIVATIVE

public static final AttitudeType EULER_ANGLE_DERIVATIVE

Euler angles and rotation rate.

EULER_ANGLE_ANGVEL

public static final AttitudeType EULER_ANGLE_ANGVEL

Euler angles and angular velocity.

Since:

12.0

SPIN

public static final AttitudeType SPIN

Spin.

SPIN_NUTATION

public static final AttitudeType SPIN_NUTATION

Spin and nutation.

SPIN_NUTATION_MOMENTUM

public static final AttitudeType SPIN_NUTATION_MOMENTUM

Spin and momentum.

Since:

12.0

Method Detail

values

public static AttitudeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AttitudeType c : AttitudeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AttitudeType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName(double formatVersion)

Get the type name for a given format version.

Parameters:

formatVersion - format version

Returns:

type name

Since:

12.0

toString

public String toString()

Overrides:

toString in class Enum<AttitudeType>

parseType

public static AttitudeType parseType(String typeSpecification)

Parse an attitude type.

Parameters:

typeSpecification - unnormalized type name

Returns:

parsed type

createDataFields

public String[] createDataFields(boolean isFirst,
                                 boolean isExternal2SpacecraftBody,
                                 RotationOrder eulerRotSequence,
                                 boolean isSpacecraftBodyRate,
                                 TimeStampedAngularCoordinates attitude)

Get the attitude data fields corresponding to the attitude type.

This method returns the components in CCSDS units (i.e. degrees, degrees per seconds…).

Parameters:

isFirst - if true the first quaternion component is the scalar component

isExternal2SpacecraftBody - true attitude is from external frame to spacecraft body frame

eulerRotSequence - sequance of Euler angles

isSpacecraftBodyRate - if true Euler rates are specified in spacecraft body frame

attitude - angular coordinates, using Attitude convention (i.e. from inertial frame to spacecraft frame)

Returns:

the attitude data in CCSDS units

generateData

public abstract double[] generateData(boolean isFirst,
                                      boolean isExternal2SpacecraftBody,
                                      RotationOrder eulerRotSequence,
                                      boolean isSpacecraftBodyRate,
                                      TimeStampedAngularCoordinates attitude)

Generate the attitude data corresponding to the attitude type.

This method returns the components in SI units.

Parameters:

isFirst - if true the first quaternion component is the scalar component

isExternal2SpacecraftBody - true attitude is from external frame to spacecraft body frame

eulerRotSequence - sequance of Euler angles

isSpacecraftBodyRate - if true Euler rates are specified in spacecraft body frame

attitude - angular coordinates, using Attitude convention (i.e. from inertial frame to spacecraft frame)

Returns:

the attitude data in CCSDS units

Since:

12.0

parse

public TimeStampedAngularCoordinates parse(boolean isFirst,
                                           boolean isExternal2SpacecraftBody,
                                           RotationOrder eulerRotSequence,
                                           boolean isSpacecraftBodyRate,
                                           ContextBinding context,
                                           String[] fields)

Get the angular coordinates corresponding to the attitude data.

This method assumes the text fields are in CCSDS units and will convert to SI units.

Parameters:

isFirst - if true the first quaternion component is the scalar component

isExternal2SpacecraftBody - true attitude is from external frame to spacecraft body frame

eulerRotSequence - sequance of Euler angles

isSpacecraftBodyRate - if true Euler rates are specified in spacecraft body frame

context - context binding

fields - raw data fields

Returns:

the angular coordinates, using Attitude convention (i.e. from inertial frame to spacecraft frame)

build

public abstract TimeStampedAngularCoordinates build(boolean isFirst,
                                                    boolean isExternal2SpacecraftBody,
                                                    RotationOrder eulerRotSequence,
                                                    boolean isSpacecraftBodyRate,
                                                    AbsoluteDate date,
                                                    double... components)

Get the angular coordinates corresponding to the attitude data.

Parameters:

isFirst - if true the first quaternion component is the scalar component

isExternal2SpacecraftBody - true attitude is from external frame to spacecraft body frame

eulerRotSequence - sequance of Euler angles

isSpacecraftBodyRate - if true Euler rates are specified in spacecraft body frame

date - entry date

components - entry components with SI units, semantic depends on attitude type

Returns:

the angular coordinates, using Attitude convention (i.e. from inertial frame to spacecraft frame)

getAngularDerivativesFilter

public AngularDerivativesFilter getAngularDerivativesFilter()

Get the angular derivative filter corresponding to the attitude data.

Returns:

the angular derivative filter corresponding to the attitude data