Generator (OREKIT 12.0.1 API)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractGenerator, KvnGenerator, XmlGenerator
```
public interface Generator
extends AutoCloseable
```
用于CCSDS消息生成的接口。

Since:

11.0

Author:

Luc Maisonobe

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` 关闭生成器。
`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`	`endMessage(String root)` 结束CCSDS消息。
`void`	`enterSection(String name)` 进入新的部分。
`String`	`exitSection()` 退出上一个部分。
`FileFormat`	`getFormat()` 获取生成的文件格式。
`String`	`getOutputName()` 获取输出的名称（用于错误消息）。
`void`	`newLine()` 完成当前行。
`String`	`siToCcsdsName(String siName)` 将SI单位名称转换为CCSDS名称。
`void`	`startMessage(String root, String messageTypeKey, double version)` 开始CCSDS消息。
`String`	`unitsListToString(List<Unit> units)` 将单位列表转换为括号字符串。
`void`	`writeComments(List<String> comments)` 写入注释行。
`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, String value, Unit unit, boolean mandatory)` 写入单个键/值条目。
`void`	`writeEntry(String key, TimeConverter converter, AbsoluteDate date, boolean forceCalendar, boolean mandatory)` 写入单个键/值条目。
`void`	`writeRawData(char data)` 写入原始数据。
`void`	`writeRawData(CharSequence data)` 写入原始数据。

- Method Detail
  - getOutputName
```
String getOutputName()
```
    获取输出的名称（用于错误消息）。
    
    返回：
    
    输出的名称
  - getFormat
```
FileFormat getFormat()
```
    获取生成的文件格式。
    
    返回：
    
    生成的文件格式
  - startMessage
```
void startMessage(String root,
                  String messageTypeKey,
                  double version)
           throws IOException
```
    开始CCSDS消息。
    
    参数：
    
    messageTypeKey - 消息类型的键
    
    root - XML文件的根元素
    
    version - 格式版本
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - endMessage
```
void endMessage(String root)
         throws IOException
```
    结束CCSDS消息。
    
    参数：
    
    root - XML文件的根元素
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeComments
```
void writeComments(List<String> comments)
            throws IOException
```
    写入注释行。
    
    参数：
    
    comments - 要写入的注释
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                String value,
                Unit unit,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    unit - 输出单位（可能为null）
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                List<String> value,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                Enum<?> value,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                TimeConverter converter,
                AbsoluteDate date,
                boolean forceCalendar,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    converter - 用于日期的转换器
    
    date - 要写入的日期
    
    forceCalendar - 如果为true，则日期被强制为日历格式
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                char value,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                int value,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                double value,
                Unit unit,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值（以SI单位）
    
    unit - 输出单位
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeEntry
```
void writeEntry(String key,
                Double value,
                Unit unit,
                boolean mandatory)
         throws IOException
```
    写入单个键/值条目。
    
    参数：
    
    key - 要写入的关键字
    
    value - 要写入的值（以SI单位）
    
    unit - 输出单位
    
    mandatory - 如果为true，则null值会触发异常，否则会被静默忽略
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - newLine
```
void newLine()
      throws IOException
```
    完成当前行。
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeRawData
```
void writeRawData(char data)
           throws IOException
```
    写入原始数据。
    
    参数：
    
    data - 要写入的原始数据
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - writeRawData
```
void writeRawData(CharSequence data)
           throws IOException
```
    写入原始数据。
    
    参数：
    
    data - 要写入的原始数据
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - enterSection
```
void enterSection(String name)
           throws IOException
```
    进入新的部分。
    
    参数：
    
    name - 部分名称
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - exitSection
```
String exitSection()
            throws IOException
```
    退出上一个部分。
    
    返回：
    
    部分名称
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - close
```
void close()
    throws IOException
```
    关闭生成器。
    
    由以下指定：
    
    close 在接口中 AutoCloseable
    
    抛出：
    
    IOException - 如果发生I/O错误。
  - dateToString
```
String dateToString(TimeConverter converter,
                    AbsoluteDate date)
```
    将日期转换为具有高精度的字符串值。
    
    参数:
    
    converter - 日期转换器
    
    date - 要写入的日期
    
    返回:
    
    日期作为字符串（可以是相对日期或日历日期）
  - dateToCalendarString
```
String dateToCalendarString(TimeConverter converter,
                            AbsoluteDate date)
```
    将日期转换为具有高精度的日历字符串值。
    
    参数:
    
    converter - 日期转换器
    
    date - 要写入的日期
    
    返回:
    
    日期作为日历字符串
    
    自版本:
    
    12.0
  - dateToString
```
String dateToString(int year,
                    int month,
                    int day,
                    int hour,
                    int minute,
                    double seconds)
```
    将日期转换为具有高精度的字符串值。
    
    参数:
    
    year - 年
    
    month - 月
    
    day - 日
    
    hour - 时
    
    minute - 分
    
    seconds - 秒
    
    返回:
    
    日期作为字符串
  - doubleToString
```
String doubleToString(double value)
```
    将双精度数转换为具有高精度的字符串值。
    在写入双精度数时，我们不希望丢失内部精度，但也不希望出现像STEP = 1.25000000000000000这样的丑陋表示，因此我们首先尝试几种简单的格式，如果不起作用，则退回到科学计数法。
    
    参数:
    
    value - 要格式化的值
    
    返回:
    
    格式化后的值，保留所有原始值的精度，如果值为null或Double.NaN则返回null
  - unitsListToString
```
String unitsListToString(List<Unit> units)
```
    将单位列表转换为括号字符串。
    
    参数:
    
    units - 要输出的列表（可以为null或空）
    
    返回:
    
    括号字符串（如果单位列表为null或空则返回null）
  - siToCcsdsName
```
String siToCcsdsName(String siName)
```
    将国际单位制单位名称转换为CCSDS名称。
    
    参数:
    
    siName - 国际单位制单位名称
    
    返回:
    
    单位的CCSDS名称

Interface Generator

Method Summary

Method Detail

getOutputName

getFormat

startMessage

endMessage

writeComments

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

writeEntry

newLine

writeRawData

writeRawData

enterSection

exitSection

close

dateToString

dateToCalendarString

dateToString

doubleToString

unitsListToString

siToCcsdsName