TLcdNVGSymbol (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.format.nvg.model.TLcdNVGSymbol

```
public final class TLcdNVGSymbol
extends Object
```
NVG symbol representation. It is composed of a standard name and a text representation. The standard name is either 'APP6A', 'APP6B', 'APP6C', 'APP6D', 'MS2525B', 'MS2525C', 'MS2525D', 'ICON', or a user defined standard.
For military standard, the text representation is a military symbology code (ILcdAPP6ACoded.getAPP6ACode() and ILcdMS2525bCoded.getMS2525Code()). For icon, the text representation is a url reference to an image.

TLcdNVGSymbol can be assigned to a TLcdNVG20SymbolizedContent or a TLcdNVG15MapObject.

Since:

2015.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APP6A` The name of the standard `APP-6A`
`static String`	`APP6B` The name of the standard `APP-6B`.
`static String`	`APP6C` The name of the standard `APP-6C`.
`static String`	`APP6D` The name of the standard `APP-6D`.
`static String`	`ICON` Standard name for url references to an image file.
`static String`	`MS2525B` The name of the standard `MIL-STD-2525B`.
`static String`	`MS2525C` The name of the standard `MIL-STD-2525C`.
`static String`	`MS2525D` The name of the standard `MIL-STD-2525D`.

Constructor Summary

Constructors
Constructor and Description
`TLcdNVGSymbol()` Default constructor with unknown standard and text representation.
`TLcdNVGSymbol(String aStandardName, String aTextRepresentation)` Constructs an NVG symbol for a given standard name and a text representation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`static ELcdAPP6Standard`	`getAPP6Standard(String aName)` Returns the APP6 standard of the given NVG standard name.
`static ELcdMS2525Standard`	`getMS2525Standard(String aName)` Returns the MS2525 standard of the given NVG standard name.
`String`	`getStandardName()` Get the standard of this symbol.
`static String`	`getStandardName(Object aStandard)` Returns the NVG standard name for the given MS2525 or APP6 standard.
`static TLcdNVGSymbol`	`getSymbol(Object aObject)` Extracts the `TLcdNVGSymbol` from given object
`String`	`getTextRepresentation()` Get the textual representation of this symbol.
`int`	`hashCode()`
`static boolean`	`isAPP6ASymbol(TLcdNVGSymbol aNVGSymbol)` Checks whether given `TLcdNVGSymbol` is an APP6 Symbol
`static boolean`	`isMilitaryStandardName(String aCode)` Checks whether the given aCode is a Military Standard name or not
`static boolean`	`isMS2525bSymbol(TLcdNVGSymbol aNVGSymbol)` Checks whether given `TLcdNVGSymbol` is an MS2525 Symbol
`static void`	`setSymbol(Object aObject, TLcdNVGSymbol aSymbol)` Sets the `TLcdNVGSymbol` to given object
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - APP6A
```
public static final String APP6A
```
    The name of the standard APP-6A
  - APP6B
```
public static final String APP6B
```
    The name of the standard APP-6B.
  - APP6C
```
public static final String APP6C
```
    The name of the standard APP-6C.
  - APP6D
```
public static final String APP6D
```
    The name of the standard APP-6D.
    
    Since:
    
    2018.1
  - MS2525B
```
public static final String MS2525B
```
    The name of the standard MIL-STD-2525B.
    
    See Also:
    
    Constant Field Values
  - MS2525C
```
public static final String MS2525C
```
    The name of the standard MIL-STD-2525C.
    
    See Also:
    
    Constant Field Values
  - MS2525D
```
public static final String MS2525D
```
    The name of the standard MIL-STD-2525D.
    
    Since:
    
    2018.1
    
    See Also:
    
    Constant Field Values
  - ICON
```
public static final String ICON
```
    Standard name for url references to an image file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TLcdNVGSymbol
```
public TLcdNVGSymbol()
```
    Default constructor with unknown standard and text representation.
  - TLcdNVGSymbol
```
public TLcdNVGSymbol(String aStandardName,
                     String aTextRepresentation)
```
    Constructs an NVG symbol for a given standard name and a text representation.
    
    Parameters:
    
    aStandardName - The name of the standard. This can be one of the standard constants in this class (e.g. APP6A, MS2525B), ICON, or a user defined one.
    
    aTextRepresentation - The textual representation of the symbol. This could be a military code or a URL.
- Method Detail
  - getTextRepresentation
```
public String getTextRepresentation()
```
    Get the textual representation of this symbol. For instance for icons, this method returns the URL. For military symbology, the code defining the graphical representation is returned.
    
    Returns:
    
    The textual representation of this symbol.
  - getStandardName
```
public String getStandardName()
```
    Get the standard of this symbol. This can be one of the standard constants in this class (e.g. APP6A, MS2525B), ICON, or a user defined one.
    
    Returns:
    
    The standard as a string.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getSymbol
```
public static TLcdNVGSymbol getSymbol(Object aObject)
```
    Extracts the TLcdNVGSymbol from given object
    
    Parameters:
    
    aObject - object whose symbol is to be extracted
    
    Returns:
    
    TLcdNVGSymbol of aObject
    
    Throws:
    
    IllegalArgumentException - if aObject is not TLcdNVG15MapObject or TLcdNVG20SymbolizedContent
  - setSymbol
```
public static void setSymbol(Object aObject,
                             TLcdNVGSymbol aSymbol)
```
    Sets the TLcdNVGSymbol to given object
    
    Parameters:
    
    aObject - object whose symbol is to be set
    
    Throws:
    
    IllegalArgumentException - if aObject is not TLcdNVG15MapObject or TLcdNVG20SymbolizedContent
  - isMilitaryStandardName
```
public static boolean isMilitaryStandardName(String aCode)
```
    Checks whether the given aCode is a Military Standard name or not
    
    Parameters:
    
    aCode - code to be checked
    
    Returns:
    
    true of aCode is a Military Standard Name, false otherwise
  - isAPP6ASymbol
```
public static boolean isAPP6ASymbol(TLcdNVGSymbol aNVGSymbol)
```
    Checks whether given TLcdNVGSymbol is an APP6 Symbol
    
    Parameters:
    
    aNVGSymbol - symbol to be checked
    
    Returns:
    
    true if aNVGSymbol is an APP6 symbol, false otherwise
  - isMS2525bSymbol
```
public static boolean isMS2525bSymbol(TLcdNVGSymbol aNVGSymbol)
```
    Checks whether given TLcdNVGSymbol is an MS2525 Symbol
    
    Parameters:
    
    aNVGSymbol - symbol to be checked
    
    Returns:
    
    true if aNVGSymbol is an MS2525 symbol, false otherwise
  - getAPP6Standard
```
public static ELcdAPP6Standard getAPP6Standard(String aName)
```
    Returns the APP6 standard of the given NVG standard name.
    
    Parameters:
    
    aName - String whose standard will be returned
    
    Returns:
    
    APP6 standard name of the given string
    
    Throws:
    
    IllegalArgumentException - if the String does not map to a ELcdAPP6Standard
  - getMS2525Standard
```
public static ELcdMS2525Standard getMS2525Standard(String aName)
```
    Returns the MS2525 standard of the given NVG standard name.
    
    Parameters:
    
    aName - String whose standard will be returned
    
    Returns:
    
    MS2525 standard name of the given string
    
    Throws:
    
    IllegalArgumentException - if the String does not map to a ELcdMS2525Standard
  - getStandardName
```
public static String getStandardName(Object aStandard)
```
    Returns the NVG standard name for the given MS2525 or APP6 standard.
    
    Parameters:
    
    aStandard - an instance of ELcdMS2525Standard or ELcdAPP6Standard
    
    Returns:
    
    the NVG standard name, or null if there is no NVG standard name for the given standard

Defense SymbologyClass TLcdNVGSymbol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APP6A

APP6B

APP6C

APP6D

MS2525B

MS2525C

MS2525D

ICON

Constructor Detail

TLcdNVGSymbol

TLcdNVGSymbol

Method Detail

getTextRepresentation

getStandardName

toString

equals

hashCode

getSymbol

setSymbol

isMilitaryStandardName

isAPP6ASymbol

isMS2525bSymbol

getAPP6Standard

getMS2525Standard

getStandardName