Click or drag to resize

IEquipmentWeapon Interface

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

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

Establishes the base interface for all equipment maintained on MACE Platform's (via IPlatform)

Namespace:  BSI.MACE
Assembly:  BSILib (in BSILib.dll) Version: 1.2.1.22047 (1.0.0.0)
Syntax
public interface IEquipmentWeapon : IEquipment

The IEquipmentWeapon type exposes the following members.

Properties
  NameDescription
Public propertyCapability
Maintains a bit-mask representing the core capabilities directly supported by this piece of equipment.
(Inherited from IEquipment.)
Public propertyDoesProhibitUserRemoval
True if this device cannot be removed by the user via the equipment form.
(Inherited from IEquipment.)
Public propertyIsAutoControl
Will automatically execute if true.
(Inherited from IEquipment.)
Public propertyIsEnabled
Gets or sets the processing state of the equipment. If set to false no processing will occur or targets generated.
(Inherited from IEquipment.)
Public propertyIsServer
Gets or sets true if this equipment is processed in this instance of MACE or false if it is controlled externally.
(Inherited from IEquipment.)
Public propertyLocation_m
Defines the position offset of this piece of equipment relative to platform's center of gravity.
(Inherited from IEquipment.)
Public propertyMaxAltitudeAGL_m
The maximum AGL altitude in meters that this weapon system can support for a target solution.
Public propertyMaxRange_m
The maximum range in meters that this weapon system can support for a target solution.
Public propertyMaxTOF_s
The maximum Time Of Flight in seconds for this weapon.
Public propertyMinAltitudeAGL_m
The minimum AGL altitude in meters that this weapon system can support for a target solution.
Public propertyMinFiringSolution
Gets or sets the minimum firing solution quality to shoot.
Public propertyMinRange_m
The minimum range in meters that this weapon system can support for a target solution.
Public propertyMountedMunitionsCount
Indicates the number of munitions available to be immediately fired (per RateOfFire) by this weapon system.
Public propertyMunitionStoresCount
Returns the available munitions for this weapon system not currently loaded by this weapon system. The RateOfReload attribute provides the time it would take to reload this weapon system before the munitions could be fired.
Public propertyName
The text-based name of the equipment
(Inherited from IEquipment.)
Public propertyOrientation_deg
Defines the roll, pitch, and yaw of this piece of equipment in world coordinates.
(Inherited from IEquipment.)
Public propertyOwnship
Returns the platform (IPlatform) that contains this equipment.
(Inherited from IEquipment.)
Public propertyProperties
Gets the properties dialog for this equipment, if any.
(Inherited from IEquipment.)
Public propertyRefreshTime_s
Defines the desired time period for this command to be executed in seconds
(Inherited from IEquipment.)
Public propertyRoundsPerTarget
Gets or sets the number of rounds that can be allocated per target.
Public propertySalvoInterval_seconds
Indicates the duration of time before the weapon can fire again in seconds.
Public propertyStatus
Gets or sets the current text status of the equipment.
(Inherited from IEquipment.)
Public propertyWeaponSystemID
Gets or sets the identifier of the group or weapons system, if any, that this equipment belongs to.
(Inherited from IEquipment.)
Top
Methods
  NameDescription
Public methodCalculateTimeInWEZ
Calculates the time (in seconds) remaining, time to enter (negative time), or non-convergent (Double.MinValue) to the Weapon Engaement Zone.
Public methodCreateWeapon
Create a weapon instance entity.
Public methodDispose
Called by the system when this object is about to be deleted.
(Inherited from IEquipment.)
Public methodEstimatedTOF
Returns the estimated time of flight for the weapon to reach the target.
Public methodFire
Fire the weapon at the target. If no weaponEntity is specified one is created.
Public methodGetInterfaceT
Gets an interface from the equipment to support specific functionality (if it exits) or returns Nothing. Usage ex: GetInterface(Of ITrackingSensor)()
(Inherited from IEquipment.)
Public methodGetWeaponEngagementZones
Get the weapon engagement zone for this weapon fired from the shooter against the target.
Public methodInitialize
Called by the system. Prepares the equipment for execution.
(Inherited from IEquipment.)
Public methodIsLaunchPermissible
Determines if this weapon is ready for launch.
Public methodLoad
Load the equipment data from file.
(Inherited from IEquipment.)
Public methodProcess
Called at regular intervals to allow the equipment to perform any pertinent processing.
(Inherited from IEquipment.)
Public methodSave
Save the equipment data to an xml file.
(Inherited from IEquipment.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetGuidanceList
Extension to return a list of guidance systems for the weapon.
(Defined by Extensions.)
Top
Remarks
See Also