org.orekit.files.ccsds.ndm.cdm

Class CdmMessageWriter

java.lang.Object

org.orekit.files.ccsds.ndm.cdm.CdmMessageWriter

All Implemented Interfaces:

MessageWriter<CdmHeader,CdmSegment,Cdm>

Direct Known Subclasses:

CdmWriter

public abstract class CdmMessageWriter
extends Object
implements MessageWriter<CdmHeader,CdmSegment,Cdm>

Cdm消息编写器。

Since:

11.2

Author:

Melina Vanel

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CdmMessageWriter(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, CdmHeader header) 为文件写入页眉。
abstract void	writeRelativeMetadataContent(Generator generator, double formatVersion, CdmRelativeMetadata relativeMetadata) 仅在页眉之后写入RelativeMetadata部分一次。
void	writeSegment(Generator generator, CdmSegment segment) 写入一个段。
abstract void	writeSegmentContent(Generator generator, double formatVersion, Segment<CdmMetadata,CdmData> 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

CdmMessageWriter

public CdmMessageWriter(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,
                        CdmHeader header)
                 throws IOException

为文件写入页眉。

由以下指定:

writeHeader 在接口 MessageWriter<CdmHeader,CdmSegment,Cdm>

参数:

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

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

抛出:

IOException - 如果流无法写入流

writeSegment

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

写入一个段。

由以下指定:

writeSegment 在接口 MessageWriter<CdmHeader,CdmSegment,Cdm>

参数:

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

segment - 要写入的段

抛出:

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

writeRelativeMetadataContent

public abstract void writeRelativeMetadataContent(Generator generator,
                                                  double formatVersion,
                                                  CdmRelativeMetadata relativeMetadata)
                                           throws IOException

仅在页眉之后写入RelativeMetadata部分一次。

参数:

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

formatVersion - 要使用的格式版本

relativeMetadata - 要写入的相对元数据

抛出:

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

writeSegmentContent

public abstract void writeSegmentContent(Generator generator,
                                         double formatVersion,
                                         Segment<CdmMetadata,CdmData> segment)
                                  throws IOException

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

参数:

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

formatVersion - 要使用的格式版本

segment - 要写入的段

抛出:

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

writeFooter

public void writeFooter(Generator generator)
                 throws IOException

为文件写入页脚。

由以下指定:

writeFooter 在接口 MessageWriter<CdmHeader,CdmSegment,Cdm>

参数:

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

抛出:

IOException - 如果流无法写入流

getRoot

public String getRoot()

获取XML文件的根元素。

由以下指定:

getRoot 在接口 MessageWriter<CdmHeader,CdmSegment,Cdm>

返回:

XML文件的根元素

getFormatVersionKey

public String getFormatVersionKey()

获取格式版本的键。

由以下指定:

getFormatVersionKey 在接口 MessageWriter<CdmHeader,CdmSegment,Cdm>

返回:

格式版本的键

getVersion

public double getVersion()

获取当前格式版本。

由以下指定:

getVersion 在接口 MessageWriter<CdmHeader,CdmSegment,Cdm>

返回:

当前格式版本