Click or drag to resize

StkAttitudeFile Class

Reads from and writes to STK attitude (.a) files. STK attitude files can express orientation and angular velocity, and are useful for getting this type of data into and out of STK.

To read an STK attitude file, call the ReadFrom(String) method to read the data into memory, and then call the CreateAxes method to create a time-varying Axes representing the attitude data in the file.

You can also build an StkAttitudeFile instance by calling the various Configure... methods such as ConfigureFromAxesInterpolator(AxesInterpolator). Once you've built an appropriate StkAttitudeFile instance, you can save it to a file or another stream by calling WriteTo(TextWriter).

Inheritance Hierarchy
SystemObject
  AGI.Foundation.StkStkAttitudeFile

Namespace:  AGI.Foundation.Stk
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class StkAttitudeFile

The StkAttitudeFile type exposes the following members.

Constructors
  NameDescription
Public methodStkAttitudeFile
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyData
Gets or sets the attitude data.
Public propertyProperties
Gets a dictionary of key and value pairs in the STK attitude file.
Public propertyPropertiesWithUnsupportedValues
Gets a dictionary of property names and values for the properties with values specified in the file that are not supported by the StkAttitudeFile reader. Any information contained in these properties may not be captured by the reader.
Public propertyUnsupportedProperties
Gets a dictionary of property names and values for the properties that are contained in the file but that are not supported by the StkAttitudeFile reader. Any information contained in these properties may not be captured by the reader.
Public propertyVersion
Gets or sets the attitude file version.
Top
Methods
  NameDescription
Public methodConfigureFromAxes
Configures this instance with values computed by sampling an Axes over an interval with a fixed step. The Data property is replaced with a new instance of StkAttitudeFileAttitudeTimeQuaternions, or StkAttitudeFileAttitudeTimeQuatAngVels (depending on the value of the order property) and any existing information stored in that instance is lost. The Properties are not modified, but values pulled from Axes will take precedence over values in the Properties collection when writing this instance using WriteTo(TextWriter). The Interpolator property is not configured, so you may want to call ConfigureInterpolation(InterpolationAlgorithm, Int32) after calling this method.
Public methodConfigureFromAxesInterpolator
Configures the instance to represent the attitude and interpolation stored in an AxesInterpolator. The Data property is replaced with a new instance of StkAttitudeFileAttitudeTimeQuaternions, or StkAttitudeFileAttitudeTimeQuatAngVels (depending on the number of derivatives available from the AxesInterpolator) and any existing information stored in that instance is lost. The Properties are not modified, but values pulled from AxesInterpolator will take precedence over values in the Properties collection when writing this instance using WriteTo(TextWriter).
Public methodConfigureInterpolation
Configures the Interpolator to use the specified interpolation algorithm and polynomial degree. The Data property must be set before calling this method.
Public methodCreateAxes
Creates an Axes whose time-varying orientation is computed by interpolating over the attitude data held by this instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberReadFrom(TextReader)
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 of the documentation of ReadFrom(TextReader, StkAttitudeFileOptions) for detailed information.
Public methodStatic memberReadFrom(String)
Reads an STK attitude (.a) file from a specified file. See the Remarks section of the documentation of ReadFrom(TextReader, StkAttitudeFileOptions) for detailed information.
Public methodStatic memberReadFrom(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.
Public methodStatic memberReadFrom(String, StkAttitudeFileOptions)
Reads an STK attitude (.a) file from a specified file. See the Remarks section of the documentation of ReadFrom(TextReader, StkAttitudeFileOptions) for detailed information.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteTo(TextWriter)
Writes this instance to a TextWriter in the STK attitude file (.a) format. The TextWriter can be a StreamWriter for writing to a file, a StringWriter for writing to a string, or any number of other types.
Public methodWriteTo(TextWriter, Boolean)
Writes this instance to a TextWriter in the STK attitude file (.a) format. The TextWriter can be a StreamWriter for writing to a file, a StringWriter for writing to a string, or any number of other types.
Top
See Also