BodyFacade.java

  1. /* Copyright 2002-2022 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.files.ccsds.definitions;

  18. import org.orekit.annotation.DefaultDataContext;
  19. import org.orekit.bodies.CelestialBody;
  20. import org.orekit.data.DataContext;

  21. /** Facade in front of several center bodies in CCSDS messages.
  22.  * @author Luc Maisonobe
  23.  * @since 11.0
  24.  */
  25. public class BodyFacade {

  26.     /** Name of the center. */
  27.     private final String name;

  28.     /** Celestial body (may be null). */
  29.     private final CelestialBody body;

  30.     /** Simple constructor.
  31.      * @param name name of the frame
  32.      * @param body celestial body (may be null)
  33.      */
  34.     public BodyFacade(final String name, final CelestialBody body) {
  35.         this.name = name;
  36.         this.body = body;
  37.     }

  38.     /** Get the CCSDS name for the body.
  39.      * @return CCSDS name
  40.      */
  41.     public String getName() {
  42.         return name;
  43.     }

  44.     /** Get the celestial body.
  45.      * @return celestial body (may be null)
  46.      */
  47.     public CelestialBody getBody() {
  48.         return body;
  49.     }

  50.     /**
  51.      * Create a body facade from an input center name.
  52.      *
  53.      * <p>This method uses the {@link DataContext#getDefault() default data context}.
  54.      *
  55.      * @param centerName input center name
  56.      * @return a body facade corresponding to the input center name
  57.      * @since 11.2
  58.      */
  59.     @DefaultDataContext
  60.     public static BodyFacade create(final CenterName centerName) {
  61.         return new BodyFacade(centerName.name(), centerName.getCelestialBody());
  62.     }

  63. }