org.orekit.files.ccsds.utils.generation

Class AbstractMessageWriter<H extends Header,S extends Segment<?,?>,F extends NdmConstituent<H,S>>

java.lang.Object

org.orekit.files.ccsds.utils.generation.AbstractMessageWriter<H,S,F>

Type Parameters:

H - type of the header

S - type of the segments

F - type of the NDM constituent

All Implemented Interfaces:

MessageWriter<H,S,F>

Direct Known Subclasses:

AcmWriter, AemWriter, ApmWriter, OcmWriter, OemWriter, OmmWriter, OpmWriter, TdmWriter

public abstract class AbstractMessageWriter<H extends Header,S extends Segment<?,?>,F extends NdmConstituent<H,S>>
extends Object
implements MessageWriter<H,S,F>

导航数据消息（NDM）文件的基类。

Since:

11.0

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ORIGINATOR HeaderKey.ORIGINATOR的默认值。

Constructor Summary

Constructors

Constructor and Description
AbstractMessageWriter(String root, String formatVersionKey, double defaultVersion, ContextBinding context) 用于创建配置了必要参数的新NDM写入器的构造函数，以成功填写所有不属于标准对象的必填字段。

Method Summary

Modifier and Type	Method and Description
ContextBinding	getContext() 获取当前上下文。
double	getDefaultVersion() 获取默认格式版本。
String	getFormatVersionKey() 获取格式版本的键。
String	getRoot() 获取XML文件的根元素。
TimeConverter	getTimeConverter() 获取当前时间转换器。
double	getVersion() 获取当前格式版本。
void	setContext(ContextBinding context) 重置上下文绑定。
void	writeFooter(Generator generator) 为文件写入页脚。
void	writeHeader(Generator generator, H header) 为文件写入页眉。
void	writeSegment(Generator generator, S segment) 写入一个段。
protected abstract void	writeSegmentContent(Generator generator, double formatVersion, S segment) 写入一个段的内容（不包括XML包装）。

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.MessageWriter

writeMessage

Field Detail

DEFAULT_ORIGINATOR

public static final String DEFAULT_ORIGINATOR

HeaderKey.ORIGINATOR的默认值。

另请参阅:

常量字段值

Constructor Detail

AbstractMessageWriter

public AbstractMessageWriter(String root,
                             String formatVersionKey,
                             double defaultVersion,
                             ContextBinding context)

用于创建配置了必要参数的新NDM写入器的构造函数。

如果头部中不存在创建日期和发起者，则将使用内置默认值

参数:

root - XML文件的根元素

formatVersionKey - 格式版本的键

defaultVersion - 默认格式版本

context - 上下文绑定（每个段可能会重置）

Method Detail

setContext

public void setContext(ContextBinding context)

重置上下文绑定。

参数:

context - 要使用的上下文绑定

getContext

public ContextBinding getContext()

获取当前上下文。

返回:

当前上下文

getTimeConverter

public TimeConverter getTimeConverter()

获取当前时间转换器。

返回:

当前时间转换器

getDefaultVersion

public double getDefaultVersion()

获取默认格式版本。

返回:

默认格式版本

writeHeader

public void writeHeader(Generator generator,
                        H header)
                 throws IOException

为文件写入页眉。

接口中的指定:

writeHeader 在接口 MessageWriter<H extends Header,S extends Segment<?,?>,F extends NdmConstituent<H,S>>

参数:

generator - 用于生成输出的生成器

header - 要写入的头部（如果缺失，将添加创建日期和发起者）

抛出:

IOException - 如果流无法写入流

writeSegment

public void writeSegment(Generator generator,
                         S segment)
                  throws IOException

写入一个段。

接口中的指定:

writeSegment 在接口 MessageWriter<H extends Header,S extends Segment<?,?>,F extends NdmConstituent<H,S>>

参数:

generator - 用于生成输出的生成器

segment - 要写入的段

抛出:

IOException - 如果任何缓冲区写入操作失败

writeSegmentContent

protected abstract void writeSegmentContent(Generator generator,
                                            double formatVersion,
                                            S segment)
                                     throws IOException

写入一个段的内容（不包括XML包装）。

参数:

generator - 用于生成输出的生成器

formatVersion - 要使用的格式版本

segment - 要写入的段

抛出:

IOException - 如果任何缓冲区写入操作失败

writeFooter

public void writeFooter(Generator generator)
                 throws IOException

为文件写入页脚。

接口中的指定:

writeFooter 在接口 MessageWriter<H extends Header,S extends Segment<?,?>,F extends NdmConstituent<H,S>>

参数:

generator - 用于生成输出的生成器

抛出:

IOException - 如果流无法写入流

getRoot

public String getRoot()

获取XML文件的根元素。

接口中的指定:

getRoot 在接口 MessageWriter<H extends Header,S extends Segment<?,?>,F extends NdmConstituent<H,S>>

返回:

XML文件的根元素

getFormatVersionKey

public String getFormatVersionKey()

获取格式版本的密钥。

指定者：

getFormatVersionKey 在接口 MessageWriter<H 扩展 Header,S 扩展 Segment<?,?>,F 扩展 NdmConstituent<H,S>>

返回：

格式版本的密钥

getVersion

public double getVersion()

获取当前格式版本。

指定者：

getVersion 在接口 MessageWriter<H 扩展 Header,S 扩展 Segment<?,?>,F 扩展 NdmConstituent<H,S>>

返回：

当前格式版本