public class FrameFacade extends Object
Constructor and Description |
---|
FrameFacade(Frame frame,
CelestialBodyFrame celestialBodyFrame,
OrbitRelativeFrame orbitRelativeFrame,
SpacecraftBodyFrame spacecraftBodyFrame,
String name)
Simple constructor.
|
Modifier and Type | Method and Description |
---|---|
CelestialBodyFrame |
asCelestialBodyFrame()
Get the associated
celestial body frame . |
Frame |
asFrame()
Get the associated frame tree node.
|
OrbitRelativeFrame |
asOrbitRelativeFrame()
Get the associated
orbit relative frame . |
SpacecraftBodyFrame |
asSpacecraftBodyFrame()
Get the associated
spacecraft body frame . |
String |
getName()
Get the CCSDS name for the frame.
|
static Transform |
getTransform(FrameFacade frameIn,
FrameFacade frameOut,
Frame inertialPivotFrame,
AbsoluteDate date,
PVCoordinatesProvider pv)
Get the transform between
CCSDS frames . |
static FrameFacade |
map(Frame frame)
Map an Orekit frame to a CCSDS frame facade.
|
static FrameFacade |
parse(String name,
IERSConventions conventions,
boolean simpleEOP,
DataContext dataContext,
boolean allowCelestial,
boolean allowOrbit,
boolean allowSpacecraft)
Simple constructor.
|
public FrameFacade(Frame frame, CelestialBodyFrame celestialBodyFrame, OrbitRelativeFrame orbitRelativeFrame, SpacecraftBodyFrame spacecraftBodyFrame, String name)
At most one of celestialBodyFrame
, orbitRelativeFrame
or spacecraftBodyFrame
may be non
null. They may all be null if frame is unknown, in which case only the name will be available.
frame
- reference to node in Orekit frames tree (may be null)celestialBodyFrame
- reference to celestial body centered frame (may be null)orbitRelativeFrame
- reference to orbit-relative frame (may be null)spacecraftBodyFrame
- reference to spacecraft body frame (may be null)name
- name of the framepublic Frame asFrame()
public CelestialBodyFrame asCelestialBodyFrame()
celestial body frame
.orbit
, a spacecraft
or is not supportedpublic OrbitRelativeFrame asOrbitRelativeFrame()
orbit relative frame
.celestial body
, a spacecraft
or is not supportedpublic SpacecraftBodyFrame asSpacecraftBodyFrame()
spacecraft body frame
.celestial body
, an orbit
or is not supportedpublic String getName()
public static FrameFacade map(Frame frame)
frame
- a reference frame.public static FrameFacade parse(String name, IERSConventions conventions, boolean simpleEOP, DataContext dataContext, boolean allowCelestial, boolean allowOrbit, boolean allowSpacecraft)
name
- name of the frameconventions
- IERS conventions to usesimpleEOP
- if true, tidal effects are ignored when interpolating EOPdataContext
- to use when creating the frameallowCelestial
- if true, CelestialBodyFrame
are allowedallowOrbit
- if true, OrbitRelativeFrame
are allowedallowSpacecraft
- if true, SpacecraftBodyFrame
are allowedpublic static Transform getTransform(FrameFacade frameIn, FrameFacade frameOut, Frame inertialPivotFrame, AbsoluteDate date, PVCoordinatesProvider pv)
CCSDS frames
.
In case both input and output frames are orbit relative frame
, the returned transform
will only be composed of a rotation
. Only commonly used orbit relative frames
will be recognized.
Note that if the input/output CCSDS frame
is defined using a :
Note that the pivot frame provided must be inertial and consistent to what you are working with (i.e GCRF if around Earth for example).
frameIn
- the input CCSDS frame
to convert fromframeOut
- the output CCSDS frame
to convert toinertialPivotFrame
- inertial frame used as a pivot to create the transformdate
- the date for the transformpv
- the position and velocity coordinates provider (required in case one of the frames is an
orbit relative frame
)CCSDS frames
.Copyright © 2002-2022 CS GROUP. All rights reserved.