1 /* Copyright 2002-2026 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
19 import java.util.Optional;
20
21 import org.orekit.annotation.DefaultDataContext;
22 import org.orekit.annotation.Nullable;
23 import org.orekit.bodies.CelestialBodies;
24 import org.orekit.bodies.CelestialBody;
25 import org.orekit.data.DataContext;
26
27 /** Facade in front of several center bodies in CCSDS messages.
28 * @author Luc Maisonobe
29 * @since 11.0
30 */
31 public class BodyFacade {
32
33 /** Name of the center. */
34 private final String name;
35
36 /** Celestial body (may be null). */
37 @Nullable
38 private final CelestialBody body;
39
40 /** Simple constructor.
41 * @param name name of the frame
42 * @param body celestial body (may be null)
43 */
44 public BodyFacade(final String name, final CelestialBody body) {
45 this.name = name;
46 this.body = body;
47 }
48
49 /** Get the CCSDS name for the body.
50 * @return CCSDS name
51 */
52 public String getName() {
53 return name;
54 }
55
56 /** Get the celestial body.
57 * @return celestial body (can be empty)
58 */
59 public Optional<CelestialBody> getBody() {
60 return Optional.ofNullable(body);
61 }
62
63 /**
64 * Create a body facade from an input center name.
65 *
66 * <p>This method uses the {@link DataContext#getDefault() default data context}.
67 *
68 * @param centerName input center name
69 * @return a body facade corresponding to the input center name
70 * @since 11.2
71 */
72 @DefaultDataContext
73 public static BodyFacade create(final CenterName centerName) {
74 return create(centerName, DataContext.getDefault());
75 }
76
77 /**
78 * Create a body facade from an input center name.
79 *
80 * @param centerName input center name
81 * @param context data context
82 * @return a body facade corresponding to the input center name
83 * @since 12.0
84 */
85 public static BodyFacade create(final CenterName centerName, final DataContext context) {
86 return create(centerName, context.getCelestialBodies());
87 }
88
89 /**
90 * Create a body facade from an input center name.
91 *
92 * @param centerName input center name
93 * @param bodies celestial bodies
94 * @return a body facade corresponding to the input center name
95 * @since 12.0
96 */
97 public static BodyFacade create(final CenterName centerName, final CelestialBodies bodies) {
98 return new BodyFacade(centerName.name(), centerName.getCelestialBody(bodies));
99 }
100
101 }