Package org.orekit.files.ccsds.section

Class AbstractWriter

java.lang.Object

org.orekit.files.ccsds.section.AbstractWriter

Direct Known Subclasses:

AdditionalParametersWriter, AdmCommonMetadataWriter, CartesianCovarianceWriter, CdmMetadataWriter, CommonMetadataWriter, ODParametersWriter, RTNCovarianceWriter, SpacecraftParametersWriter, StateVectorWriter, StateVectorWriter, UserDefinedWriter

public abstract class AbstractWriter
extends Object

Top level class for writing CCSDS message sections.

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWriter(String xmlTag, String kvnTag)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
void	enterSection(Generator generator)	Enter the section.
void	exitSection(Generator generator)	Exit the section.
protected String	intArrayToString(int[] integers)	Convert an array of integer to a comma-separated list.
void	write(Generator generator)	Write the section, including surrounding tags.
protected abstract void	writeContent(Generator generator)	Write the content of the section, excluding surrounding tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWriter

protected AbstractWriter(String xmlTag,
                         String kvnTag)

Simple constructor.

Parameters:

xmlTag - name of the XML tag surrounding the section

kvnTag - name of the KVN tag surrounding the section (may be null)

Method Detail

write

public void write(Generator generator)
           throws IOException

Write the section, including surrounding tags.

Parameters:

generator - generator to use for producing output

Throws:

IOException - if any buffer writing operations fails

enterSection

public void enterSection(Generator generator)
                  throws IOException

Enter the section.

Parameters:

generator - generator to use for producing output

Throws:

IOException - if an I/O error occurs.

Since:

12.0

exitSection

public void exitSection(Generator generator)
                 throws IOException

Exit the section.

Parameters:

generator - generator to use for producing output

Throws:

IOException - if an I/O error occurs.

Since:

12.0

writeContent

protected abstract void writeContent(Generator generator)
                              throws IOException

Write the content of the section, excluding surrounding tags.

Parameters:

generator - generator to use for producing output

Throws:

IOException - if any buffer writing operations fails

intArrayToString

protected String intArrayToString(int[] integers)

Convert an array of integer to a comma-separated list.

Parameters:

integers - integers to write

Returns:

arrays as a string