org.orekit.files.ccsds.section

Class CommentsContainer

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

All Implemented Interfaces:

Section

Direct Known Subclasses:

AdditionalCovarianceMetadata, AemData, AngularVelocity, ApmQuaternion, AttitudeCovarianceHistoryMetadata, AttitudeDetermination, AttitudeDeterminationSensor, AttitudeManeuver, AttitudePhysicalProperties, AttitudeStateHistoryMetadata, CartesianCovariance, CommonPhysicalProperties, Euler, Header, KeplerianElements, Maneuver, Maneuver, Metadata, ObservationsBlock, ODParameters, OemData, OmmTle, OrbitCovarianceHistoryMetadata, OrbitDetermination, OrbitManeuverHistoryMetadata, Perturbations, RTNCovariance, SigmaEigenvectorsCovariance, SpacecraftParameters, SpinStabilized, StateVector, StateVector, TrajectoryStateHistoryMetadata, UserDefined, XYZCovariance

public class CommentsContainer
extends Object
implements Section

用于各种CCSDS消息中的评论容器。

CCSDS文件仅在各个部分的开头接受评论。一旦开始头部/元数据/数据内容，相应部分中的评论将被拒绝。

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor and Description
CommentsContainer() 创建新的元数据。

Method Summary

Modifier and Type	Method and Description
boolean	acceptComments() 检查容器是否仍在接受评论。
boolean	addComment(String comment) 添加评论。
void	checkAllowed(double version, Object field, String key, double minVersion, double maxVersion) 如果键不允许，则抱怨。
void	checkNotNaN(double field, String key) 如果字段为NaN，则抱怨。
void	checkNotNegative(int field, String key) 如果字段为负数，则抱怨。
void	checkNotNull(Object field, String key) 如果字段为null，则抱怨。
List<String>	getComments() 获取评论。
void	refuseFurtherComments() 设置标志以拒绝进一步的评论。
void	validate(double version) 检查是否所有必填条目都已初始化。

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentsContainer

public CommentsContainer()

创建新的元数据。

Method Detail

checkNotNegative

public void checkNotNegative(int field,
                             String key)

如果字段为负数，则抱怨。

参数：

field - 要检查的字段

key - 与字段关联的键

checkNotNaN

public void checkNotNaN(double field,
                        String key)

如果字段为NaN，则抱怨。

参数：

field - 要检查的字段

key - 与字段关联的键

checkNotNull

public void checkNotNull(Object field,
                         String key)

如果字段为null，则抱怨。

参数：

field - 要检查的字段

key - 与字段关联的键

checkAllowed

public void checkAllowed(double version,
                         Object field,
                         String key,
                         double minVersion,
                         double maxVersion)

如果键不允许，则抱怨。

参数：

version - 格式版本

field - 要检查的字段

key - 与字段关联的键

minVersion - 允许开始使用键的版本

maxVersion - 禁止使用键的版本

validate

public void validate(double version)

检查是否所有必填条目都已初始化。

如果缺少一些必填条目或与版本号不兼容，则此方法应引发异常。

由以下指定：

validate 在接口 Section

参数：

version - 格式版本

getComments

public List<String> getComments()

获取评论。

返回：

评论

acceptComments

public boolean acceptComments()

检查容器是否仍在接受评论。

仍接受评论的容器不包含任何其他数据。

返回：

如果容器仍在接受评论，则为true

refuseFurtherComments

public void refuseFurtherComments()

设置标志以拒绝进一步的评论。

addComment

public boolean addComment(String comment)

添加评论。

仅在开头接受评论。一旦在同一部分中存储了其他内容，评论将被拒绝。

参数：

comment - 评论行

返回：

如果评论被接受，则为true