agi.foundation.stk

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

Class StkEphemerisFileOptions

java.lang.Object

agi.foundation.stk.StkEphemerisFileOptions

public class StkEphemerisFileOptions
extends Object

This class contains options for reading and creating an StkEphemerisFile.

Constructor Summary

Constructors

Constructor and Description
StkEphemerisFileOptions() Creates an instance of the class with default read options.

Method Summary

Modifier and Type	Method and Description
CovarianceReadOptions	getCovarianceOptions() Gets the options for reading in the covariance data of an ephemeris file.
boolean	getIgnorePropertiesWithUnsupportedValues() Gets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file if the property has a value that the reader does not understand.
boolean	getIgnoreUnsupportedProperties() Gets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file that it does not understand.
boolean	getOverrideScenarioEpoch() Gets a value indicating whether the ScenarioEpoch (get / set) specified on this instance overrides the one specified in the ephemeris file itself.
JulianDate	getScenarioEpoch() Gets the epoch relative to which all times in the ephemeris file are specified.
void	setCovarianceOptions(CovarianceReadOptions value) Sets the options for reading in the covariance data of an ephemeris file.
void	setIgnorePropertiesWithUnsupportedValues(boolean value) Sets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file if the property has a value that the reader does not understand.
void	setIgnoreUnsupportedProperties(boolean value) Sets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file that it does not understand.
void	setOverrideScenarioEpoch(boolean value) Sets a value indicating whether the ScenarioEpoch (get / set) specified on this instance overrides the one specified in the ephemeris file itself.
void	setScenarioEpoch(JulianDate value) Sets the epoch relative to which all times in the ephemeris file are specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

StkEphemerisFileOptions

public StkEphemerisFileOptions()

Creates an instance of the class with default read options.

Method Detail

getCovarianceOptions

@Nonnull
public final CovarianceReadOptions getCovarianceOptions()

Gets the options for reading in the covariance data of an ephemeris file.

setCovarianceOptions

public final void setCovarianceOptions(@Nonnull
                                       CovarianceReadOptions value)

Sets the options for reading in the covariance data of an ephemeris file.

getIgnoreUnsupportedProperties

public final boolean getIgnoreUnsupportedProperties()

Gets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file that it does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the unsupported property in the UnsupportedProperties (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the ephemeris file. Setting this property to true will also cause the reader to ignore ephemeris blocks in an unsupported format.

setIgnoreUnsupportedProperties

public final void setIgnoreUnsupportedProperties(boolean value)

Sets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file that it does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the unsupported property in the UnsupportedProperties (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the ephemeris file. Setting this property to true will also cause the reader to ignore ephemeris blocks in an unsupported format.

getIgnorePropertiesWithUnsupportedValues

public final boolean getIgnorePropertiesWithUnsupportedValues()

Gets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file if the property has a value that the reader does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the property with the unsupported value in the PropertiesWithUnsupportedValues (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the ephemeris file.

setIgnorePropertiesWithUnsupportedValues

public final void setIgnorePropertiesWithUnsupportedValues(boolean value)

Sets a value indicating whether StkEphemerisFile.readFrom(BufferedReader,StkEphemerisFileOptions) will ignore a property in the ephemeris file if the property has a value that the reader does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the property with the unsupported value in the PropertiesWithUnsupportedValues (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the ephemeris file.

getScenarioEpoch

@Nullable
public final JulianDate getScenarioEpoch()

Gets the epoch relative to which all times in the ephemeris file are specified. This property is only used if OverrideScenarioEpoch (get / set) is true or if the ephemeris file uses the epoch second time format and does not specify a scenario epoch.

setScenarioEpoch

public final void setScenarioEpoch(@Nullable
                                   JulianDate value)

Sets the epoch relative to which all times in the ephemeris file are specified. This property is only used if OverrideScenarioEpoch (get / set) is true or if the ephemeris file uses the epoch second time format and does not specify a scenario epoch.

getOverrideScenarioEpoch

public final boolean getOverrideScenarioEpoch()

Gets a value indicating whether the ScenarioEpoch (get / set) specified on this instance overrides the one specified in the ephemeris file itself. If this property is true, ScenarioEpoch (get / set) must be specified and the times of all ephemeris points will be relative to that epoch. If this property is false, the scenario epoch specified in the ephemeris file itself is used, if available, and the value of the ScenarioEpoch (get / set) is used only if the file uses the epoch second time format and does not specify a scenario epoch.

setOverrideScenarioEpoch

public final void setOverrideScenarioEpoch(boolean value)

Sets a value indicating whether the ScenarioEpoch (get / set) specified on this instance overrides the one specified in the ephemeris file itself. If this property is true, ScenarioEpoch (get / set) must be specified and the times of all ephemeris points will be relative to that epoch. If this property is false, the scenario epoch specified in the ephemeris file itself is used, if available, and the value of the ScenarioEpoch (get / set) is used only if the file uses the epoch second time format and does not specify a scenario epoch.