StkAttitudeFileReadFrom Method (TextReader, StkAttitudeFileOptions) |
Reads an STK attitude (.a) file from a
TextReader. The
TextReader can be a
StreamReader for reading
from a file, a
StringReader for reading from a string,
or any number of other types. See the
Remarks section for more information.
Namespace:
AGI.Foundation.Stk
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static StkAttitudeFile ReadFrom(
TextReader reader,
StkAttitudeFileOptions readOptions
)
Public Shared Function ReadFrom (
reader As TextReader,
readOptions As StkAttitudeFileOptions
) As StkAttitudeFile
public:
static StkAttitudeFile^ ReadFrom(
TextReader^ reader,
StkAttitudeFileOptions^ readOptions
)
static member ReadFrom :
reader : TextReader *
readOptions : StkAttitudeFileOptions -> StkAttitudeFile
Parameters
- reader
- Type: System.IOTextReader
The reader from which to read the attitude. - readOptions
- Type: AGI.Foundation.StkStkAttitudeFileOptions
An object containing any additional instructions for the read process.
Return Value
Type:
StkAttitudeFileAn
StkAttitudeFile instance containing the read attitude file.
Exceptions Remarks
The STK attitude file format is a mix of well-defined, unambiguous properties, and fairly STK-specific properties
that are difficult to interpret outside of the context of STK. For example, the "CoordinateAxes"
property can specify any coordinate axes that is known to STK's Vector Geometry Tool in the current
scenario. In the general case, it's impossible to determine from the attitude file itself, in the absence
of an STK scenario, what that coordinate axes actually means. As a result, this method should be considered
a "best effort" that works well in most common cases, but that may have problems with certain attitude files.
By default, when this method does not understand a property or property value read from the file, it will
throw an InvalidDataException describing the problem. You can attempt to read files with
unsupported properties or property values setting the IgnoreUnsupportedProperties
and IgnorePropertiesWithUnsupportedValues properties of the
StkAttitudeFileOptions passed to this method to .
With these properties set, unsupported properties and property values will be added to the
UnsupportedProperties and PropertiesWithUnsupportedValues dictionaries, respectively,
and the reader can make no guarantees that its results will match STK.
Here are the known limitations, compared to STK, when reading an attitude file using this method:
-
Only the following properties are supported: BlockingFactor (ignored), InterpolationOrder,
InterpolationMethod, NumberOfAttitudePoints, AttitudeDeviations (ignored),
ScenarioEpoch, CentralBody, CoordinateAxesEpoch,
CoordinateAxes, TimeFormat.
-
Only the following CentralBody values are supported: Earth,
Sun, Moon.
-
When the CentralBody is Earth, only the following CoordinateAxes
values are supported: ICRF, J2000, Inertial, Fixed,
TrueOfDate, TrueOfEpoch, MeanOfDate, MeanOfEpoch,
TEMEOfDate, TEMEOfEpoch.
-
When the CentralBody is Sun or Moon, only the following
CoordinateAxes values are supported: Inertial, Fixed.
-
Only the following InterpolationMethod values are supported: Lagrange,
Hermite.
-
Only the following TimeFormat value is supported: EpSec.
-
Only the following AttitudeDeviations value is supported: Rapid. In addition,
this property will NOT automatically affect access computations as it will in STK.
-
Only the following attitude formats are supported: AttitudeTimeQuaternions, AttitudeTimeQuatScalarFirst,
AttitudeTimeQuatAngVels.
See Also