Command Class

Customize MACE to meet your Live-Virtual-Constructive Simulation and Training Requirements.

[This is preliminary documentation and is subject to change.]

Provides a default implementation for the base class of all MACE commands.

Inheritance Hierarchy

SystemObject
BSI.MACE.AI.CommandsCommand

Namespace: BSI.MACE.AI.Commands
Assembly: BSILib (in BSILib.dll) Version: 1.2.1.22047 (1.0.0.0)

Syntax

public abstract class Command : ICommand

Public MustInherit Class Command
	Implements ICommand

The Command type exposes the following members.

Constructors

	Name	Description
	Command	General use of default constructor

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 platform that issued 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	Gets or sets operation guidelines for command execution.
	ID	Gets the ID of this command instance.
	Name	The text-based name of the command
	Ownship	The object responsible for executing the 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).
	Dispose	Method called by the system to allow cleanup of references and resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	Called periodically to support the execution of the command
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Called by this command while State = ICommand.StateEnum.Pending.
	Initialize(IPhysicalEntity)	Called by the system to initialize this command or pass it to subordinate entities
	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.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Save	Save the command data to an xml file.
	Terminate	Stops execution of the command and removes from the Ownship's command list.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Fields

	Name	Description
	_category	An optionally assigned category string.
	_description	The text-based description for the command.
	_name	Name of this command.
	_properties	Property form for this command.
	_state	State of operation of this command.
	_type	Type of command such as orders or actions where each has different lifetimes.
	_updateCheck	Object to check if time to process the command has passed.

Remarks

This class cannot be instantiated directly.