1   /* Copyright 2002-2016 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (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.bodies;
18  
19  import java.io.Serializable;
20  
21  import org.orekit.errors.OrekitException;
22  import org.orekit.frames.Frame;
23  import org.orekit.utils.PVCoordinatesProvider;
24  
25  /** Interface for celestial bodies like Sun, Moon or solar system planets.
26   * @author Luc Maisonobe
27   * @see CelestialBodyFactory
28   */
29  public interface CelestialBody extends Serializable, PVCoordinatesProvider {
30  
31      /** Get an inertially oriented, body centered frame.
32       * <p>The frame is always bound to the body center, and its axes have a
33       * fixed orientation with respect to other inertial frames.</p>
34       * @return an inertially oriented, body centered frame
35       * @exception OrekitException if frame cannot be retrieved
36       * @see #getBodyOrientedFrame()
37       */
38      Frame getInertiallyOrientedFrame() throws OrekitException;
39  
40      /** Get a body oriented, body centered frame.
41       * <p>The frame is always bound to the body center, and its axes have a
42       * fixed orientation with respect to the celestial body.</p>
43       * @return a body oriented, body centered frame
44       * @exception OrekitException if frame cannot be retrieved
45       * @see #getInertiallyOrientedFrame()
46       */
47      Frame getBodyOrientedFrame() throws OrekitException;
48  
49      /** Get the name of the body.
50       * @return name of the body
51       */
52      String getName();
53  
54      /** Get the attraction coefficient of the body.
55       * @return attraction coefficient of the body (m³/s²)
56       */
57      double getGM();
58  
59  }