Collection
Create and set the features of a Satellite Collection object.
Syntax
Collection <objPath> {Define|Interval|Metadata|Promote|Reference|Subset} <Parameters>
Description
The Collection Connect command enables you to create a Satellite Collection object and set its features. The command has six unique action options (Define|Interval|Metadata|Promote|Reference|Subset) associated with it. For a description of the Define action option for creating a satellite collection, see Collection Define. This topic page provides descriptions and examples of the other five action options that set the features of an existing satellite collection.
Interval
The Interval action option has the following format:
Interval <value1> [<value2>]
It sets the analysis interval for the satellite collection. You can use <value1> as a start time (in Connect units), a Time Instant time component, or a Time Interval time component. If <value1> is not a Time Interval Component, then <value2> is the stop time (in Connect units), a Time Instant time component, or a duration represented as a time increment.
Metadata
The Metadata action option has the following format:
Metadata {[Specify <"filename"> | CreateEmptyFile <"filename"> | Remove | Reload]}
The following table describes the Metadata optional parameters:
| Optional Parameters | Description |
|---|---|
| Specify <"filename"> | This sets the supplemental metadata file and reads the data into the satellite collection. |
| CreateEmptyFile <"filename"> | This creates a template metadata file with the specified filename using the current satellite collection entry names. |
| Remove | This removes any supplemental metadata file and its data from use in the satellite collection. |
| Reload | This reloads the data from the currently specified metadata file of the satellite collection. |
Promote
The Promote action option has the following format:
Promote {[Entry <name> | PromotedName <name> | Subset <name> | All]}
The following table describes the Promote optional parameters:
| Optional Parameters | Description |
|---|---|
| Entry <name> | This promotes the specified satellite collection entry as an STK object. It uses <name> as the name unless you use PromotedName to set the name of the promoted object. |
| PromotedName <name> | This sets the name of the promoted object when specifying an entry using Entry. |
| Subset <name> | This promotes all satellite collection entries belonging to the specified Subset as an STK object. The name of each promoted object will be the same as the entry name in the Subset. |
| All | This promotes all satellite collection entries as an STK object. The name of each promoted object will be the same as the entry name in the Subset. CAUTION: The whole point of using a satellite collection is to avoid the creation of individual STK objects. This "All" option is best used when the number of entries in the satellite collection is small, at most a few hundred. |
| CreateConstellation <name> | This promotes a satellite collection subset as an STK Constellation object, with the name you specify. The subset becoming a constellation is identified in the Subset parameter. |
If you provide more than one action (Entry, Subset, All), STK will only act on the last action, unless the last action is All and Subset <name> appears earlier. In that case, STK will act on Subset.
Reference
The Reference action option has the following format:
Reference {[Specify {Default | Subset <"subsetName">} ReferenceObject <"objectPath"> | Remove {Default | Subset <"subsetName">} ]}
The following table describes the Reference optional parameters:
| Optional Parameters | Description |
|---|---|
| Specify Default ReferenceObject <"objectPath"> | This sets the default Reference object. |
| Specify Subset <"subsetName"> ReferenceObject <"objectPath"> | This sets the Reference object for the specified Subset. |
| Remove Default | This removes the default Reference object. |
| Remove Subset <"subsetName"> | This removes the Reference object for the specified Subset. |
Subset
The Subset action option has the following format:
Subset {[ AutoGeneration {Yes|On|True|No|Off|False} | Remove <"subsetName"> | Modify <"subsetName"> (params) | Specify <"subsetName"> (params)]}
The following table describes the Subset optional parameters:
| Optional Parameters | Description |
|---|---|
| Remove <"subsetName"> | This removes the existing specified Subset of the satellite collection. |
| Modify <"subsetName"> {ObjectType <typeName>} | This modifies the Subset of the specified name of the satellite collection. The typeName is Satellite or the class name of a valid subObject for a Satellite. If set, the ObjectType sets the type of object that Subset represents; otherwise, the type will be Satellite. |
| Specify <"subsetName"> {ObjectType <typeName>} | This creates a Subset of the specified name in the satellite collection. The typeName is Satellite or the class name of a valid subObject for a Satellite. If set, the ObjectType sets the type of object that Subset represents; otherwise, the type will be Satellite. |
Examples
Analysis interval sets the interval over which the Satellite Collection is valid
Supplemental Metadata
Reference object association
Subset Creation and Removal; examples assume Walker was used to create entries with "Plane" metadata
Object Promotion
Return message
Group membership
This command belongs to the following group(s):
Version
12.2