Description | Example | Return Message | Group

Unload

Remove an object or scenario

Syntax

Unload <ApplicationPath> <ObjectPath> [RemAssignedObjs]

Related Commands

Description

The Unload command removes the specified object and all of its subobjects (e.g., sensors) from the scenario. The object file isn't deleted from the system, however. To delete a file from the system, use commands native to the operating system on which you're working.

The optional keyword, RemAssignedObjs, is used for Constellations and Chains. If you specify this option, then all objects assigned to the Chain or Constellation will also be unloaded from the Scenario. Please exercise caution when using this option.

Warning: If you use this command to remove an object that is used by more than one chain or constellation, calculations to the other object will be affected.

Note: To remove multiple objects of one class, with one command, use the UnloadMulti command.

Example

To unload the current scenario:

Unload / *

Example

To unload the Chain TestCh, and also unload all of the Chain's assigned objects from the Scenario:

Unload / */Chain/TestCh RemAssignedObjs

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Area Targets

Attitude Coverage

Chains

Comm

CAT

Coverage

Facilities, Places & Targets

Line Targets

MTO

Radar

Scenarios

Sensors

Stars & Planets

Vehicles

Volumetric

Version

4.0

STK Programming Interface 11.0.1