1   /* Copyright 2002-2025 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.frames;
18  
19  
20  /** Base class for the predefined frames that are managed by {@link Frames}.
21   * @author Luc Maisonobe
22   */
23  public class FactoryManagedFrame extends Frame {
24  
25      /** Key of the frame within the factory. */
26      private final Predefined factoryKey;
27  
28      /** Simple constructor.
29       * @param parent parent frame (must be non-null)
30       * @param transformProvider provider for transform from parent frame to instance
31       * @param pseudoInertial true if frame is considered pseudo-inertial
32       * (i.e. suitable for propagating orbit)
33       * @param factoryKey key of the frame within the factory
34       */
35      public FactoryManagedFrame(final Frame parent, final TransformProvider transformProvider,
36                                 final boolean pseudoInertial, final Predefined factoryKey) {
37          super(parent, transformProvider, factoryKey.getName(), pseudoInertial);
38          this.factoryKey = factoryKey;
39      }
40  
41      /** Get the key of the frame within the factory.
42       * @return key of the frame within the factory
43       */
44      public Predefined getFactoryKey() {
45          return factoryKey;
46      }
47  
48  }