org.jmisb.api.klv.st1902

Class MimdId

java.lang.Object

org.jmisb.api.klv.st1902.MimdId

All Implemented Interfaces:

IKlvValue, IMimdMetadataValue

public class MimdId
extends Object
implements IMimdMetadataValue

MIMD Identifier.

The MIMD instance Identifier (mimdId) is a pair of two unsigned integer values that uniquely identifies a specific instance of a class within the MIMD Model.

The first unsigned integer is an instance identifier serial number. The minimum serial number value is one; however, classes may have attributes that reference a serial number set to zero to indicate special meanings (e.g. a MISB ST 1906 Stage class instance uses a parentStage reference of zero to signify the Stage is a root stage).

The second unsigned integer is the group identifier to which the instance belongs. The first group is group zero which is the default group. If an instance belongs to the default group, the mimdId does not need to specify the group’s identity, which saves bandwidth. Systems using more than one group need to add a group identifier to each mimdId when the group is greater than zero.

Together the serial number and group identifier provide a unique identity within the whole MIMD Model instance hierarchy.

When creating class instances the mimdId attribute is optional unless another class instance references it. When a class instance does not have other class instances referencing it there is no need to create a mimdId, thus reducing data bits and saving bandwidth. To allow for packet-to-packet instance correlation (e.g., Report-on-Change), the mimdId remains constant for a class instance from MIMD Packet-to-MIMD Packet for the duration of the MIMD Stream.

Constructor Summary

Constructors

Constructor and Description
MimdId(byte[] data) Create a MimdId from encoded bytes.
MimdId(int serialNumber) Create a MimdId from value using default group identifier.
MimdId(int serialNumber, int groupIdentifier) Create a MimdId from values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static MimdId	fromBytes(byte[] data) Parse a MimdId out of a byte array.
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	getGroupIdentifier() The group identifier for this MimdId.
int	getSerialNumber() The serial number for this MimdId.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MimdId

public MimdId(int serialNumber)

Create a MimdId from value using default group identifier.

Parameters:

serialNumber - the serial number of this MimdId (not zero)

MimdId

public MimdId(int serialNumber,
              int groupIdentifier)

Create a MimdId from values.

Parameters:

serialNumber - the serial number of this MimdId

groupIdentifier - the group identifier for this MimdId

MimdId

public MimdId(byte[] data)
       throws KlvParseException

Create a MimdId from encoded bytes.

Parameters:

data - the byte array to parse the MimdId from.

Throws:

KlvParseException - if the parsing fails

Method Detail

fromBytes

public static MimdId fromBytes(byte[] data)
                        throws KlvParseException

Parse a MimdId out of a byte array.

Parameters:

data - the byte array to parse the MimdId from.

Returns:

MimdId equivalent to the byte array

Throws:

KlvParseException - if the parsing fails

getBytes

public byte[] getBytes()

Description copied from interface: IMimdMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IMimdMetadataValue

Returns:

The encoded byte array

getDisplayName

public 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

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

getSerialNumber

public int getSerialNumber()

The serial number for this MimdId.

Returns:

serial number as an unsigned integer value

getGroupIdentifier

public int getGroupIdentifier()

The group identifier for this MimdId.

Group identifier 0 is the default group.

Returns:

group identifier as an unsigned integer value

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object