IPhysicalEntity Interface

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

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

Represents the common interface for Physical Entities represented within MACE.

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

Syntax

Copy

public interface IPhysicalEntity : ICommandProcessor, 
	INotifyPropertyChanged

Public Interface IPhysicalEntity
	Inherits ICommandProcessor, INotifyPropertyChanged

The IPhysicalEntity type exposes the following members.

Properties

	Name	Description
	AltitudeAGL_m	Altitude in meters above ground level.
	AltitudeMSL_m	Altitude in meters above sea level.
	AngularVelocity_radps	6-DOF Angular Velocity values for the entity as used in DIS Entity State Dead Reckoning. Referenced in Body Axis in radians per second.
	AntennaHeight_m	Returns the height of the platform's antenna in meters.
	Appearance	Represents the 64-bit DIS appearance flags
	Commands	Gets a list of orders. (Inherited from ICommandProcessor.)
	CommLinks	Returns all of the available communication links for the platform.
	CommLinksICommLinkRelationshipEnum	Returns all of the type specific communication links for a platform.
	Doctrine	Defines the general doctrine settings that this platform is expected to operate within.
	Domain	Indicates type of environment entity operates in.
	EntityType	Specifies the entity type base on the DIS entity type representation
	EquipmentList	Returns the list of available equipment for this platform.
	HasPushed	Indication of whether the platorm has pushed and started its mission.
	Heading_deg	Heading in degrees, true north.
	Health
	Height_m	Returns the physical height of the entity in meters.
	ID	Unique ID for the Platform.
	ImageURL	Returns a string to an (optional) image file for this platform.
	IsActive	Returns if this entity is active in the simulation.
	IsConcealed	Indicates if the entity is concealed
	IsInternalEntity	Returns true if this entity is generated internally by this MACE instance. False indicates the entity is generated by other simulation software and passed to MACE.
	IsKilled	Get/Sets the entities killed state.
	IsMobilityKilled	Indicates if the platform's mobility has been disabled.
	IsOnGround	Indication of whether the Platform is on the ground or not.
	IsPowered	Indicates that the platform has engines running.
	IsRoofClamping
	IsVisible	Indicates if the entity is considered to be visible
	IsWeaponsKilled	Indicates if the platform's weapons have been disabled.
	Label	User defined label for the entity
	LinearAcceleration_mps2	6-DOF Linear Accelerations values for the entity as used in DIS Entity State Dead Reckoning. Referenced as North/East/Down in meters per second.
	LinearVelocity_mps	6-DOF Linear Velocity values for the entity as used in DIS Entity State Dead Reckoning. Referenced as North/East/Down in meters per second.
	MaximumEngagementSlantRange_m	The maximum slant range in meters this entity will engage a target.
	Name	The platform's name (or callsign).
	Orientation_deg	Platforms orientation in degrees
	Position	Indicates the Platform's current position.
	Proficiency	Indicates the proficiency for the entity or operator of a platform.
	Radius_m	Returns the physical radius of the entity in meters.
	Speed_mps	Speed in meters per second.
	TeamAffiliation	Indicates the platforms team
	TimeLastSeen	Time last seen (position updated).
	TrackProcessor	Returns the Track Processor responsible for fusing track sources.
	Waypoints	Returns the list of waypoints currently assigned to this entity.

Top

Methods

	Name	Description
	AddCommand	Submit a command (order) to be executed (Inherited from ICommandProcessor.)
	GetRCS_sqm	Gets the average RADAR Cross-Section (RCS) in square meters.
	GetRCS_sqm(Double, Double)	Gets the RADAR Cross-Section (RCS) in square meters given the incident angles.
	Process	Called at regular intervals to allow the Platform to perform any pertinent processing.
	RemoveAllCommands	Removes all commands currently awaiting execution. (Inherited from ICommandProcessor.)
	RemoveCommand	Removes/Revokes a command (order) (Inherited from ICommandProcessor.)

Top

Events

	Name	Description
	PropertyChanged	Occurs when a property value changes. (Inherited from INotifyPropertyChanged.)

Top

Extension Methods

	Name	Description
	GetEquipmentList(CapabilityEnum, ListIEquipment)	Overloaded. Extension method that searchs the entity and gets, or adds to, a list with equipment that have the specfied capabilities. (Defined by Extensions.)
	GetEquipmentListT(ListT)	Overloaded. Extension method that searchs the entity for a specific type and gets or add to a list of that type. (Defined by Extensions.)
	GetEquipmentTree(CapabilityEnum, ListIEquipment)	Overloaded. Extension method that recursively searchs the entity and entire comm linked tree for a specific type and gets or add to a list of that type. (Defined by Extensions.)
	GetEquipmentTreeT(ListT)	Overloaded. Extension method that recursively searchs the entity and entire comm linked tree for a specific type and gets or add to a list of that type. (Defined by Extensions.)
	GetRangeAngle	Extension to find the range (in meters) and angle (in degrees) to the target entity. (Defined by Extensions.)
	IsRadiating(DeviceTypeBit)	Overloaded. Extension method that searchs the entity for equipment of the specified capability that is enabled. (Defined by Extensions.)
	IsRadiating(CapabilityEnum)	Overloaded. Extension method that searchs the entity for equipment of the specified capability that is enabled. (Defined by Extensions.)
	MaxRadarRange_m	Extension method that returns the maximum radar range for this entity based on the equipment on this platform. (Defined by Extensions.)
	RadarTrackStatusString	(Defined by Extensions.)
	SetEquipmentAutoControl	Will enable/disable an entities set of equipment's AutoControl state as specified by the capabilities enum. If an equipment's AutoControl state is true, the equipment will typically be updated by the MACE AI (via commands), if false, the equipment should not be updated by the MACE AI. Setting the AutoControl state to false will turn off any active equipment (set all enable flags to false). (Defined by Extensions.)

Top

Remarks

The current naming for this interface is borrowed from the HLA RPR FOM to not conflict with existing naming conventions within MACE and with the expectation that we'll likely need to evolve to a base interface such as IBaseEntity and specialized derived interfaces (such as IPlatform, ILifeform etc)

Reference

BSI.MACE Namespace