AbstractGenerator (OREKIT 12.0.1 API)

java.lang.Object
- org.orekit.files.ccsds.utils.generation.AbstractGenerator

All Implemented Interfaces:

AutoCloseable, Generator

Direct Known Subclasses:

KvnGenerator, XmlGenerator
```
public abstract class AbstractGenerator
extends Object
implements Generator
```
用于CCSDS消息的键值表示和扩展标记语言生成器的基类。

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors
Constructor and Description
`AbstractGenerator(Appendable output, String outputName, double maxRelativeOffset, boolean writeUnits)` 简单构造函数。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` 关闭生成器。
`protected void`	`complain(String key, boolean mandatory)` 报告缺少值。
`String`	`dateToCalendarString(TimeConverter converter, AbsoluteDate date)` 将日期转换为具有高精度的日历字符串值。
`String`	`dateToString(int year, int month, int day, int hour, int minute, double seconds)` 将日期转换为具有高精度的字符串值。
`String`	`dateToString(TimeConverter converter, AbsoluteDate date)` 将日期转换为具有高精度的字符串值。
`String`	`doubleToString(double value)` 将双精度数转换为具有高精度的字符串值。
`void`	`enterSection(String name)` 进入新的部分。
`String`	`exitSection()` 退出上一个部分。
`String`	`getOutputName()` 获取输出的名称（用于错误消息）。
`void`	`newLine()` 完成当前行。
`String`	`siToCcsdsName(String siName)` 将SI单位名称转换为CCSDS名称。
`String`	`unitsListToString(List<Unit> units)` 将单位列表转换为带括号的字符串。
`void`	`writeEntry(String key, char value, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, double value, Unit unit, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, Double value, Unit unit, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, Enum<?> value, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, int value, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, List<String> value, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, TimeConverter converter, AbsoluteDate date, boolean forceCalendar, boolean mandatory)` 写入单个键/值条目。
`void`	`writeRawData(char data)` 写入原始数据。
`void`	`writeRawData(CharSequence data)` 写入原始数据。
`boolean`	`writeUnits(Unit unit)` 检查是否必须写入单位。

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

Methods inherited from interface org.orekit.files.ccsds.utils.generation.Generator
endMessage, getFormat, startMessage, writeComments, writeEntry

- Constructor Detail
  - AbstractGenerator
```
public AbstractGenerator(Appendable output,
                         String outputName,
                         double maxRelativeOffset,
                         boolean writeUnits)
```
    简单构造函数。
    
    参数：
    
    output - 生成输出的目的地
    
    outputName - 用于错误消息的输出名称
    
    maxRelativeOffset - 使用相对日期的最大偏移量（如果日期与参考日期相距太远，则将其显示为日历元素）
    
    writeUnits - 如果为true，则必须写入单位
- Method Detail
  - getOutputName
```
public String getOutputName()
```
    获取输出的名称（用于错误消息）。
    
    由以下指定：
    
    getOutputName 在接口 Generator
    
    返回：
    
    输出的名称
  - writeUnits
```
public boolean writeUnits(Unit unit)
```
    检查是否必须写入单位。
    
    参数：
    
    unit - 条目单位
    
    返回：
    
    如果必须写入单位，则为true
  - close
```
public void close()
           throws IOException
```
    关闭生成器。
    
    由以下指定：
    
    close 在接口 AutoCloseable
    
    由以下指定：
    
    close 在接口 Generator
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - newLine
```
public void newLine()
             throws IOException
```
    完成当前行。
    
    由以下指定：
    
    newLine 在接口 Generator
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
public void writeEntry(String key,
                       List<String> value,
                       boolean mandatory)
                throws IOException
```
    写入单个键/值条目。
    
    由以下指定：
    
    writeEntry 在接口 Generator
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则空值会触发异常，否则它们会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
public void writeEntry(String key,
                       Enum<?> value,
                       boolean mandatory)
                throws IOException
```
    写入单个键/值条目。
    
    由以下指定：
    
    writeEntry 在接口 Generator
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则空值会触发异常，否则它们会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
public void writeEntry(String key,
                       TimeConverter converter,
                       AbsoluteDate date,
                       boolean forceCalendar,
                       boolean mandatory)
                throws IOException
```
    写入单个键/值条目。
    
    由以下指定：
    
    writeEntry 在接口 Generator
    
    参数：
    
    key - 要写入的关键字
    
    converter - 用于日期的转换器
    
    date - 要写入的日期
    
    forceCalendar - 如果为true，则日期被强制为日历格式
    
    mandatory - 如果为true，则空值会触发异常，否则它们会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
public void writeEntry(String key,
                       double value,
                       Unit unit,
                       boolean mandatory)
                throws IOException
```
    写入单个键/值条目。
    
    由以下指定：
    
    writeEntry 在接口 Generator
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值（以SI单位）
    
    unit - 输出单位
    
    mandatory - 如果为true，则空值会触发异常，否则它们会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
public void writeEntry(String key,
                       Double value,
                       Unit unit,
                       boolean mandatory)
                throws IOException
```
    写入单个键/值条目。
    
    由以下指定：
    
    writeEntry 在接口 Generator
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值（以SI单位）
    
    unit - 输出单位
    
    mandatory - 如果为true，则空值会触发异常，否则它们会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
public void writeEntry(String key,
                       char value,
                       boolean mandatory)
                throws IOException
```
    写入单个键/值条目。
    
    Specified by:
    
    writeEntry in interface Generator
    
    Parameters:
    
    key - the keyword to write
    
    value - the value to write
    
    mandatory - if true, null values triggers exception, otherwise they are silently ignored
    
    Throws:
    
    IOException - if an I/O error occurs.
  - writeEntry
```
public void writeEntry(String key,
                       int value,
                       boolean mandatory)
                throws IOException
```
    Write a single key/value entry.
    
    指定者:
    
    writeEntry 在接口 Generator
    
    参数:
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则触发异常，否则将被静默忽略
    
    抛出:
    
    IOException - 如果发生I/O错误。
  - writeRawData
```
public void writeRawData(char data)
                  throws IOException
```
    写入原始数据。
    
    指定者:
    
    writeRawData 在接口 Generator
    
    参数:
    
    data - 要写入的原始数据
    
    抛出:
    
    IOException - 如果发生I/O错误。
  - writeRawData
```
public void writeRawData(CharSequence data)
                  throws IOException
```
    写入原始数据。
    
    指定者:
    
    writeRawData 在接口 Generator
    
    参数:
    
    data - 要写入的原始数据
    
    抛出:
    
    IOException - 如果发生I/O错误。
  - enterSection
```
public void enterSection(String name)
                  throws IOException
```
    进入新的部分。
    
    指定者:
    
    enterSection 在接口 Generator
    
    参数:
    
    name - 部分名称
    
    抛出:
    
    IOException - 如果发生I/O错误。
  - exitSection
```
public String exitSection()
                   throws IOException
```
    退出最后一个部分。
    
    指定者:
    
    exitSection 在接口 Generator
    
    返回:
    
    部分名称
    
    抛出:
    
    IOException - 如果发生I/O错误。
  - complain
```
protected void complain(String key,
                        boolean mandatory)
```
    报告缺少值。
    
    参数:
    
    key - 要写入的关键字
    
    mandatory - 如果为true，则触发异常，否则不执行任何操作
  - doubleToString
```
public String doubleToString(double value)
```
    将双精度数转换为具有高精度的字符串值。
    在写入双精度数时，我们不希望丢失内部精度，但我们也不希望出现 STEP = 1.25000000000000000 这样的丑陋表示，因此我们首先尝试几种简单的格式，如果不起作用，则退回到科学计数法。
    
    指定者:
    
    doubleToString 在接口 Generator
    
    参数:
    
    value - 要格式化的值
    
    返回:
    
    格式化后的值，保留所有原始值的精度，如果值为null或Double.NaN则返回null
  - dateToString
```
public String dateToString(TimeConverter converter,
                           AbsoluteDate date)
```
    将日期转换为具有高精度的字符串值。
    
    指定者:
    
    dateToString 在接口 Generator
    
    参数:
    
    converter - 日期转换器
    
    date - 要写入的日期
    
    返回:
    
    日期作为字符串（可以是相对日期或日历日期）
  - dateToCalendarString
```
public String dateToCalendarString(TimeConverter converter,
                                   AbsoluteDate date)
```
    将日期转换为具有高精度的日历字符串值。
    
    指定者:
    
    dateToCalendarString 在接口 Generator
    
    参数:
    
    converter - 日期转换器
    
    date - 要写入的日期
    
    返回:
    
    日期作为日历字符串
  - dateToString
```
public String dateToString(int year,
                           int month,
                           int day,
                           int hour,
                           int minute,
                           double seconds)
```
    将日期转换为具有高精度的字符串值。
    
    指定者:
    
    dateToString 在接口 Generator
    
    参数:
    
    year - 年
    
    month - 月
    
    day - 日
    
    hour - 小时
    
    minute - 分钟
    
    seconds - 秒
    
    返回:
    
    日期作为字符串
  - unitsListToString
```
public String unitsListToString(List<Unit> units)
```
    将单位列表转换为括号字符串。
    
    指定者:
    
    unitsListToString 在接口 Generator
    
    参数:
    
    units - 要输出的列表（可以为null或空）
    
    返回:
    
    括号字符串（如果单位列表为null或空则返回null）
  - siToCcsdsName
```
public String siToCcsdsName(String siName)
```
    将SI单位名称转换为CCSDS名称。
    
    指定者:
    
    siToCcsdsName 在接口 Generator
    
    参数:
    
    siName - SI单位名称
    
    返回:
    
    单位的CCSDS名称

Class AbstractGenerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.orekit.files.ccsds.utils.generation.Generator

Constructor Detail

AbstractGenerator

Method Detail

getOutputName

writeUnits

close

newLine

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

writeRawData

writeRawData

enterSection

exitSection

complain

doubleToString

dateToString

dateToCalendarString

dateToString

unitsListToString

siToCcsdsName