agi.foundation.stk

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

Class StkAttitudeFileOptions

java.lang.Object

agi.foundation.stk.StkAttitudeFileOptions

public class StkAttitudeFileOptions
extends Object

Specifies options for reading and creating an StkAttitudeFile.

Constructor Summary

Constructors

Constructor and Description
StkAttitudeFileOptions()

Method Summary

Modifier and Type	Method and Description
boolean	getIgnorePropertiesWithUnsupportedValues() Gets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude file if the property has a value that the reader does not understand.
boolean	getIgnoreUnsupportedProperties() Gets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude 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 attitude file itself.
JulianDate	getScenarioEpoch() Gets the epoch relative to which all times in the attitude file are specified.
void	setIgnorePropertiesWithUnsupportedValues(boolean value) Sets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude file if the property has a value that the reader does not understand.
void	setIgnoreUnsupportedProperties(boolean value) Sets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude 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 attitude file itself.
void	setScenarioEpoch(JulianDate value) Sets the epoch relative to which all times in the attitude file are specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

StkAttitudeFileOptions

public StkAttitudeFileOptions()

Method Detail

getIgnoreUnsupportedProperties

public final boolean getIgnoreUnsupportedProperties()

Gets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude 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 attitude file. Setting this property to true will also cause the reader to ignore attitude blocks in an unsupported format.

setIgnoreUnsupportedProperties

public final void setIgnoreUnsupportedProperties(boolean value)

Sets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude 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 attitude file. Setting this property to true will also cause the reader to ignore attitude blocks in an unsupported format.

getIgnorePropertiesWithUnsupportedValues

public final boolean getIgnorePropertiesWithUnsupportedValues()

Gets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude 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 attitude file.

setIgnorePropertiesWithUnsupportedValues

public final void setIgnorePropertiesWithUnsupportedValues(boolean value)

Sets a value indicating whether StkAttitudeFile.readFrom(BufferedReader,StkAttitudeFileOptions) will ignore a property in the attitude 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 attitude file.

getScenarioEpoch

@Nullable
public final JulianDate getScenarioEpoch()

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

setScenarioEpoch

public final void setScenarioEpoch(@Nullable
                                   JulianDate value)

Sets the epoch relative to which all times in the attitude file are specified. This property is only used if OverrideScenarioEpoch (get / set) is true or if the attitude file 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 attitude file itself. If this property is true, ScenarioEpoch (get / set) must be specified and the times of all attitude points will be relative to that epoch. If this property is false, the scenario epoch specified in the attitude file itself is used, if available, and the value of the ScenarioEpoch (get / set) is used only if the file does not specify an 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 attitude file itself. If this property is true, ScenarioEpoch (get / set) must be specified and the times of all attitude points will be relative to that epoch. If this property is false, the scenario epoch specified in the attitude file itself is used, if available, and the value of the ScenarioEpoch (get / set) is used only if the file does not specify an epoch.