Click or drag to resize

StkSatelliteDatabaseQuery Class

A query to be run against a StkSatelliteDatabase.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.StkStkSatelliteDatabaseQuery

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 StkSatelliteDatabaseQuery

The StkSatelliteDatabaseQuery type exposes the following members.

Constructors
  NameDescription
Public methodStkSatelliteDatabaseQuery
Initializes a new instance of the StkSatelliteDatabaseQuery class
Top
Properties
  NameDescription
Public propertyActive
Gets or sets the value of Active that is required in order for the entry to be included in the query.
Public propertyCommonName
Gets or sets a regular expression that the CommonName must match in order to be included in the query.
Public propertyInternationalDesignator
Gets or sets a regular expression that the InternationalDesignator must match in order to be included in the query.
Public propertyMaximumApogee
Gets or sets the maximum value of Apogee that is allowed in order for the entry to be included in the query.
Public propertyMaximumInclination
Gets or sets the maximum value of Inclination that is allowed in order for the entry to be included in the query.
Public propertyMaximumPerigee
Gets or sets the maximum value of Perigee that is allowed in order for the entry to be included in the query.
Public propertyMaximumPeriod
Gets or sets the maximum value of Period that is allowed in order for the entry to be included in the query.
Public propertyMinimumApogee
Gets or sets the minimum value of Apogee that is allowed in order for the entry to be included in the query.
Public propertyMinimumInclination
Gets or sets the minimum value of Inclination that is allowed in order for the entry to be included in the query.
Public propertyMinimumPerigee
Gets or sets the minimum value of Perigee that is allowed in order for the entry to be included in the query.
Public propertyMinimumPeriod
Gets or sets the minimum value of Period that is allowed in order for the entry to be included in the query.
Public propertyMission
Gets or sets a regular expression that the Mission must match in order to be included in the query.
Public propertyOfficialName
Gets or sets a regular expression that the OfficialName must match in order to be included in the query.
Public propertyOwner
Gets or sets a regular expression that the Owner must match in order to be included in the query.
Public propertySatelliteNumber
Gets or sets a regular expression that the SatelliteNumber must match in order to be included in the query.
Top
Methods
  NameDescription
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.)
Public methodMatches
Determines if an entry matches this query.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Examples

The following example shows how to query the satellite database for satellites matching certain criteria:

C#
StkSatelliteDatabase db = new StkSatelliteDatabase(dbDirectory, "stkSatDb");

// Create a query object and then populate it with the properties to query on.
// Regular expressions are used to query on strings.
StkSatelliteDatabaseQuery query = new StkSatelliteDatabaseQuery
{
    CommonName = new Regex("QUICK"),
    MinimumApogee = 200000.0,
};

// Get the database entries matching the query and print out the SSC number of each.
foreach (StkSatelliteDatabaseEntry entry in db.GetEntries(query))
{
    Console.WriteLine(entry.SatelliteNumber);
}
See Also