ParserBuilder (OREKIT 12.0.1 API)

java.lang.Object
- org.orekit.files.ccsds.ndm.AbstractBuilder<ParserBuilder>
- - org.orekit.files.ccsds.ndm.ParserBuilder

```
public class ParserBuilder
extends AbstractBuilder<ParserBuilder>
```
用于所有CCSDS消息文件解析器的构建器。
此构建器可用于构建所有CCSDS消息解析器类型。在多线程环境中特别有用，因为解析器不能在线程之间共享，因此在这种情况下必须构建几个独立的解析器。

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors
Constructor and Description
`ParserBuilder()` 简单构造函数。
`ParserBuilder(DataContext dataContext)` 简单构造函数。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcmParser`	`buildAcmParser()` 为`姿态综合消息`构建解析器。
`AemParser`	`buildAemParser()` 为`姿态星历消息`构建解析器。
`ApmParser`	`buildApmParser()` 为`姿态参数消息`构建解析器。
`CdmParser`	`buildCdmParser()` 为`共轨数据消息`构建解析器。
`NdmParser`	`buildNdmParser()` 为`导航数据消息`构建解析器。
`OcmParser`	`buildOcmParser()` 为`轨道综合消息`构建解析器。
`OemParser`	`buildOemParser()` 为`轨道星历消息`构建解析器。
`OmmParser`	`buildOmmParser()` 为`轨道平均元素消息`构建解析器。
`OpmParser`	`buildOpmParser()` 为`轨道参数消息`构建解析器。
`TdmParser`	`buildTdmParser()` 为`跟踪数据消息`构建解析器。
`protected ParserBuilder`	`create(IERSConventions newConventions, double newEquatorialRadius, double newFlattening, DataContext newDataContext, AbsoluteDate newMissionReferenceDate, RangeUnitsConverter newRangeUnitsConverter)` 构建一个实例。
`int`	`getDefaultInterpolationDegree()` 获取默认插值度。
`double`	`getDefaultMass()` 获取默认质量。
`Function<ParseToken,List<ParseToken>>[]`	`getFilters()` 获取要应用于解析标记的过滤器。
`double`	`getMu()` 获取引力系数。
`ParsedUnitsBehavior`	`getParsedUnitsBehavior()` 获取处理解析单位的行为。
`boolean`	`isSimpleEOP()` 检查在插值EOP时是否忽略了地潮效应。
`ParserBuilder`	`withDefaultInterpolationDegree(int newDefaultInterpolationDegree)` 设置默认插值度。
`ParserBuilder`	`withDefaultMass(double newDefaultMass)` 设置默认质量。
`ParserBuilder`	`withFilter(Function<ParseToken,List<ParseToken>> filter)` 添加解析标记的过滤器。
`ParserBuilder`	`withMu(double newMu)` 设置引力系数。
`ParserBuilder`	`withParsedUnitsBehavior(ParsedUnitsBehavior newParsedUnitsBehavior)` 设置处理解析单位的行为。
`ParserBuilder`	`withSimpleEOP(boolean newSimpleEOP)` 设置在插值EOP时忽略地潮效应的标志。

Methods inherited from class org.orekit.files.ccsds.ndm.AbstractBuilder
getConventions, getDataContext, getEquatorialRadius, getFlattening, getMissionReferenceDate, getRangeUnitsConverter, withConventions, withDataContext, withEquatorialRadius, withFlattening, withMissionReferenceDate, withRangeUnitsConverter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParserBuilder
```
@DefaultDataContext
public ParserBuilder()
```
    简单构造函数。
    此构造函数创建一个构建器，其中包括
    - IERS约定设置为IERSConventions.IERS_2010
    - 简单EOP设置为true
    - 数据上下文设置为默认上下文
    - 任务参考日期设置为null
    - 引力系数设置为Double.NaN
    - 中心天体赤道半径设置为Double.NaN
    - 中心天体扁率设置为Double.NaN
    - 默认质量设置为Double.NaN
    - 默认插值度设置为1
    - 解析单位行为设置为ParsedUnitsBehavior.CONVERT_COMPATIBLE
    - 范围单位转换器设置为IdentityConverter
  - ParserBuilder
```
public ParserBuilder(DataContext dataContext)
```
    简单构造函数。
    此构造函数创建一个构建器，其中包括
    - IERS约定设置为IERSConventions.IERS_2010
    - 简单EOP设置为true
    - 任务参考日期设置为null
    - 引力系数设置为Double.NaN
    - 中心天体赤道半径设置为Double.NaN
    - 中心天体扁率设置为Double.NaN
    - 默认质量设置为Double.NaN
    - 默认插值度设置为1
    - 解析单位行为设置为ParsedUnitsBehavior.CONVERT_COMPATIBLE
    - 范围单位转换器设置为IdentityConverter
    参数：
    
    dataContext - 用于检索框架、时间标度等的数据上下文。
- Method Detail
  - create
```
protected ParserBuilder create(IERSConventions newConventions,
                               double newEquatorialRadius,
                               double newFlattening,
                               DataContext newDataContext,
                               AbsoluteDate newMissionReferenceDate,
                               RangeUnitsConverter newRangeUnitsConverter)
```
    构建一个实例。
    
    指定者：
    
    create 在类 AbstractBuilder<ParserBuilder>
    
    参数：
    
    newConventions - IERS约定
    
    newEquatorialRadius - 中心天体赤道半径
    
    newFlattening - 中心天体扁率
    
    newDataContext - 用于检索框架、时间标度等的数据上下文
    
    newMissionReferenceDate - 任务经过时间或任务相对时间时间系统的参考日期
    
    newRangeUnitsConverter - 范围单位的转换器
    
    返回：
    
    新实例
  - withSimpleEOP
```
public ParserBuilder withSimpleEOP(boolean newSimpleEOP)
```
    设置标志以在插值EOP时忽略地潮效应。
    
    参数：
    
    newSimpleEOP - 如果在插值EOP时忽略地潮效应，则为true
    
    返回：
    
    具有更新配置的新构建器（实例未更改）
  - isSimpleEOP
```
public boolean isSimpleEOP()
```
    检查在插值EOP时是否忽略了地潮效应。
    
    返回：
    
    如果在插值EOP时忽略地潮效应，则为true
  - withMu
```
public ParserBuilder withMu(double newMu)
```
    设置引力系数。
    
    参数：
    
    newMu - 引力系数
    
    返回：
    
    具有更新配置的新构建器（实例未更改）
  - getMu
```
public double getMu()
```
    获取引力系数。
    
    返回：
    
    引力系数
  - withDefaultMass
```
public ParserBuilder withDefaultMass(double newDefaultMass)
```
    设置默认质量。
    默认质量仅由OpmParser使用。
    
    参数：
    
    newDefaultMass - 默认质量
    
    返回：
    
    具有更新配置的新构建器（实例未更改）
  - getDefaultMass
```
public double getDefaultMass()
```
    获取默认质量。
    
    返回：
    
    默认质量
  - withDefaultInterpolationDegree
```
public ParserBuilder withDefaultInterpolationDegree(int newDefaultInterpolationDegree)
```
    设置默认插值度。
    默认插值度仅由AemParser和OemParser使用。
    
    参数：
    
    newDefaultInterpolationDegree - 默认插值度
    
    返回：
    
    具有更新配置的新构建器（实例未更改）
  - getDefaultInterpolationDegree
```
public int getDefaultInterpolationDegree()
```
    获取默认插值度。
    
    返回：
    
    默认插值度
  - withParsedUnitsBehavior
```
public ParserBuilder withParsedUnitsBehavior(ParsedUnitsBehavior newParsedUnitsBehavior)
```
    设置处理解析单位的行为。
    
    参数：
    
    newParsedUnitsBehavior - 处理解析单位的行为
    
    返回：
    
    具有更新配置的新构建器（实例未更改）
  - getParsedUnitsBehavior
```
public ParsedUnitsBehavior getParsedUnitsBehavior()
```
    获取处理解析单位的行为。
    
    返回：
    
    处理解析单位的行为
  - withFilter
```
public ParserBuilder withFilter(Function<ParseToken,List<ParseToken>> filter)
```
    添加解析标记的过滤器。
    此过滤器允许更改解析的标记。可以多次调用此方法，每次设置一个过滤器。过滤器始终按照设置的顺序应用。此功能有几个用例。
    
    第一个用例是允许解析存在一些已知差异的格式不正确的CCSDS消息。一个真实的例子（激发此功能开发的例子）是XML格式的OMM文件添加了一个空的OBJECT_ID。可以通过设置过滤器来修复这个问题，如下所示：
```
 Omm omm = new ParserBuilder().
           withFilter(token -> {
                          if ("OBJECT_ID".equals(token.getName()) &&
                              (token.getRawContent() == null || token.getRawContent().isEmpty())) {
                              // 用"unknown"替换null/空条目
                              return Collections.singletonList(new ParseToken(token.getType(), token.getName(),
                                                                              "unknown", token.getUnits(),
                                                                              token.getLineNumber(), token.getFileName()));
                          } else {
                              return Collections.singletonList(token);
                          }
                     }).
           buildOmmParser().
           parseMessage(message);
 
```
    第二个用例是删除不需要的数据。例如，为了删除所有用户定义的数据，可以使用：
```
 Omm omm = new ParserBuilder().
           withFilter(token -> {
                          if (token.getName().startsWith("USER_DEFINED")) {
                              return Collections.emptyList();
                          } else {
                              return Collections.singletonList(token);
                          }
                     }).
           buildOmmmParser().
           parseMessage(message);
 
```
    第三个用例是添加原始文件中原本不存在的数据。例如，为了向缺少生成的ODM V3消息ID的ODM V2消息中添加一个生成的消息ID，可以执行以下操作：
```
 final String myMessageId = ...; // 这可以从计数器、SHA256摘要或一些元数据计算
 Omm omm = new ParserBuilder()
           withFilter(token -> {
                          if ("CCSDS_OMM_VERS".equals(token.getName())) {
                              // 强制使用ODM V3
                              return Collections.singletonList(new ParseToken(token.getType(), token.getName(),
                                                                              "3.0", token.getUnits(),
                                                                              token.getLineNumber(), token.getFileName()));
                          } else {
                              return Collections.singletonList(token);
                          }
                      }).
           withFilter(token -> {
                          if ("ORIGINATOR".equals(token.getName())) {
                              // 在ORIGINATOR条目后添加生成的消息ID
                              return Arrays.asList(token,
                                                   new ParseToken(TokenType.ENTRY, "MESSAGE_ID",
                                                                  myMessageId, null,
                                                                  -1, token.getFileName()));
                          } else {
                              return Collections.singletonList(token);
                          }
                      }).
           buildOmmmParser().
           parseMessage(message);
 
```
    参数：
    
    filter - 要添加的标记过滤器
    
    返回：
    
    具有更新配置的新构建器（实例未更改）
    
    自版本：
    
    12.0
  - getFilters
```
public Function<ParseToken,List<ParseToken>>[] getFilters()
```
    获取要应用于解析标记的过滤器。
    
    返回：
    
    要应用于解析标记的过滤器
    
    自版本：
    
    12.0
  - buildNdmParser
```
public NdmParser buildNdmParser()
```
    构建用于导航数据消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildOpmParser
```
public OpmParser buildOpmParser()
```
    构建用于轨道参数消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildOmmParser
```
public OmmParser buildOmmParser()
```
    构建用于轨道平均元素消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildOemParser
```
public OemParser buildOemParser()
```
    构建用于轨道星历消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildOcmParser
```
public OcmParser buildOcmParser()
```
    构建用于轨道综合消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildApmParser
```
public ApmParser buildApmParser()
```
    构建用于姿态参数消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildAemParser
```
public AemParser buildAemParser()
```
    构建用于姿态星历消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildAcmParser
```
public AcmParser buildAcmParser()
```
    构建用于姿态综合消息的解析器。
    
    返回：
    
    一个新的解析器
    
    自版本：
    
    12.0
  - buildTdmParser
```
public TdmParser buildTdmParser()
```
    构建用于跟踪数据消息的解析器。
    
    返回：
    
    一个新的解析器
  - buildCdmParser
```
public CdmParser buildCdmParser()
```
    构建用于碰撞数据消息的解析器。
    
    返回：
    
    一个新的解析器

Class ParserBuilder

Constructor Summary

Method Summary

Methods inherited from class org.orekit.files.ccsds.ndm.AbstractBuilder

Methods inherited from class java.lang.Object

Constructor Detail

ParserBuilder

ParserBuilder

Method Detail

create

withSimpleEOP

isSimpleEOP

withMu

getMu

withDefaultMass

getDefaultMass

withDefaultInterpolationDegree

getDefaultInterpolationDegree

withParsedUnitsBehavior

getParsedUnitsBehavior

withFilter

getFilters

buildNdmParser

buildOpmParser

buildOmmParser

buildOemParser

buildOcmParser

buildApmParser

buildAemParser

buildAcmParser

buildTdmParser

buildCdmParser