Companion

object Companion

Functions

Link copied to clipboard
fun canSymbolHaveModifier(symbolID: String, modifier: String): Boolean
Link copied to clipboard

Gets Basic Symbol ID which is the Symbol Set + Entity Code

Link copied to clipboard

Gets the basic Symbol ID for a 2525C symbol SFGPU---***** GGGPP---****X

Link copied to clipboard

Gets the anchor point for single point Control Measure as the anchor point isn't always they center of the symbol.

Link copied to clipboard

Converts a Java Date object into a properly formatted String for W or W1. DDHHMMSSZMONYYYY Field W: D = day, H = hour, M = minute, S = second, Z = Greenwich or local time, MON= month and Y = year.

Link copied to clipboard

For Control Measures, returns the default color for a symbol when it differs from the affiliation line color. If there is no default color, returns the value from {@link getLineColorOfAffiliation()}

Link copied to clipboard
fun getEchelonText(echelon: int): String

Reads the Symbol ID string and returns the text that represents the echelon code.

Link copied to clipboard

Returns the fill color for the symbol based on its affiliation

Link copied to clipboard

Gets line color used if no line color has been set. The color is specified based on the affiliation of the symbol and whether it is a unit or not.

Link copied to clipboard

Returns the Standard Identity Modifier based on the Symbol ID

Link copied to clipboard

Returns the height ratio for the unit specified by the symbol ID Based on Figure 4 in 2525E.

Link copied to clipboard

Returns the width ratio for the unit specified by the symbol ID Based on Figure 4 in 2525E.

Link copied to clipboard
fun hasDefaultFill(strSymbolID: String): Boolean

Checks if a symbol should be filled by default

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

Checks if the Symbol Code has FDI set. Does not check if the symbol can have an FDI.

Link copied to clipboard
fun hasModifier(symbolID: String, modifier: String): Boolean

Determines if a symbol, based on it's symbol ID, can have the specified modifier/amplifier.

Link copied to clipboard

Returns true if the unit has a rectangle frame

Link copied to clipboard
fun isActionPoint(symbolID: String): Boolean
Link copied to clipboard
fun isAir(symbolID: String): Boolean

Returns true if the symbol is from an air based symbol set

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

Returns true if Symbol ID represents a chemical, biological, radiological or nuclear incident.

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

Returns true if the symbol ID indicates the context is Exercise

Link copied to clipboard

Returns true if graphic is protection graphic (obstacles which render green)

fun isGreenProtectionGraphic(entity: int, entityType: int, entitySubtype: int): Boolean

Returns true if graphic is protection graphic (obstacles which render green) Assumes control measure symbol code where SS == 25

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

Returns true if the symbol has the HQ staff indicated by the symbol ID

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

Returns true if the symbol is an installation

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

Returns true if the symbol is from a land based symbol set

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

Determines if the Symbol can be rendered as a multipoint graphic and not just as an icon

Link copied to clipboard
fun isNumber(text: String): Boolean

Determines if a String represents a valid number

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

Obstacles are generally required to have a green line color

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

Returns true if the symbol ID indicates the context is Reality

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

Returns true if the symbol ID indicates the context is Simulation

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

Returns true if Symbol ID represents a Sonobuoy.

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

Returns true if the symbol is from a space based symbol set

Link copied to clipboard

Checks if this is a single point control measure or meteorological graphic with a unique layout. Basically anything that's not an action point style graphic with modifiers

Link copied to clipboard
fun isTacticalGraphic(strSymbolID: String): Boolean

Determines if the symbol is a tactical graphic

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

Returns true if the symbol ID has the task for indicator

Link copied to clipboard

Control Measures and Tactical Graphics that have labels but not with the Action Point layout

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

Return true if symbol is from the Atmospheric, Oceanographic or Meteorological Space Symbol Sets.

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)