org.orekit.files.ccsds.utils.generation

Class KvnGenerator

java.lang.Object

org.orekit.files.ccsds.utils.generation.AbstractGenerator

org.orekit.files.ccsds.utils.generation.KvnGenerator

All Implemented Interfaces:

AutoCloseable, Generator

public class KvnGenerator
extends AbstractGenerator

生成器，用于生成键-值表示的CCSDS消息。

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor and Description
KvnGenerator(Appendable output, int paddingWidth, String outputName, double maxRelativeOffset, int unitsColumn) 简单构造函数。

Method Summary

Modifier and Type	Method and Description
void	endMessage(String root) 结束CCSDS消息。
void	enterSection(String name) 进入新的部分。
String	exitSection() 退出上一个部分。
FileFormat	getFormat() 获取生成的文件格式。
void	startMessage(String root, String messageTypeKey, double version) 开始CCSDS消息。
void	writeComments(List<String> comments) 写入注释行。
void	writeEntry(String key, String value, Unit unit, boolean mandatory) 写入单个键/值条目。

Methods inherited from class org.orekit.files.ccsds.utils.generation.AbstractGenerator

close, complain, dateToCalendarString, dateToString, dateToString, doubleToString, getOutputName, newLine, siToCcsdsName, unitsListToString, writeEntry, writeEntry, writeEntry, writeEntry, writeEntry, writeEntry, writeEntry, writeRawData, writeRawData, writeUnits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KvnGenerator

public KvnGenerator(Appendable output,
                    int paddingWidth,
                    String outputName,
                    double maxRelativeOffset,
                    int unitsColumn)

简单构造函数。

参数：

output - 生成输出的目的地

paddingWidth - 用于对齐“=”符号的填充宽度（不包括在“=”符号之前添加的额外空格）

outputName - 错误消息的输出名称

maxRelativeOffset - 使用相对日期的最大偏移量（如果日期与参考日期相距太远，则将其显示为日历元素）

unitsColumn - 用于对齐单位的列数（如果为负数或零，则不输出单位）

另请参阅：

TdmWriter.KVN_PADDING_WIDTH, AemWriter.KVN_PADDING_WIDTH, ApmWriter.KVN_PADDING_WIDTH, OpmWriter.KVN_PADDING_WIDTH, OmmWriter.KVN_PADDING_WIDTH, OemWriter.KVN_PADDING_WIDTH, OcmWriter.KVN_PADDING_WIDTH

Method Detail

getFormat

public FileFormat getFormat()

获取生成的文件格式。

返回：

生成的文件格式

startMessage

public void startMessage(String root,
                         String messageTypeKey,
                         double version)
                  throws IOException

开始CCSDS消息。

参数：

root - XML文件的根元素

messageTypeKey - 消息类型的关键字

version - 格式版本

抛出：

IOException - 如果发生I/O错误。

endMessage

public void endMessage(String root)

结束CCSDS消息。

参数：

root - XML文件的根元素

writeComments

public void writeComments(List<String> comments)
                   throws IOException

写入注释行。

参数：

comments - 要写入的注释

抛出：

IOException - 如果发生I/O错误。

writeEntry

public void writeEntry(String key,
                       String value,
                       Unit unit,
                       boolean mandatory)
                throws IOException

写入单个键/值条目。

参数：

key - 要写入的关键字

value - 要写入的值

unit - 输出单位（可以为null）

mandatory - 如果为true，则null值会触发异常，否则它们会被静默忽略

抛出：

IOException - 如果发生I/O错误。

enterSection

public void enterSection(String name)
                  throws IOException

进入新的部分。

指定者：

enterSection 在接口 Generator

覆盖：

enterSection 在类 AbstractGenerator

参数：

name - 部分名称

抛出：

IOException - 如果发生I/O错误。

exitSection

public String exitSection()
                   throws IOException

退出上一个部分。

指定者：

exitSection 在接口 Generator

覆盖：

exitSection 在类 AbstractGenerator

返回：

部分名称

抛出：

IOException - 如果发生I/O错误。