org.jmisb.api.klv.st0601

Class WeaponFired

java.lang.Object

org.jmisb.api.klv.st0601.WeaponFired

All Implemented Interfaces:

IKlvValue, IUasDatalinkValue

public class WeaponFired
extends Object
implements IUasDatalinkValue

Weapon Fired (ST 0601 Item 61).

From ST:

Indication when a particular weapon is released.

Note: the Weapon Stores (Item 140) replaces the Weapon Load (Item 60) and Weapon Fired (Item 61) for providing information about Weapons and their status.

The Weapon Fired metadata item has the same format as the first byte of the Weapon Load metadata item indicating station and substation location of a store. Byte 1 is composed of two nibbles with [nib1] being the most significant nibble with bit order [3210] where 3=msb.

When included in a KLV packet, correlate the Weapon Fired item with the mandatory timestamp to determine the release time of a weapon.

Constructor Summary

Constructors

Constructor and Description
WeaponFired(byte[] bytes) Create from encoded bytes.
WeaponFired(int stationNumber, int substationNumber) Create from value.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Get the encoded bytes.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
int	getStationNumber() Get the store station number.
int	getSubstationNumber() Get the store substation number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeaponFired

public WeaponFired(int stationNumber,
                   int substationNumber)

Create from value.

Parameters:

stationNumber - the station number, in the range 1..15.

substationNumber - the substation number, in the range 0..15

WeaponFired

public WeaponFired(byte[] bytes)

Create from encoded bytes.

Parameters:

bytes - The byte array of length 1

Method Detail

getBytes

public byte[] getBytes()

Description copied from interface: IUasDatalinkValue

Get the encoded bytes.

Specified by:

getBytes in interface IUasDatalinkValue

Returns:

The encoded byte array

getDisplayableValue

public String getDisplayableValue()

Description copied from interface: IKlvValue

Return a string of the displayable value.

Specified by:

getDisplayableValue in interface IKlvValue

Returns:

String representing the value

getDisplayName

public final String getDisplayName()

Description copied from interface: IKlvValue

Get the human-readable name for the value.

Specified by:

getDisplayName in interface IKlvValue

Returns:

The name of the type

getStationNumber

public int getStationNumber()

Get the store station number.

Returns:

integer value, where 1 is the left-most pylon.

getSubstationNumber

public int getSubstationNumber()

Get the store substation number.

Returns:

integer value, in the range [0..15], where 0 means no-substation.