agi.foundation.ccsds

(agi.foundation.models-2024r3.jar)

Class CcsdsOemFileWritingOptions

java.lang.Object

agi.foundation.ccsds.CcsdsOemFileWritingOptions

public class CcsdsOemFileWritingOptions
extends Object

Specifies options for writing a CcsdsOrbitEphemerisMessageFile.

Constructor Summary

Constructors

Constructor and Description
CcsdsOemFileWritingOptions() Initializes a new instance.
CcsdsOemFileWritingOptions(boolean overrideCreationDate, CcsdsOemFileOutputFormat outputFormat) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static CcsdsOemFileWritingOptions	getDefaultOptions() Gets the default instance where OverrideCreationDate (get / set) is set to true and the OutputFormat (get / set) is set to CcsdsOemFileOutputFormat.KVN_FORMAT.
CcsdsOemFileOutputFormat	getOutputFormat() Gets a value indicating whether the OEM file should use the Key-value Notation (KVN) format or one of the extensible markup language (XML) formats.
boolean	getOverrideCreationDate() Gets a value indicating whether the CreationDate (get / set) in the CcsdsOrbitEphemerisMessageFile should be overridden by the current date and time.
void	setOutputFormat(CcsdsOemFileOutputFormat value) Sets a value indicating whether the OEM file should use the Key-value Notation (KVN) format or one of the extensible markup language (XML) formats.
void	setOverrideCreationDate(boolean value) Sets a value indicating whether the CreationDate (get / set) in the CcsdsOrbitEphemerisMessageFile should be overridden by the current date and time.

Methods inherited from class java.lang.Object

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

Constructor Detail

CcsdsOemFileWritingOptions

public CcsdsOemFileWritingOptions()

Initializes a new instance. By default, OverrideCreationDate (get / set) is set to true and the OutputFormat (get / set) is set to CcsdsOemFileOutputFormat.KVN_FORMAT.

CcsdsOemFileWritingOptions

public CcsdsOemFileWritingOptions(boolean overrideCreationDate,
                                  @Nonnull
                                  CcsdsOemFileOutputFormat outputFormat)

Initializes a new instance.

Parameters:

overrideCreationDate - a value indicating whether the CreationDate (get / set) in the CcsdsOrbitEphemerisMessageFile should be overridden by the current date and time.

outputFormat - A value indicating whether the OEM file should use the Key-value Notation (KVN) format or one of the extensible markup language (XML) formats.

Method Detail

getOverrideCreationDate

public final boolean getOverrideCreationDate()

Gets a value indicating whether the CreationDate (get / set) in the CcsdsOrbitEphemerisMessageFile should be overridden by the current date and time.

setOverrideCreationDate

public final void setOverrideCreationDate(boolean value)

Sets a value indicating whether the CreationDate (get / set) in the CcsdsOrbitEphemerisMessageFile should be overridden by the current date and time.

getOutputFormat

@Nonnull
public final CcsdsOemFileOutputFormat getOutputFormat()

Gets a value indicating whether the OEM file should use the Key-value Notation (KVN) format or one of the extensible markup language (XML) formats.

setOutputFormat

public final void setOutputFormat(@Nonnull
                                  CcsdsOemFileOutputFormat value)

Sets a value indicating whether the OEM file should use the Key-value Notation (KVN) format or one of the extensible markup language (XML) formats.

getDefaultOptions

@Nonnull
public static CcsdsOemFileWritingOptions getDefaultOptions()

Gets the default instance where OverrideCreationDate (get / set) is set to true and the OutputFormat (get / set) is set to CcsdsOemFileOutputFormat.KVN_FORMAT.