fr.cnes.sirius.patrius.bodies

Class AbstractBodyShape

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractBodyShape

All Implemented Interfaces:

BodyShape, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

AbstractEllipsoidBodyShape, FacetBodyShape

public abstract class AbstractBodyShape
extends Object
implements BodyShape

Abstract class for a body shape to mutualize parameters and features.

Since:

4.12

Author:

Thibaut BONIT

See Also:

BodyShape, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.bodies.BodyShape

BodyShape.MarginType

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_EPSILON_SIGNAL_PROPAGATION Default epsilon (s) for signal propagation computation.
protected double	distanceEpsilon Altitude epsilon below which the altitude coordinate is neglected: below this value,the method BodyShape.getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of BodyShape.getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double).
protected LLHCoordinatesSystem	lLHCoordinatesSystem LLH coordinates system.

Fields inherited from interface fr.cnes.sirius.patrius.bodies.BodyShape

DEFAULT_DISTANCE_EPSILON, DIRECTION_FACTOR

Constructor Summary

Constructors

Constructor and Description
AbstractBodyShape(String name, CelestialBodyFrame bodyFrame) Constructor.

Method Summary

Modifier and Type	Method and Description
CelestialBodyFrame	getBodyFrame() Getter for the body frame related to body shape.
double	getDistanceEpsilon() Return the distance epsilon below which the height coordinate is neglected.
double	getEpsilonSignalPropagation() Getter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method.
LLHCoordinatesSystem	getLLHCoordinatesSystem() Getter for the LLH coordinates system used by the computed BodyPoint.
String	getName() Getter for the name of the shape.
Frame	getNativeFrame(AbsoluteDate date) Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
void	setDistanceEpsilon(double epsilon) Setter for the distance epsilon below which the height coordinate is neglected.
void	setEpsilonSignalPropagation(double epsilon) Setter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method.
void	setLLHCoordinatesSystem(LLHCoordinatesSystem coordSystem) Setter for the LLH coordinates system to be used by the computed BodyPoint.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.bodies.BodyShape

buildPoint, buildPoint, buildPoint, buildRadialPointOnShapeSurface, closestPointTo, closestPointTo, closestPointTo, closestPointTo, closestPointTo, distanceTo, getApparentRadius, getEncompassingSphereRadius, getIntersectionPoint, getIntersectionPoint, getIntersectionPoint, getIntersectionPoints, isDefaultLLHCoordinatesSystem, resize

Field Detail

DEFAULT_EPSILON_SIGNAL_PROPAGATION

public static final double DEFAULT_EPSILON_SIGNAL_PROPAGATION

Default epsilon (s) for signal propagation computation.

See Also:

Constant Field Values

lLHCoordinatesSystem

protected LLHCoordinatesSystem lLHCoordinatesSystem

LLH coordinates system.

distanceEpsilon

protected double distanceEpsilon

Altitude epsilon below which the altitude coordinate is neglected: below this value,the method BodyShape.getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of BodyShape.getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double). This epsilon altitude is also used to assess if a body point is on the shape surface or not (method BodyPoint.isOnShapeSurface().

Constructor Detail

AbstractBodyShape

public AbstractBodyShape(String name,
                         CelestialBodyFrame bodyFrame)

Constructor.

Parameters:

name - body name

bodyFrame - frame in which celestial body coordinates are defined

Method Detail

getName

public final String getName()

Getter for the name of the shape.

Specified by:

getName in interface BodyShape

Returns:

the name of the shape

getBodyFrame

public final CelestialBodyFrame getBodyFrame()

Getter for the body frame related to body shape.

Specified by:

getBodyFrame in interface BodyShape

Returns:

the body frame related to body shape

getPVCoordinates

public PVCoordinates getPVCoordinates(AbsoluteDate date,
                                      Frame frame)
                               throws PatriusException

Get the PVCoordinates of the body in the selected frame.

Specified by:

getPVCoordinates in interface PVCoordinatesProvider

Parameters:

date - current date

frame - the frame where to define the position

Returns:

position/velocity of the body (m and m/s)

Throws:

PatriusException - if position cannot be computed in given frame

getNativeFrame

public Frame getNativeFrame(AbsoluteDate date)

Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.

Specified by:

getNativeFrame in interface PVCoordinatesProvider

Parameters:

date - a date

Returns:

the native frame

getLLHCoordinatesSystem

public final LLHCoordinatesSystem getLLHCoordinatesSystem()

Getter for the LLH coordinates system used by the computed BodyPoint.

Specified by:

getLLHCoordinatesSystem in interface BodyShape

Returns:

the coordinates system

setLLHCoordinatesSystem

public final void setLLHCoordinatesSystem(LLHCoordinatesSystem coordSystem)

Setter for the LLH coordinates system to be used by the computed BodyPoint.

Specified by:

setLLHCoordinatesSystem in interface BodyShape

Parameters:

coordSystem - LLH coordinates system to be set

getDistanceEpsilon

public double getDistanceEpsilon()

Return the distance epsilon below which the height coordinate is neglected. This epsilon value can be modified using dedicated setter.

• Below this distance epsilon, the method BodyShape.getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate) will be automatically used instead of BodyShape.getIntersectionPoint(Line, Vector3D, Frame, AbsoluteDate, double),
• The method BodyPoint.isOnShapeSurface() will return true if the absolute value of its normal height is lower than this distance epsilon.

Specified by:

getDistanceEpsilon in interface BodyShape

Returns:

the altitude epsilon

setDistanceEpsilon

public void setDistanceEpsilon(double epsilon)

Setter for the distance epsilon below which the height coordinate is neglected.

Specified by:

setDistanceEpsilon in interface BodyShape

Parameters:

epsilon - distance epsilon to be set

getEpsilonSignalPropagation

public double getEpsilonSignalPropagation()

Getter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method. This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver).

Specified by:

getEpsilonSignalPropagation in interface BodyShape

Returns:

the epsilon for signal propagation

setEpsilonSignalPropagation

public void setEpsilonSignalPropagation(double epsilon)

Setter for the epsilon for signal propagation used in #getApparentRadius(PVCoordinatesProvider, AbsoluteDate, PVCoordinatesProvider, PropagationDelayType) method. This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver).

Specified by:

setEpsilonSignalPropagation in interface BodyShape

Parameters:

epsilon - epsilon for signal propagation