ILcdMS2525bCoded (LuciadLightspeed API documentation)

All Known Subinterfaces:: ILcdEditableMS2525bCoded, ILcdEditableMS2525bShape, ILcdMS2525bShape

All Known Implementing Classes:: TLcdEditableMS2525bObject

public interface ILcdMS2525bCoded

General interface for objects from one of the supported MIL-STD-2525 standards.

Text modifiers

The text modifiers are encoded in the object using the keys defined in this class. You can find the details in the documentation of each key. Note that the value from some keys can contain multiple MS2525 fields (for example sAdditionalInformation). The different values are separated using a ':' character.

Special cases

This section gives more information on symbols that have special features or rules that are not readily apparent from the specification.

1. Minefields

The following symbols in TACTICAL GRAPHICS - MOBILITY/SURVIVABILITY - OBSTACLES - MINEFIELDS

STATIC DEPICTION
DYNAMIC DEPICTION

can be filled with an icon indicating their mine type. Unfortunately the MS2525 specification does not indicate how this mine type should be encoded in the symbol. The approach taken here is similar to other products: the mine type is encoded in the type text modifier of the symbol. The value should either be the code of the mine or one of the following values:

Name	Possible values
Antipersonnel mine	"OMP", "OMP---", "ANTIPERSONNEL", "AP"
Antitank mine	"OMT", "OMT---", "ANTITANK", "AT"
Antitank mine with antihandling device	"OMD", "OMD---", "ANTITANK ANTIHANDLING", "ANTIHANDLING ANTITANK", "AT AH", "AH AT", "AHAT", "ATH", "HAT"
Directional antitank mine	"OME", "OME---", "ANTITANK DIRECTIONAL", "DIRECTIONAL ANTITANK", "AT D", "D AT", "ATD", "DAT"
Unspecified mine	"OMU", "OMU---", "UNSPECIFIED"
Wide area mine	"OMW", "OMW---", "WIDE AREA MINES", "WIDE", "WIDE AREA", "W", "WA", "WAM"

See Also:: ELcdMS2525Standard, TLcdEditableMS2525bObject

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`sAdditionalInformation` A text modifier for units, equipment and installations.
`static String`	`sAffiliation` Affiliation.
`static String`	`sAltitudeDepth` A text modifier for units, equipment, and installations that displays the altitude portion of GPS; flight level for aircraft; depth for submerged objects; height in feet of equipment or structures on the ground.
`static String`	`sAttitude` Target Attitude.
`static String`	`sCombatEffectiveness` A text modifier for units and equipment that indicates unit effectiveness or installation capability.
`static String`	`sCommonIdentifier` Example: "Hawk" for Hawk SAM system.
`static String`	`sCountry` Country.
`static String`	`sDateTimeGroup` A text modifier for units, equipment and installations that displays traditional military Date/Time Group format: DDHHMMSSZMONYY.
`static String`	`sEchelon` Echelon.
`static String`	`sEffectiveTime` Effective time.
`static String`	`sEngagementBar` A graphic amplifier placed immediately atop the symbol.
`static String`	`sEvaluationRating` A text modifier for units, equipment, and installations that consists of a one-letter reliability rating and a one-letter credibility rating: Reliability rating: A (completely reliable), B (usually reliable), C (fairly reliable), D (not usually reliable) Credibility rating: 1 (confirmed by other sources), 2 (probably true), 3 (possibly true), 4 (doubtfully true), 5 (improbable), 6 (truth cannot be judged).
`static String`	`sFrameShapeModifier` A graphic modifier that displays additional decorations that relate to the affiliation and battle dimension of a symbol.
`static String`	`sGuardedUnit` Undefined or BG.
`static String`	`sHigherFormation` A text modifier for units that indicates number or title of higher echelon command.
`static String`	`sHostile` A text modifier for equipment; letters "ENY" denote hostile symbols.
`static String`	`sHqTaskForceDummy` Headquarters/Task Force/Dummy.
`static String`	`sIFFSIF` A text modifier displaying IFF/SIF/AIS Identification modes and codes.
`static String`	`sLength` Target Length in meters.
`static String`	`sLocationLabel` A text modifier for units, equipment, and installations that displays a symbol´s location in degrees, minutes, and seconds (or in UTM or other applicable display format).
`static String`	`sMobilityIndicator` Modifier for equipment that depicts the mobility of an object.
`static String`	`sMovementDirection` A modifier for units, equipment, and installations that identifies the direction of movement or intended movement of an object.
`static String`	`sOrderOfBattle` Order Of Battle.
`static String`	`sPlatformType` ELNOT or CENOT.
`static String`	`sQuantity` A text modifier in an equipment symbol that identifies the number of items present.
`static String`	`sReinforcedOrReduced` R for reinforced, D for reduced, RD for reinforced and reduced.
`static String`	`sSector1` Sector 1.
`static String`	`sSector2` Sector 2.
`static String`	`sSignatureEquipment` A text modifier for hostile equipment; "!" indicates detectable electronic signatures.
`static String`	`sSpecialDesignator` NRT or SIG.
`static String`	`sSpecialHeadquarters` A text modifier for units that contains the name of the special C2 headquarters.
`static String`	`sSpeedLabel` A text modifier for units, equipment, and installations that displays velocity as set forth in MIL-STD-6040.
`static String`	`sStaffComments` A text modifier for units, equipment and installations.
`static String`	`sStandardIdentity1` Standard Identity 1.
`static String`	`sStandardIdentity2` Standard Identity 2.
`static String`	`sStaticDynamic` Static/dynamic.
`static String`	`sStatus` Status.
`static String`	`sTargetDesignator` A six character text modifier used in Fire Support operations to uniquely designate targets in accordance with STANAG 2147, where characters 1 and 2 are alphabetic, and characters 3-6 are numeric: AANNNN.
`static String`	`sTeardownTime` Equipment teardown time in minutes.
`static String`	`sTypeLabel` A text modifier for equipment that indicates type of equipment.
`static String`	`sUniqueDesignation` A text modifier for units, equipment, and installations that uniquely identifies a particular symbol or track number.
`static String`	`sWidth` Target Width in meters.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getMS2525Code()` Returns the symbol code of the object (SIDC).
`ELcdMS2525Standard`	`getMS2525Standard()` Returns the symbology standard used by this object.
`int`	`getTextModifierCount()` Returns the number of text modifiers for this object in the MIL-STD-2525B standard.
`String`	`getTextModifierKey(int aIndex)` Returns the text modifier key at the given index.
`String`	`getTextModifierKeyDisplayName(String aTextModifierKey)` Returns the display name of the text modifier with the given key.
`String`	`getTextModifierValue(int aIndex)` Returns the value of the text modifier at the given index.
`String`	`getTextModifierValue(String aTextModifierKey)` Returns the value of the text modifier with the given key.

- Field Detail
  - sFrameShapeModifier
```
static final String sFrameShapeModifier
```
    A graphic modifier that displays additional decorations that relate to the affiliation and battle dimension of a symbol. More specifically, it refers to the affiliation characters that are introduced by the Joker (J), Faker (K), Pending (?), Assumed (?), and Exercise (X?) affiliations, and it also refers to the Space battle dimension decoration (black top) in case of MIL-STD 2525c.
    The value of this modifier cannot be set / retrieved; instead, it is automatically determined based on the SIDC returned by getMS2525Code(). The modifier can be used to disable / enable its visualization via ILcdMS2525bStyle.setLabelEnabled(String, boolean).
    
    See Also:
    
    Constant Field Values
  - sQuantity
```
static final String sQuantity
```
    A text modifier in an equipment symbol that identifies the number of items present.
    The MS2525 field(s): "C"
    
    See Also:
    
    Constant Field Values
  - sReinforcedOrReduced
```
static final String sReinforcedOrReduced
```
    R for reinforced, D for reduced, RD for reinforced and reduced. The label will display (+), (-) and (±) respectively.
    The MS2525 field(s): "F"
    
    See Also:
    
    Constant Field Values
  - sStaffComments
```
static final String sStaffComments
```
    A text modifier for units, equipment and installations.
    The MS2525 field(s): "G"
    
    See Also:
    
    Constant Field Values
  - sAdditionalInformation
```
static final String sAdditionalInformation
```
    A text modifier for units, equipment and installations.
    The MS2525 field(s): "H" or "H:H1"
    
    See Also:
    
    Constant Field Values
  - sEvaluationRating
```
static final String sEvaluationRating
```
    A text modifier for units, equipment, and installations that consists of a one-letter reliability rating and a one-letter credibility rating:

See Also:: Constant Field Values

sCombatEffectiveness
```
static final String sCombatEffectiveness
```
A text modifier for units and equipment that indicates unit effectiveness or installation capability.
The MS2525 field(s): "K"

See Also:

Constant Field Values

sSignatureEquipment
```
static final String sSignatureEquipment
```
A text modifier for hostile equipment; "!" indicates detectable electronic signatures.
The MS2525 field(s): "L"

See Also:

Constant Field Values

sHigherFormation
```
static final String sHigherFormation
```
A text modifier for units that indicates number or title of higher echelon command.
The MS2525 field(s): "M"

See Also:

Constant Field Values

sHostile
```
static final String sHostile
```
A text modifier for equipment; letters "ENY" denote hostile symbols.
The value of this modifier cannot be set / retrieved; instead, it is automatically determined based on the SIDC returned by getMS2525Code(). The modifier can be used to disable / enable its visualization via ILcdMS2525bStyle.setLabelEnabled(String, boolean). The MS2525 field(s): "N"

See Also:

Constant Field Values

sIFFSIF
```
static final String sIFFSIF
```
A text modifier displaying IFF/SIF/AIS Identification modes and codes.
The MS2525 field(s): "P"

See Also:

Constant Field Values

sMobilityIndicator
```
static final String sMobilityIndicator
```
Modifier for equipment that depicts the mobility of an object. This is not a text modifier, but a 2525d SIDC modifier (a modifier encoded in the SIDC code). The value of this modifier cannot be set / retrieved for 2525b/c.
The MS2525 field(s): "R"

See Also:

Constant Field Values

sUniqueDesignation
```
static final String sUniqueDesignation
```
A text modifier for units, equipment, and installations that uniquely identifies a particular symbol or track number. Identifies acquisition number when used with SIGINT symbology.
The MS2525 field(s): "T" or "T:T1"

See Also:

Constant Field Values

sTypeLabel
```
static final String sTypeLabel
```
A text modifier for equipment that indicates type of equipment.
The MS2525 field(s): "V"

See Also:

Constant Field Values

sDateTimeGroup
```
static final String sDateTimeGroup
```
A text modifier for units, equipment and installations that displays traditional military Date/Time Group format: DDHHMMSSZMONYY.
The MS2525 field(s): "W"

See Also:

Constant Field Values

sAltitudeDepth
```
static final String sAltitudeDepth
```
A text modifier for units, equipment, and installations that displays the altitude portion of GPS; flight level for aircraft; depth for submerged objects; height in feet of equipment or structures on the ground.
The MS2525 field(s): "X"

See Also:

Constant Field Values

sLocationLabel
```
static final String sLocationLabel
```
A text modifier for units, equipment, and installations that displays a symbol´s location in degrees, minutes, and seconds (or in UTM or other applicable display format).
The MS2525 field(s): "Y"

See Also:

Constant Field Values

sSpeedLabel
```
static final String sSpeedLabel
```
A text modifier for units, equipment, and installations that displays velocity as set forth in MIL-STD-6040.
The MS2525 field(s): "Z"

See Also:

Constant Field Values

sSpecialHeadquarters
```
static final String sSpecialHeadquarters
```
A text modifier for units that contains the name of the special C2 headquarters.
The MS2525 field(s): "AA"

See Also:

Constant Field Values

sPlatformType
```
static final String sPlatformType
```
ELNOT or CENOT.
The MS2525 field(s): "AD"

See Also:

Constant Field Values

sSpecialDesignator
```
static final String sSpecialDesignator
```
NRT or SIG.
The MS2525 field(s): "AR"

Since:

2018.1

See Also:

Constant Field Values

sTargetDesignator
```
static final String sTargetDesignator
```
A six character text modifier used in Fire Support operations to uniquely designate targets in accordance with STANAG 2147, where characters 1 and 2 are alphabetic, and characters 3-6 are numeric: AANNNN.
The MS2525 field(s): "AP"

Since:

2018.1

See Also:

Constant Field Values

sGuardedUnit
```
static final String sGuardedUnit
```
Undefined or BG.
The MS2525 field(s): "AQ"

Since:

2018.1

See Also:

Constant Field Values

sTeardownTime
```
static final String sTeardownTime
```
Equipment teardown time in minutes.
The MS2525 field(s): "AE"

See Also:

Constant Field Values

sCommonIdentifier
```
static final String sCommonIdentifier
```
Example: "Hawk" for Hawk SAM system.
The MS2525 field(s): "AF"

See Also:

Constant Field Values

sEffectiveTime
```
static final String sEffectiveTime
```
Effective time.
The MS2525 field(s): "W1"

See Also:

Constant Field Values

sMovementDirection
```
static final String sMovementDirection
```
A modifier for units, equipment, and installations that identifies the direction of movement or intended movement of an object.
The MS2525 field(s): "Q"

See Also:

Constant Field Values

sAffiliation
```
static final String sAffiliation
```
Affiliation. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).

See Also:

Constant Field Values

sCountry
```
static final String sCountry
```
Country. For MIL-STD 2525b/c, this is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code). The MS2525 field(s): "AS"

See Also:

Constant Field Values

sStatus
```
static final String sStatus
```
Status. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).

See Also:

Constant Field Values

sStaticDynamic
```
static final String sStaticDynamic
```
Static/dynamic. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).

Since:

2023.0

See Also:

Constant Field Values

sOrderOfBattle
```
static final String sOrderOfBattle
```
Order Of Battle. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).

See Also:

Constant Field Values

sSector1
```
static final String sSector1
```
Sector 1. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).
Applies only to MIL-STD 2525d.

Since:

2018.1

See Also:

Constant Field Values

sSector2
```
static final String sSector2
```
Sector 2. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).
Applies only to MIL-STD 2525d.

Since:

2018.1

See Also:

Constant Field Values

sStandardIdentity1
```
static final String sStandardIdentity1
```
Standard Identity 1. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).
Applies only to MIL-STD 2525d.

Since:

2018.1

See Also:

Constant Field Values

sStandardIdentity2
```
static final String sStandardIdentity2
```
Standard Identity 2. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).
Applies only to MIL-STD 2525d.

Since:

2018.1

See Also:

Constant Field Values

sEchelon
```
static final String sEchelon
```
Echelon. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).

See Also:

Constant Field Values

sHqTaskForceDummy
```
static final String sHqTaskForceDummy
```
Headquarters/Task Force/Dummy. This is not a text modifier, but an SIDC modifier (a modifier encoded in the SIDC code).
Applies only to MIL-STD 2525d.

Since:

2018.1

See Also:

Constant Field Values

sAttitude
```
static final String sAttitude
```
Target Attitude. Azimuth value in degrees (clockwise, starting from true North). Defines the target orientation.
The MS2525 field(s): "AN"
Applies only to MIL-STD 2525c and MIL-STD 2525d.

Since:

2018.2

See Also:

Constant Field Values

sLength
```
static final String sLength
```
Target Length in meters. Defines the total target length.
The MS2525 field(s): "AM1"
Applies only to MIL-STD 2525c and MIL-STD 2525d.

Since:

2018.2

See Also:

Constant Field Values

sWidth
```
static final String sWidth
```
Target Width in meters. Defines the total target width.
The MS2525 field(s): "AM"
Applies only to MIL-STD 2525c and MIL-STD 2525d.

Since:

2018.2

See Also:

Constant Field Values

sEngagementBar
```
static final String sEngagementBar
```
A graphic amplifier placed immediately atop the symbol. May denote, 1) local/remote status; 2) engagement status; and 3) weapon type.
The MS2525 field(s): "AO"
Applies only to MIL-STD 2525c and MIL-STD 2525d.

Since:

2018.2

See Also:

Constant Field Values

Method Detail
- getMS2525Code
```
String getMS2525Code()
```
  Returns the symbol code of the object (SIDC).
  The symbol code has to be interpreted according to the symbology standard used by this object, which can be retrieved through getMS2525Standard().
  
  Returns:
  
  the symbol code of the object (SIDC).
  
  See Also:
  
  getMS2525Standard()
- getMS2525Standard
```
ELcdMS2525Standard getMS2525Standard()
```
  Returns the symbology standard used by this object.
  
  Returns:
  
  the symbology standard used by this object.
  
  See Also:
  
  ELcdMS2525Standard
- getTextModifierCount
```
int getTextModifierCount()
```
  Returns the number of text modifiers for this object in the MIL-STD-2525B standard.
  
  Returns:
  
  the number of text modifiers for this object in the MIL-STD-2525B standard.
- getTextModifierKey
```
String getTextModifierKey(int aIndex)
```
  Returns the text modifier key at the given index.
  
  Parameters:
  
  aIndex - the index of key of the text modifier to retrieve.
  
  Returns:
  
  the text modifier key at the given index.
  
  See Also:
  
  getTextModifierCount()
- getTextModifierKeyDisplayName
```
String getTextModifierKeyDisplayName(String aTextModifierKey)
```
  Returns the display name of the text modifier with the given key.
  
  Parameters:
  
  aTextModifierKey - the key of the text modifier to retrieve the display name of.
  
  Returns:
  
  the display name of the text modifier with the given key.
- getTextModifierValue
```
String getTextModifierValue(String aTextModifierKey)
```
  Returns the value of the text modifier with the given key.
  
  Parameters:
  
  aTextModifierKey - the key of the text modifier to retrieve the value of.
  
  Returns:
  
  the value of the text modifier with the given key.
- getTextModifierValue
```
String getTextModifierValue(int aIndex)
```
  Returns the value of the text modifier at the given index.
  
  Parameters:
  
  aIndex - the index of the value of the text modifier to retrieve.
  
  Returns:
  
  the value of the text modifier at the given index.
  
  See Also:
  
  getTextModifierCount()

Defense SymbologyInterface ILcdMS2525bCoded

Text modifiers

Special cases

1. Minefields

Field Summary

Method Summary

Field Detail

sFrameShapeModifier

sQuantity

sReinforcedOrReduced

sStaffComments

sAdditionalInformation

sEvaluationRating

sCombatEffectiveness

sSignatureEquipment

sHigherFormation

sHostile

sIFFSIF

sMobilityIndicator

sUniqueDesignation

sTypeLabel

sDateTimeGroup

sAltitudeDepth

sLocationLabel

sSpeedLabel

sSpecialHeadquarters

sPlatformType

sSpecialDesignator

sTargetDesignator

sGuardedUnit

sTeardownTime

sCommonIdentifier

sEffectiveTime

sMovementDirection

sAffiliation

sCountry

sStatus

sStaticDynamic

sOrderOfBattle

sSector1

sSector2

sStandardIdentity1

sStandardIdentity2

sEchelon

sHqTaskForceDummy

sAttitude

sLength

sWidth

sEngagementBar

Method Detail

getMS2525Code

getMS2525Standard

getTextModifierCount

getTextModifierKey

getTextModifierKeyDisplayName

getTextModifierValue

getTextModifierValue