Click or drag to resize

StkPatternFile Class

Reads from STK custom sensor pattern (.pattern) files. STK pattern files can express a custom sensor pattern for use with a sensor attached to a vehicle, facility, place or target in STK and are useful for getting this type of data into and out of STK.

To read an STK pattern file, call the ReadFrom(String) method to read the data into memory, and then call the CreateCustomSensorPattern method to create a CustomSensorPattern representing the pattern data in the file.

Inheritance Hierarchy
SystemObject
  AGI.Foundation.StkStkPatternFile

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

The StkPatternFile type exposes the following members.

Constructors
  NameDescription
Public methodStkPatternFile
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyData
Gets or sets the pattern data.
Public propertyProperties
Gets a dictionary of key and value pairs in the STK pattern 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 StkPatternFile 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 StkPatternFile reader. Any information contained in these properties may not be captured by the reader.
Public propertyVersion
Gets or sets the pattern file version.
Top
Methods
  NameDescription
Public methodCreateCustomSensorPattern
Creates a CustomSensorPattern from the pattern data held by this instance in radians.
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(String)
Reads an STK pattern (.pattern) file from a specified file. See the Remarks section of the documentation of ReadFrom(TextReader, StkPatternFileOptions) for detailed information.
Public methodStatic memberReadFrom(TextReader)
Reads an STK pattern (.pattern) 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, StkPatternFileOptions) for detailed information.
Public methodStatic memberReadFrom(String, StkPatternFileOptions)
Reads an STK pattern (.pattern) file from a file. See the Remarks section of the documentation of ReadFrom(TextReader, StkPatternFileOptions) for detailed information.
Public methodStatic memberReadFrom(TextReader, StkPatternFileOptions)
Reads an STK pattern (.pattern) 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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteTo
Writes this instance to a TextWriter in the STK pattern file (.pattern) 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