PowerTerm.java

  1. /* Copyright 2002-2024 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.utils.units;

  18. import org.hipparchus.fraction.Fraction;

  19. /** A container for a term with associated power.
  20.  * @author Luc Maisonobe
  21.  * @since 11.0
  22.  */
  23. public class PowerTerm {

  24.     /** Scaling factor. */
  25.     private final double scale;

  26.     /** Base term. */
  27.     private final CharSequence base;

  28.     /** Fractional exponent. */
  29.     private final Fraction exponent;

  30.     /** Simple constructor.
  31.      * @param scale scaling factor
  32.      * @param base base term
  33.      * @param exponent fractional exponent
  34.      */
  35.     PowerTerm(final double scale, final CharSequence base, final Fraction exponent) {
  36.         this.scale    = scale;
  37.         this.base     = base;
  38.         this.exponent = exponent;
  39.     }

  40.     /** Get the scaling factor.
  41.      * @return scaling factor
  42.      */
  43.     public double getScale() {
  44.         return scale;
  45.     }

  46.     /** Get the base term.
  47.      * @return base term
  48.      */
  49.     public CharSequence getBase() {
  50.         return base;
  51.     }

  52.     /** Get the fractional exponent.
  53.      * @return fractional exponent
  54.      */
  55.     public Fraction getExponent() {
  56.         return exponent;
  57.     }

  58. }