com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFAttributeType

java.lang.Object

com.luciad.format.gdf.TLcdGDFAttributeType

public class TLcdGDFAttributeType
extends java.lang.Object

Provides general information about an attribute type, defined by its attribute type code.

Since:

5.1

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeTypeCode() Returns the 2-character type code of this attribute type.
TLcdGDFDataType	getDataType() Returns the TLcdGDFDataType that describes the type of data stored in this attribute.
java.lang.Object	getDefaultValue() Returns the default value for this attribute.
java.lang.String	getDescription() Returns a textual description of this attribute.
long	getMaxValue() Returns the maximum value allowed for this attribute.
long	getMinValue() Returns the minimum value allowed for this attribute.
java.lang.Class	getRepresentationClass() Returns the Class by which the data are represented.
TLcdGDFDataUnit	getUnit() Returns the TLcdGDFDataUnit that describes the unit in which the value of this attribute is expressed.
int	getUnitExponent() Returns the 10LOG of the factor with which the data values have to be multiplied to obtain the data unit as specified in the getUnit() method.
java.lang.String	toString() Returns a general description of this attribute type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAttributeTypeCode

public java.lang.String getAttributeTypeCode()

Returns the 2-character type code of this attribute type. See the GDF specification for an exhaustive list of predefined attribute types.

Returns:

the 2-character type code of this attribute type.

getDataType

public TLcdGDFDataType getDataType()

Returns the TLcdGDFDataType that describes the type of data stored in this attribute.

Returns:

the TLcdGDFDataType that describes the type of data stored in this attribute.

getUnit

public TLcdGDFDataUnit getUnit()

Returns the TLcdGDFDataUnit that describes the unit in which the value of this attribute is expressed.

Returns:

the TLcdGDFDataUnit that describes the unit in which the value of this attribute is expressed.

getUnitExponent

public int getUnitExponent()

Returns the 10LOG of the factor with which the data values have to be multiplied to obtain the data unit as specified in the getUnit() method.

Returns:

the 10LOG of the factor with which the data values have to be multiplied to obtain the data unit as specified in the getUnit() method.

getMinValue

public long getMinValue()

Returns the minimum value allowed for this attribute.

Returns:

the minimum value allowed for this attribute.

getMaxValue

public long getMaxValue()

Returns the maximum value allowed for this attribute.

Returns:

the maximum value allowed for this attribute.

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the default value for this attribute.

Returns:

the default value for this attribute.

getRepresentationClass

public java.lang.Class getRepresentationClass()

Returns the Class by which the data are represented.

Returns:

the Class by which the data are represented.

getDescription

public java.lang.String getDescription()

Returns a textual description of this attribute.

Returns:

a textual description of this attribute.

toString

public java.lang.String toString()

Returns a general description of this attribute type. The exact details of the representation are unspecified and are subject to change.

Overrides:

toString in class java.lang.Object

Returns:

a general description of this section key.