Companion

object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun getAffiliation(symbolID: String): Double

Get Affiliation from position 4

Link copied to clipboard

Get Amplifier Descriptor which can describe things like Echelon / Mobility / Towed Array / Leadership Indicator from positions 9-10

Link copied to clipboard

Get Common Sector 1 Modifier from position 21.

Link copied to clipboard

Get Common Sector 2 Modifier from position 22.

Link copied to clipboard
fun getContext(symbolID: String): Double

Get Context (Reality (0), Exercise (1), Simulation (2)) at position 3 Higher values are NATO only

Link copied to clipboard
fun getCountryCode(symbolID: String): Double

Gets the 3 digit county code from positions 28-30

Link copied to clipboard

In 2525E, position 23 of the symbol code has the Frame Shape modifier. This lets a user force a different frame shape than what a symbol would normally have. Like you could have Air Fixed Wing with a ground unit rectangle frame for when it's on the ground. This function returns the frame shape value for what the default frame would be for a specific symbol set.

Link copied to clipboard
fun getEntity(symbolID: String): Double

Get Entity from positions 11-12.

Link copied to clipboard
fun getEntityCode(symbolID: String): Double

Get Entity Code from positions 11-16. These six digits identify a unique symbol within a symbol set.

Link copied to clipboard

Get Entity Subtype from positions 15-16.

Link copied to clipboard
fun getEntityType(symbolID: String): Double

Get Entity Type from positions 13-14.

Link copied to clipboard
fun getFrameID(symbolID: String): String

Build string to grab appropriate SVG file

Link copied to clipboard
fun getFrameShape(symbolID: String): String

Gets the Frame Shape override from position 23.

Link copied to clipboard
fun getHQTFD(symbolID: String): Double

Get Symbol Set from position 8

Link copied to clipboard
fun getMainIconID(symbolID: String): String

Build string to grab appropriate SVG file

Link copied to clipboard
fun getMod1ID(symbolID: String): String

Build string to grab appropriate SVG file

Link copied to clipboard
fun getMod2ID(symbolID: String): String

Build string to grab appropriate SVG file

Link copied to clipboard
fun getModifier1(symbolID: String): Double

Get Sector 1 Modifier from positions 17-18.

Link copied to clipboard
fun getModifier2(symbolID: String): Double

Get Sector 2 Modifier from positions 17-18.

Link copied to clipboard

Gets the version number from the Symbol ID at positions 3-4. Restricted and No-Strike values are NATO only.

Link copied to clipboard
fun getStatus(symbolID: String): Double

Get Symbol Set from position 7

Link copied to clipboard
fun getSymbolSet(symbolID: String): Double

Get Symbol Set from positions 5-6

Link copied to clipboard
fun getVersion(symbolID: String): Double

Gets the version number from the Symbol ID at positions 1-2

Link copied to clipboard
fun isMETOC(symbolID: String): Boolean

Returns true is symbol is of the Meteorological variety.

Link copied to clipboard

Attempts to resolve a bad symbol ID into a value that can be found in {@link MSLookup}. If it fails, it will return the symbol code for a invalid symbol which is displayed as an inverted question mark (110098000010000000000000000000)

Link copied to clipboard
fun setAffiliation(symbolID: String, affiliation: Double): String

Set Affiliation at position 4

Link copied to clipboard

Set Amplifier Descriptor which can describe things like Echelon / Mobility / Towed Array / Leadership Indicator at positions 9-10

Link copied to clipboard
fun setCommonModifier1(symbolID: String, mod1I: Double): String

Set Common Sector 1 Modifier at position 21.

Link copied to clipboard
fun setCommonModifier2(symbolID: String, mod1I: Double): String

Set Common Sector 2 Modifier at position 22.

Link copied to clipboard
fun setContext(symbolID: String, context: Double): String

Set Context (Reality (0), Exercise (1), Simulation (2)) at position 3

Link copied to clipboard
fun setEntityCode(symbolID: String, entityCode: Double): String

Set Entity Code at positions 11-16. These six digits identify a unique symbol within a symbol set.

Link copied to clipboard
fun setHQTFD(symbolID: String, HQTFD: Double): String

Set Symbol Set at position 8

Link copied to clipboard
fun setModifier1(symbolID: String, mod1: Double): String

Set Sector 1 Modifier at positions 17-18.

Link copied to clipboard
fun setModifier2(symbolID: String, mod1: Double): String

Set Sector 2 Modifier at positions 17-18.

Link copied to clipboard

Sets the version number of the Symbol ID at positions 3-4

Link copied to clipboard
fun setStatus(symbolID: String, status: Double): String

Set Symbol Set at position 7

Link copied to clipboard
fun setSymbolSet(symbolID: String, ss: Double): String

Set Symbol Set at positions 5-6

Link copied to clipboard
fun setVersion(symbolID: String, ver: Double): String

Sets the version number of the Symbol ID at positions 1-2