Class FrameFacade


  • public class FrameFacade
    extends Object
    Facade in front of several frames types in CCSDS messages.
    Since:
    11.0
    Author:
    Luc Maisonobe, Vincent Cucchietti
    • Constructor Detail

      • FrameFacade

        public FrameFacade​(Frame frame,
                           CelestialBodyFrame celestialBodyFrame,
                           OrbitRelativeFrame orbitRelativeFrame,
                           SpacecraftBodyFrame spacecraftBodyFrame,
                           String name)
        Simple constructor.

        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.

        Parameters:
        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 frame
    • Method Detail

      • asFrame

        public Frame asFrame()
        Get the associated frame tree node.
        Returns:
        associated frame tree node, or null if none exists
      • getName

        public String getName()
        Get the CCSDS name for the frame.
        Returns:
        CCSDS name
      • map

        public static FrameFacade map​(Frame frame)
        Map an Orekit frame to a CCSDS frame facade.
        Parameters:
        frame - a reference frame.
        Returns:
        the CCSDS frame corresponding to the Orekit frame
      • parse

        public static FrameFacade parse​(String name,
                                        IERSConventions conventions,
                                        boolean simpleEOP,
                                        DataContext dataContext,
                                        boolean allowCelestial,
                                        boolean allowOrbit,
                                        boolean allowSpacecraft)
        Simple constructor.
        Parameters:
        name - name of the frame
        conventions - IERS conventions to use
        simpleEOP - if true, tidal effects are ignored when interpolating EOP
        dataContext - to use when creating the frame
        allowCelestial - if true, CelestialBodyFrame are allowed
        allowOrbit - if true, OrbitRelativeFrame are allowed
        allowSpacecraft - if true, SpacecraftBodyFrame are allowed
        Returns:
        frame facade corresponding to the CCSDS name