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.files.ccsds.ndm.cdm;
18  
19  import org.orekit.files.ccsds.section.CommentsContainer;
20  
21  /**
22   * Container for the additional covariance metadata (optional).
23   */
24  public class AdditionalCovarianceMetadata extends CommentsContainer {
25  
26      /** The atmospheric density forecast error. */
27      private double densityForecastUncertainty;
28  
29      /** The minimum suggested covariance scale factor. */
30      private double cScaleFactorMin;
31  
32      /** The (median) suggested covariance scale factor. */
33      private double cScaleFactor;
34  
35      /** The maximum suggested covariance scale factor. */
36      private double cScaleFactorMax;
37  
38      /** The source (or origin) of the specific orbital data for this object. */
39      private String screeningDataSource;
40  
41      /** The drag consider parameter (DCP) sensitivity vectors map forward expected error in the drag acceleration to actual
42       * componentized position errors at TCA. */
43      private double[] dcpSensitivityVectorPosition;
44  
45      /** The drag consider parameter (DCP) sensitivity vectors map forward expected error in the drag acceleration to actual
46       * componentized velocity errors at TCA. */
47      private double[] dcpSensitivityVectorVelocity;
48  
49  
50      /** Simple constructor. */
51      public AdditionalCovarianceMetadata() {
52          densityForecastUncertainty = Double.NaN;
53      }
54  
55      /** {@inheritDoc} */
56      @Override
57      public void validate(final double version) {
58          super.validate(version);
59      }
60  
61  
62      /**
63       * Get the atmospheric density forecast error.
64       * @return densityForecastUncertainty
65       */
66      public double getDensityForecastUncertainty() {
67          return densityForecastUncertainty;
68      }
69  
70      /**
71       * Set the atmospheric density forecast error.
72       * @param densityForecastUncertainty the cScaleFactorMax to set
73       */
74      public void setDensityForecastUncertainty(final double densityForecastUncertainty) {
75          refuseFurtherComments();
76          this.densityForecastUncertainty = densityForecastUncertainty;
77      }
78  
79      /** Get the minimum suggested covariance scale factor.
80       * @return the cScaleFactorMin
81       */
82      public double getcScaleFactorMin() {
83          return cScaleFactorMin;
84      }
85  
86      /** Set the minimum suggested covariance scale factor.
87       * @param cScaleFactorMin the cScaleFactorMin to set
88       */
89      public void setcScaleFactorMin(final double cScaleFactorMin) {
90          this.cScaleFactorMin = cScaleFactorMin;
91      }
92  
93      /** Get the (median) suggested covariance scale factor.
94       * @return the cScaleFactor
95       */
96      public double getcScaleFactor() {
97          return cScaleFactor;
98      }
99  
100     /** Set the (median) suggested covariance scale factor.
101      * @param cScaleFactor the cScaleFactor to set
102      */
103     public void setcScaleFactor(final double cScaleFactor) {
104         this.cScaleFactor = cScaleFactor;
105     }
106 
107     /** Get the maximum suggested covariance scale factor.
108      * @return the cScaleFactorMax
109      */
110     public double getcScaleFactorMax() {
111         return cScaleFactorMax;
112     }
113 
114     /** set the maximum suggested covariance scale factor.
115      * @param cScaleFactorMax the cScaleFactorMax to set
116      */
117     public void setcScaleFactorMax(final double cScaleFactorMax) {
118         this.cScaleFactorMax = cScaleFactorMax;
119     }
120 
121     /** Get the source (or origin) of the specific orbital data for this object.
122      * @return the screeningDataSource
123      */
124     public String getScreeningDataSource() {
125         return screeningDataSource;
126     }
127 
128     /** Set the source (or origin) of the specific orbital data for this object.
129      * @param screeningDataSource the screeningDataSource to set
130      */
131     public void setScreeningDataSource(final String screeningDataSource) {
132         this.screeningDataSource = screeningDataSource;
133     }
134 
135     /** Get the DCP sensitivity vector (position errors at TCA).
136      * @return the dcpSensitivityVectorPosition
137      */
138     public double[] getDcpSensitivityVectorPosition() {
139         return dcpSensitivityVectorPosition == null ? null : dcpSensitivityVectorPosition.clone();
140     }
141 
142     /** Set the DCP sensitivity vector (position errors at TCA).
143      * @param dcpSensitivityVectorPosition the dcpSensitivityVectorPosition to set
144      */
145     public void setDcpSensitivityVectorPosition(final double[] dcpSensitivityVectorPosition) {
146         this.dcpSensitivityVectorPosition = dcpSensitivityVectorPosition == null ? null : dcpSensitivityVectorPosition.clone();
147     }
148 
149     /** Get the DCP sensitivity vector (velocity errors at TCA).
150      * @return the dcpSensitivityVectorVelocity
151      */
152     public double[] getDcpSensitivityVectorVelocity() {
153         return dcpSensitivityVectorVelocity == null ? null : dcpSensitivityVectorVelocity.clone();
154     }
155 
156     /** Set the DCP sensitivity vector (velocity errors at TCA).
157      * @param dcpSensitivityVectorVelocity the dcpSensitivityVectorVelocity to set
158      */
159     public void setDcpSensitivityVectorVelocity(final double[] dcpSensitivityVectorVelocity) {
160         this.dcpSensitivityVectorVelocity = dcpSensitivityVectorVelocity == null ? null : dcpSensitivityVectorVelocity.clone();
161     }
162 
163 }