Set the long or short description of a scenario or object
SetDescription <ObjectPath> {Type} [{Option}] "<Description>"
The SetDescription command allows you to associate a short or long description with a scenario or object within a scenario. The description can be used to provide background information about an object or to log additional information about an object. {Type} can be Long or Short.
The characters \n and \t can be used in the Long Description and will be translated to a newline and tab, respectively. Alternatively, to set a multi-line Long Description enter each line as a separate quoted string. See example below.
If the description {Type} is Long, then the following {Option} can be used:
| {Option} | Description |
|---|---|
| Extend | If this option is used then the "<Description>" will be appended to the existing Long Description. |
| File | If this option is used then the "<Description>" must be a filename. The Long Description will be set to the data in the file. |
To set the short description of the WhiteSands facility so that it is identified as a missile test range for future reference:
SetDescription */Facility/WhiteSands Short "Missile Test Range"
To add a short description to the current scenario:
SetDescription * Short "Can a Molniya satellite spy on Washington, D.C.?"
To add a 3-line Long description to the TestSat satellite using separate quoted strings for each line:
SetDescription */Satellite/TestSat Long "SSC Number 22014" "Name TestSat" "Owner USA"
To create a 3-line Long description with the second and third lines indented by one tab:
SetDescription */Satellite/TestSat Long "SSC Number 22014\n\tName TestSat\n\tOwner USA"
To add more information to a Long description:
SetDescription */Satellite/TestSat Long Extend "Some additional info for this satellite."
To Set a long description for TestSat, using data read from a file:
SetDescription */Satellite/TestSat Long File "c:\mytemp\bug13395.txt"
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
6.2
STK Programming Interface 11.0.1