Package armyc2.c5isr.renderer.utilities

Class SymbolID

  • public class SymbolID
extends java.lang.Object
    Utility class for helping to parse out parts of the symbol ID.

    • Constructor Detail

      • SymbolID

        public SymbolID()

    • Method Detail

      • reconcileSymbolID

        public static java.lang.String reconcileSymbolID​(java.lang.String symbolID)
        Deprecated.
        See SymbolUtilities.reconcileSymbolID(String)
        Attempts to resolve a bad symbol ID into a value that can be found in MSLookup. If it fails, it will return the symbol code for a invalid symbol which is displayed as an inverted question mark (110098000010000000000000000000)
        Parameters:
        symbolID - 30 character String
        Returns:
        30 character String representing the resolved symbol ID.

      • getVersion

        public static int getVersion​(java.lang.String symbolID)
        Gets the version number from the Symbol ID at positions 1-2
        Parameters:
        symbolID - 30 character String
        Returns:
        Integer like Version_2525Dch1 (11)

      • setVersion

        public static java.lang.String setVersion​(java.lang.String symbolID,
                                          int ver)
        Sets the version number of the Symbol ID at positions 1-2
        Parameters:
        symbolID - 30 character String
        ver - Integer like Version_2525Dch1 (11)
        Returns:
        updated 30 character String symbol ID

      • getStandardIdentity

        public static int getStandardIdentity​(java.lang.String symbolID)
        Gets the version number from the Symbol ID at positions 3-4. Restricted and No-Strike values are NATO only.
        Parameters:
        symbolID - 30 character String
        Returns:
        Integer, number will not be padded if it starts with a '0'

      • setStandardIdentity

        public static java.lang.String setStandardIdentity​(java.lang.String symbolID,
                                                   int si)
        Sets the version number of the Symbol ID at positions 3-4
        Parameters:
        symbolID - 30 character String
        si - Integer If number is a single digit, will pad with a '0' before inserting into symbol ID
        Returns:
        updated 30 character String symbol ID

      • getContext

        public static int getContext​(java.lang.String symbolID)
        Get Context (Reality (0), Exercise (1), Simulation (2)) at position 3 Higher values are NATO only
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setContext

        public static java.lang.String setContext​(java.lang.String symbolID,
                                          int context)
        Set Context (Reality (0), Exercise (1), Simulation (2)) at position 3
        Parameters:
        symbolID - 30 Character String
        context - Integer
        Returns:
        String updated Symbol ID.

      • getAffiliation

        public static int getAffiliation​(java.lang.String symbolID)
        Get Affiliation from position 4
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer like StandardIdentity_Affiliation_Friend

      • setAffiliation

        public static java.lang.String setAffiliation​(java.lang.String symbolID,
                                              int affiliation)
        Set Affiliation at position 4
        Parameters:
        symbolID - 30 Character String
        affiliation - like StandardIdentity_Affiliation_Friend
        Returns:
        String updated Symbol ID.

      • getSymbolSet

        public static int getSymbolSet​(java.lang.String symbolID)
        Get Symbol Set from positions 5-6
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer like SymbolSet_LandCivilianUnit_Organization

      • setSymbolSet

        public static java.lang.String setSymbolSet​(java.lang.String symbolID,
                                            int ss)
        Set Symbol Set at positions 5-6
        Parameters:
        symbolID - 30 Character String
        ss - like SymbolSet_LandCivilianUnit_Organization
        Returns:
        String updated Symbol ID.

      • getStatus

        public static int getStatus​(java.lang.String symbolID)
        Get Symbol Set from position 7
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer like Status_Present

      • setStatus

        public static java.lang.String setStatus​(java.lang.String symbolID,
                                         int status)
        Set Symbol Set at position 7
        Parameters:
        symbolID - 30 Character String
        status - like Status_Present
        Returns:
        String updated Symbol ID.

      • getHQTFD

        public static int getHQTFD​(java.lang.String symbolID)
        Get Symbol Set from position 8
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer like HQTFD_Headquarters

      • setHQTFD

        public static java.lang.String setHQTFD​(java.lang.String symbolID,
                                        int HQTFD)
        Set Symbol Set at position 8
        Parameters:
        symbolID - 30 Character String
        HQTFD - like HQTFD_Headquarters
        Returns:
        String updated Symbol ID.

      • getAmplifierDescriptor

        public static int getAmplifierDescriptor​(java.lang.String symbolID)
        Get Amplifier Descriptor which can describe things like Echelon / Mobility / Towed Array / Leadership Indicator from positions 9-10
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setAmplifierDescriptor

        public static java.lang.String setAmplifierDescriptor​(java.lang.String symbolID,
                                                      int ad)
        Set Amplifier Descriptor which can describe things like Echelon / Mobility / Towed Array / Leadership Indicator at positions 9-10
        Parameters:
        symbolID - 30 Character String
        ad -
        Returns:
        String

      • getEntityCode

        public static int getEntityCode​(java.lang.String symbolID)
        Get Entity Code from positions 11-16. These six digits identify a unique symbol within a symbol set.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setEntityCode

        public static java.lang.String setEntityCode​(java.lang.String symbolID,
                                             int entityCode)
        Set Entity Code at positions 11-16. These six digits identify a unique symbol within a symbol set.
        Parameters:
        symbolID - 30 Character String
        entityCode - Integer
        Returns:
        String

      • getEntity

        public static int getEntity​(java.lang.String symbolID)
        Get Entity from positions 11-12.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • getEntityType

        public static int getEntityType​(java.lang.String symbolID)
        Get Entity Type from positions 13-14.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • getEntitySubtype

        public static int getEntitySubtype​(java.lang.String symbolID)
        Get Entity Subtype from positions 15-16.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • getModifier1

        public static int getModifier1​(java.lang.String symbolID)
        Get Sector 1 Modifier from positions 17-18.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setModifier1

        public static java.lang.String setModifier1​(java.lang.String symbolID,
                                            int mod1)
        Set Sector 1 Modifier at positions 17-18.
        Parameters:
        symbolID - 30 Character String
        mod1 - Integer
        Returns:
        String

      • getCommonModifier1

        public static int getCommonModifier1​(java.lang.String symbolID)
        Get Common Sector 1 Modifier from position 21.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setCommonModifier1

        public static java.lang.String setCommonModifier1​(java.lang.String symbolID,
                                                  int mod1I)
        Set Common Sector 1 Modifier at position 21.
        Parameters:
        symbolID - 30 Character String
        mod1I - Integer
        Returns:
        String

      • getModifier2

        public static int getModifier2​(java.lang.String symbolID)
        Get Sector 2 Modifier from positions 17-18.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setModifier2

        public static java.lang.String setModifier2​(java.lang.String symbolID,
                                            int mod1)
        Set Sector 2 Modifier at positions 17-18.
        Parameters:
        symbolID - 30 Character String
        mod1 - Integer
        Returns:
        String

      • getCommonModifier2

        public static int getCommonModifier2​(java.lang.String symbolID)
        Get Common Sector 2 Modifier from position 22.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setCommonModifier2

        public static java.lang.String setCommonModifier2​(java.lang.String symbolID,
                                                  int mod1I)
        Set Common Sector 2 Modifier at position 22.
        Parameters:
        symbolID - 30 Character String
        mod1I - Integer
        Returns:
        String

      • isMETOC

        public static java.lang.Boolean isMETOC​(java.lang.String symbolID)
        Deprecated.
        See SymbolUtilities.isWeather(String)
        Returns true is symbol is of the Meteorological variety.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Boolean

      • getFrameID

        public static java.lang.String getFrameID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getFrameID(String)
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String

      • getMainIconID

        public static java.lang.String getMainIconID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getMainIconID(String)
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String

      • getMod2ID

        public static java.lang.String getMod2ID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getMod2ID(String) (String)}
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String

      • getMod1ID

        public static java.lang.String getMod1ID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getMod1ID(String) (String)}
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String

      • getCountryCode

        public static int getCountryCode​(java.lang.String symbolID)
        Gets the 3 digit county code from positions 28-30
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • getDefaultFrameShape

        public static char getDefaultFrameShape​(java.lang.String symbolID)
        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.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character

      • getFrameShape

        public static char getFrameShape​(java.lang.String symbolID)
        Gets the Frame Shape override from position 23.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character