fr.cnes.sirius.patrius.frames.configuration.precessionnutation

Class CIPCoordinates

java.lang.Object

fr.cnes.sirius.patrius.frames.configuration.precessionnutation.CIPCoordinates

All Implemented Interfaces:

TimeStamped, Serializable

public final class CIPCoordinates
extends Object
implements TimeStamped, Serializable

This class represents a Celestial Intermediate Pole. It contains a date and the CIP coordinates at that date.

Version:

$Id: CIPCoordinates.java 18073 2017-10-02 16:48:07Z bignon $

Author:

Rami Houdroge

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CIPCoordinates	ZERO Zero CIP coordinates.

Constructor Summary

Constructors

Constructor and Description
CIPCoordinates(AbsoluteDate dateIn, double[] cip, double[] cipDV) Constructor for the CIP pole coordinates.
CIPCoordinates(AbsoluteDate dateIn, double xIn, double xPIn, double yIn, double yPIn, double sIn, double sPIn) Constructor for the CIP pole coordinates.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
double[]	getCIPMotion() Get for the CIP motion.
double[]	getCIPMotionTimeDerivatives() Getter for the CIP motion time derivatives.
AbsoluteDate	getDate() Get the date.
double	getS() Getter for the s-coordinate of pole.
double	getsP() Getter for the s-coordinate derivative of pole.
double	getX() Getter for the x-coordinate of pole.
double	getxP() Getter for the x-coordinate derivative of pole.
double	getY() Getter for the y-coordinate of pole.
double	getyP() Getter for the y-coordinate derivative of pole.
int	hashCode()
boolean	isCIPMotionTimeDerivativesZero() Indicate if the coordinates derivatives of pole are zero.
boolean	isCIPMotionZero() Indicate if the coordinates of pole are zero.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final CIPCoordinates ZERO

Zero CIP coordinates.

Constructor Detail

CIPCoordinates

public CIPCoordinates(AbsoluteDate dateIn,
                      double xIn,
                      double xPIn,
                      double yIn,
                      double yPIn,
                      double sIn,
                      double sPIn)

Constructor for the CIP pole coordinates.

Parameters:

dateIn - date

xIn - x-coordinate of pole

xPIn - x-coordinate derivative of pole

yIn - y-coordinate of pole

yPIn - y-coordinate derivative of pole

sIn - s-coordinate of pole

sPIn - s-coordinate derivative of pole

CIPCoordinates

public CIPCoordinates(AbsoluteDate dateIn,
                      double[] cip,
                      double[] cipDV)

Constructor for the CIP pole coordinates.

Parameters:

dateIn - date

cip - coordinates of pole

cipDV - coordinate derivatives of pole

Method Detail

getDate

public AbsoluteDate getDate()

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

isCIPMotionZero

public boolean isCIPMotionZero()

Indicate if the coordinates of pole are zero.

Returns:

true if the coordinates of pole are zero

isCIPMotionTimeDerivativesZero

public boolean isCIPMotionTimeDerivativesZero()

Indicate if the coordinates derivatives of pole are zero.

Returns:

true if the coordinates derivatives of pole are zero

getCIPMotion

public double[] getCIPMotion()

Get for the CIP motion.

Returns:

the CIP motion as an array

getCIPMotionTimeDerivatives

public double[] getCIPMotionTimeDerivatives()

Getter for the CIP motion time derivatives.

Returns:

the CIP motion time derivatives as an array

getX

public double getX()

Getter for the x-coordinate of pole.

Returns:

the x-coordinate of pole

getxP

public double getxP()

Getter for the x-coordinate derivative of pole.

Returns:

the x-coordinate derivative of pole

getY

public double getY()

Getter for the y-coordinate of pole.

Returns:

the y-coordinate of pole

getyP

public double getyP()

Getter for the y-coordinate derivative of pole.

Returns:

the y-coordinate derivative of pole

getS

public double getS()

Getter for the s-coordinate of pole.

Returns:

the s-coordinate of pole

getsP

public double getsP()

Getter for the s-coordinate derivative of pole.

Returns:

the s-coordinate derivative of pole

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object