org.orekit.utils

Enum CartesianDerivativesFilter

java.lang.Object

java.lang.Enum<CartesianDerivativesFilter>

org.orekit.utils.CartesianDerivativesFilter

All Implemented Interfaces:

Serializable, Comparable<CartesianDerivativesFilter>

public enum CartesianDerivativesFilter
extends Enum<CartesianDerivativesFilter>

Enumerate for selecting which derivatives to use in TimeStampedPVCoordinates and TimeStampedFieldPVCoordinates interpolation.

Since:

7.0

Author:

Luc Maisonobe

See Also:

TimeStampedPVCoordinates.interpolate(org.orekit.time.AbsoluteDate, CartesianDerivativesFilter, java.util.Collection), TimeStampedFieldPVCoordinates.interpolate(org.orekit.time.FieldAbsoluteDate, CartesianDerivativesFilter, java.util.Collection), AngularDerivativesFilter

Enum Constant Summary

Enum Constants

Enum Constant and Description
USE_P Use only positions, ignoring velocities.
USE_PV Use positions and velocities.
USE_PVA Use positions, velocities and accelerations.

Method Summary

Modifier and Type	Method and Description
static CartesianDerivativesFilter	getFilter(int order) Get the filter corresponding to a maximum derivation order.
int	getMaxOrder() Get the maximum derivation order.
static CartesianDerivativesFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static CartesianDerivativesFilter[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USE_P

public static final CartesianDerivativesFilter USE_P

Use only positions, ignoring velocities.

USE_PV

public static final CartesianDerivativesFilter USE_PV

Use positions and velocities.

USE_PVA

public static final CartesianDerivativesFilter USE_PVA

Use positions, velocities and accelerations.

Method Detail

values

public static CartesianDerivativesFilter[] 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 (CartesianDerivativesFilter c : CartesianDerivativesFilter.values())
    System.out.println(c);

Returns:

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

valueOf

public static CartesianDerivativesFilter 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

getMaxOrder

public int getMaxOrder()

Get the maximum derivation order.

Returns:

maximum derivation order

getFilter

public static CartesianDerivativesFilter getFilter(int order)
                                            throws IllegalArgumentException

Get the filter corresponding to a maximum derivation order.

Parameters:

order - maximum derivation order

Returns:

the filter corresponding to derivation order

Throws:

IllegalArgumentException - if the order is out of range