WsfBMAssignmentStatusMessage

WsfBMAssignmentStatusMessage inherits WsfMessage

Construction: WsfBMAssignmentStatusMessage newObj = WsfBMAssignmentStatusMessage();

Clone: WsfBMAssignmentStatusMessage newObj = WsfBMAssignmentStatusMessage(other);

WsfBMAssignmentStatusMessage is the script interface for the battle manager’s assignment status messages. Any assignment status reporting coming into or out of the battle manager will be through this structure.

Methods

void SetAckTime(double assignment_status_sim_time_seconds)

Sets the simulation time of the assignment status in seconds.

double GetAckTime()

Returns the simulation time of the assignment status in seconds.

void SetTrackID(int reporting_platform_idx, int tan)

Sets the track for the assignment.

Parameters

int reporting_platform_idx: Reporting Platform Index.

int tan: Track number.

void SetTrackID(WsfTrackId track_id)

Sets the track for the assignment.

int GetTrackingSystemID()

Gets the reporting_platform_idx set within the [SetTrackID]{#SetTrackID} call.

int GetTrackID()

Gets the tan set within the [SetTrackID]{#SetTrackID} call.

WsfTrackId GetTrackID()

Gets the tan set within the [SetTrackID]{#SetTrackID} call.

void SetAssignedID(int assigned_platform_id, int assigned_weapon_index)

Sets the assigned weapon from the assignment message.

Parameters

int assigned_platform_id: Platform id of the assigned asset.

int weapon_idx: Weapon index(0-based) of the WsfWeapon on the reported platform for this assignment.

int GetAssignedUnitID()

Returns the Platform id of the assigned asset from the call to SetAssignedID.

int GetAssignedWeaponID()

Returns the Weapon index(0-based) of the WsfWeapon on the reported platform for the assignment.

void SetInitiatingID(int assignment_initiator_platform_id)

Sets the platform id of the initiator of the assignment message. In the case of a delegate assignment, this will be the original assigning platform id.

int GetInitiatingUnitID()

Returns the platform id of the assignment initiator. In the case of a delegate assignment, this will be the original assigning platform id.

void SetAssigningID(int assigning_platform_id)

Sets the platform id of the assigning platform id from the assignment. For commit(non-delegate) assignments, this will be the same as the initiating platform id.

int GetAssigningUnitID()

Returns the platform id of the assigning platform id from the assignment. For commit(non-delegate) assignments, this will be the same as the initiating platform id.

void SetAssignmentStatusUnacknowledged()

Sets the assignment status to Unacknowledged.

void SetAssignmentStatusWilco()

Sets the assignment status to Will Comply.

void SetAssignmentStatusCommitted()

Sets the assignment status to Committed.

void SetAssignmentStatusCueTAR()

Sets the assignment status to TAR Cued.

void SetAssignmentStatusCueTTR()

Sets the assignment status to TTR Cued.

void SetAssignmentStatusTARSearching()

Sets the assignment status to TAR Searching.

void SetAssignmentStatusTTRSearching()

Sets the assignment status to TTR Searching.

void SetAssignmentStatusTARTracking()

Sets the assignment status to TAR Tracking.

void SetAssignmentStatusTTRTracking()

Sets the assignment status to TTR Tracking.

void SetAssignmentStatusFiring()

Sets the assignment status to weapon firing.

void SetAssignmentStatusMiss()

Sets the assignment status to weapon missed.

void SetAssignmentStatusChangedAssignedUnit()

Sets the assignment status to notify that a lower level C^2 overrode the assigned weapon.

void SetAssignmentStatusKill()

Sets the assignment status to target killed.

void SetAssignmentStatusCancelled()

Sets the assignment status to cancelled acknowledged.

void SetAssignmentStatusHavecoSuccess()

Sets the assignment status to Have-Complied(Success).

void SetAssignmentStatusHavecoFailure()

Sets the assignment status to Have-Complied(Failed).

void SetAssignmentStatusCantco()

Sets the assignment status to Cannot Comply.

bool IsAssignmentStatusUnacknowledged()

Returns true if the assignment status is Unacknowledged, otherwise false.

bool IsAssignmentStatusWilco()

Returns true if the assignment status is Will Comply, otherwise false.

bool IsAssignmentStatusCommitted()

Returns true if the assignment status is Committed, otherwise false.

bool IsAssignmentStatusCueTAR()

Returns true if the assignment status is TAR Cued, otherwise false.

bool IsAssignmentStatusCueTTR()

Returns true if the assignment status is TTR Cued, otherwise false.

bool IsAssignmentStatusTARSearching()

Returns true if the assignment status is TAR Searching, otherwise false.

bool IsAssignmentStatusTTRSearching()

Returns true if the assignment status is TTR Searching, otherwise false.

bool IsAssignmentStatusTARTracking()

Returns true if the assignment status is TAR Tracking, otherwise false.

bool IsAssignmentStatusTTRTracking()

Returns true if the assignment status is TTR Tracking, otherwise false.

bool IsAssignmentStatusFiring()

Returns true if the assignment status is Weapon Firing, otherwise false.

bool IsAssignmentStatusMiss()

Returns true if the assignment status is Weapon Missed, otherwise false.

bool IsAssignmentStatusChangedAssignedUnit()

Returns true if the assignment status is Weapon Assignment overridden, otherwise false.

bool IsAssignmentStatusKill()

Returns true if the assignment status is Target Killed, otherwise false.

bool IsAssignmentStatusCancelled()

Returns true if the assignment status is cancel acknowledge, otherwise false.

bool IsAssignmentStatusHavecoSuccess()

Returns true if the assignment status is Have Complied(Success), otherwise false.

bool IsAssignmentStatusHavecoFailure()

Returns true if the assignment status is Have Complied(Failed), otherwise false.

bool IsAssignmentStatusCantco()

Returns true if the assignment status is Cannot Comply, otherwise false.

void SetSalvosFired(int salvos_fired)

Sets the number of salvos the weapon has fired at the assigned track.

int GetSalvosFired()

Returns the number of salvos the weapon has fired at the assigned track.

void SetCantcoReason(string cantco_reason)

Sets the CANTCO reason if the assignment status is CANTCO(Cannot Comply). The string is free-form and used for debugging/logging.

string GetCantcoReason()

Returns the CANTCO reason in string format for logging/debug purposes.

void SetSystemicCantcoGlobal()

Sets the CANTCO to a global systemic CANTCO. This will cause the weapon to be removed from further consideration for assignment for all threats.

void SetSystemicCantcoLocal()

Sets the CANTCO to a local systemic CANTCO. This will cause the weapon to be removed from further consideration for assignment for the assignment track but will be available for other tracks.

bool IsSystemicCantcoGlobal()

Returns true if the assignment status is a global systemic CANTCO.

bool IsSystemicCantcoLocal()

Returns true if the assignment status is a local systemic CANTCO.

void SetOverridingID(int overridding_platform_id)

If the assignment status is marked as overridden(via IsAssignmentStatusChangedAssignedUnit, then this sets the simulation platform index of the overriding C^2 platform.

int GetOverridingUnitID()

If the assignment status is marked as overridden(via IsAssignmentStatusChangedAssignedUnit, then this returns the simulation platform index of the overriding C^2 platform.

void SetNewlyAssignedID(int assigned_platform_id, int assigned_weapon_index)

Sets the newly assigned weapon for the assignment override.

Parameters

int assigned_platform_id: Platform id of the assigned asset.

int weapon_idx: Weapon index(0-based) of the WsfWeapon on the reported platform for this assignment.

int GetNewlyAssignedUnitID()

Returns the Platform id of the new assigned platform for the assignment override.

int GetAssignedWeaponID()

Returns the Weapon index(0-based) of the WsfWeapon on the new assigned weapon for the assignment override.

void Print()

Logs the assignment status message to the log output stream.