 | ICommand Interface |
[This is preliminary documentation and is subject to change.]
Defines the interface for commands to be processed by instantiations of the IPlatform interface
Namespace: BSI.MACE.AI.Commands
Assembly: BSILib (in BSILib.dll) Version: 1.2.1.22047 (1.0.0.0)
SyntaxThe ICommand type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Category |
An optionally assigned category string that can be used primarily by the MACE UI to sort and order the list
of available commands
|
| CommandingEntity |
The object that issues the command
|
| CommandSpace |
Gets the managing object for an area, volume, time or platforms of interest bounding a command.
|
| Description |
The text-based description for the command
|
| Doctrine |
Represents the various Doctrine settings that are to (optionally) be applied while executing this command
|
| ID |
Gets the ID of this command instance.
|
| Name |
The text-based name of the command
|
| Ownship |
The object that is responsible for executing this command
|
| Properties |
Gets the properties dialog for this command (if one is available).
|
| RefreshRate |
Defines the desired execution rate for this command in seconds
|
| State |
Provides the current state of the command
|
| StatusString |
Returns a UI-friendly status string for the command
|
| Type |
Provides an indication that MACE can make this Command available for assignment directly from the MACE UI.
|
Methods| Name | Description | |
|---|---|---|
 | Assign |
Assigns command to the specified entity (and sends it via command link if applicable).
|
| Execute |
Called periodically to support the execution of the command
|
| IsAssignable |
Provides an indication if the specified Platform can be assigned to this Command instance. Some commands are intended for
specific platform types, this method supports that validation.
|
| IsAssigned |
Determines if the command is currently assigned to the specified entity.
|
| Load |
Load the command data from file.
|
| Save |
Save the command data to an xml file.
|
| Terminate |
Stops execution of the command and removes from the Ownship's command list.
|
RemarksSee Also