fr.cnes.sirius.patrius.utils

Enum AngularDerivativesFilter

java.lang.Object

java.lang.Enum<AngularDerivativesFilter>

fr.cnes.sirius.patrius.utils.AngularDerivativesFilter

All Implemented Interfaces:

Serializable, Comparable<AngularDerivativesFilter>

public enum AngularDerivativesFilter
extends Enum<AngularDerivativesFilter>

Enumerate for selecting which derivatives to use in TimeStampedAngularCoordinates interpolation.

Since:

3.1

Author:

Luc Maisonobe

See Also:

CartesianDerivativesFilter

Enum Constant Summary

Enum Constants

Enum Constant and Description
USE_R Use only rotations, ignoring rotation rates.
USE_RR Use rotations and rotation rates.
USE_RRA Use rotations, rotation rates and acceleration.

Method Summary

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

public static final AngularDerivativesFilter USE_R

Use only rotations, ignoring rotation rates.

USE_RR

public static final AngularDerivativesFilter USE_RR

Use rotations and rotation rates.

USE_RRA

public static final AngularDerivativesFilter USE_RRA

Use rotations, rotation rates and acceleration.

Method Detail

values

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

Returns:

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

valueOf

public static AngularDerivativesFilter 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 AngularDerivativesFilter getFilter(int order)

Get the filter corresponding to a maximum derivation order.

Parameters:

order - maximum derivation order

Returns:

the month corresponding to the string

Throws:

IllegalArgumentException - if the order is out of range