1   /* Copyright 2024-2025 The Johns Hopkins University Applied Physics Laboratory
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.iirv.terms;
18  
19  
20  import org.orekit.errors.OrekitIllegalArgumentException;
21  import org.orekit.errors.OrekitMessages;
22  import org.orekit.files.iirv.terms.base.LongValuedIIRVTerm;
23  
24  /**
25   * 3-character sequence number counter that is incremented for each vector in a set of vector data on a per-station per
26   * transmission basis.
27   * <p>
28   * Valid values: 000-999.
29   *
30   * @author Nick LaFarge
31   * @since 13.0
32   */
33  public class SequenceNumberTerm extends LongValuedIIRVTerm {
34  
35      /** The length of the IIRV term within the message. */
36      public static final int SEQUENCE_NUMBER_TERM_LENGTH = 3;
37  
38      /** Maximum value of an IIRV sequence number. */
39      public static final int MAX_SEQUENCE_NUMBER = 999;
40  
41      /** Regular expression that ensures the validity of string values for this term (integer 000-999). */
42      public static final String SEQUENCE_NUMBER_TERM_PATTERN = "\\d{3}";
43  
44      /**
45       * Constructor.
46       * <p>
47       * See {@link LongValuedIIRVTerm#LongValuedIIRVTerm(String, String, int, boolean)}
48       *
49       * @param value value of the sequence number
50       */
51      public SequenceNumberTerm(final String value) {
52          super(SEQUENCE_NUMBER_TERM_PATTERN, value, SEQUENCE_NUMBER_TERM_LENGTH, false);
53      }
54  
55      /**
56       * Constructor.
57       * <p>
58       * See {@link LongValuedIIRVTerm#LongValuedIIRVTerm(String, long, int, boolean)}
59       *
60       * @param value value of the sequence number
61       */
62      public SequenceNumberTerm(final long value) {
63          super(SEQUENCE_NUMBER_TERM_PATTERN, value, SEQUENCE_NUMBER_TERM_LENGTH, false);
64  
65          if (value > MAX_SEQUENCE_NUMBER) {
66              throw new OrekitIllegalArgumentException(OrekitMessages.IIRV_EXCEEDS_MAX_VECTORS, value);
67          }
68      }
69  }