com.luciad.format.gdf

Graph and Routing EngineInterface ILcdGDFAttribute

public interface ILcdGDFAttribute

Describes a GDF Attribute. A GDF attribute describes the characteristics of a GDF feature. It contains a set of (attribute type, attribute value) pairs, and has a validity range and direction, that indicate to which part of the feature this attribute applies.

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILcdGDFAttribute.Direction This class represents the different directions that can be associated with an attribute.

Method Summary

Modifier and Type	Method and Description
int	getAttributeCount() Returns the number of (attribute type, attribute value) pairs in this attribute.
TLcdGDFAttributeType	getAttributeType(int aIndex) Returns the attribute type of the attribute at the given index.
Object	getAttributeValue(int aIndex) Returns the attribute value at the given index.
double	getFromCurvimetricPosition() Returns the curvimetric position defining the start of the Attribute validity.
ILcdGDFSourceDescription	getSourceDescription(int aIndex) Returns the source description of the attribute at the given index, or null if none exists.
double	getToCurvimetricPosition() Returns the curvimetric position defining the end of the Attribute validity.
ILcdGDFAttribute.Direction	getValidityDirection() Returns the validity direction for the attribute values.
boolean	isCurvimetricPositionRelative() Returns true if the curvimetric positions are relative.

Method Detail

getFromCurvimetricPosition

double getFromCurvimetricPosition()

Returns the curvimetric position defining the start of the Attribute validity.

Returns:

the curvimetric position defining the start of the Attribute validity.

getToCurvimetricPosition

double getToCurvimetricPosition()

Returns the curvimetric position defining the end of the Attribute validity.

Returns:

the curvimetric position defining the end of the Attribute validity.

isCurvimetricPositionRelative

boolean isCurvimetricPositionRelative()

Returns true if the curvimetric positions are relative. If false, the positions are absolute.

Returns:

true if the curvimetric positions are relative, falseotherwise.

getValidityDirection

ILcdGDFAttribute.Direction getValidityDirection()

Returns the validity direction for the attribute values.

Returns:

one of POSITIVE, NEGATIVE, or BOTH.

getAttributeCount

int getAttributeCount()

Returns the number of (attribute type, attribute value) pairs in this attribute.

Returns:

the number of attribute pairs in the attribute.

getAttributeType

TLcdGDFAttributeType getAttributeType(int aIndex)

Returns the attribute type of the attribute at the given index.

Parameters:

aIndex - the index of the attribute whose type is to be returned.

Returns:

the attribute type of the attribute at the given index.

Throws:

IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getAttributeCount().

getSourceDescription

ILcdGDFSourceDescription getSourceDescription(int aIndex)

Returns the source description of the attribute at the given index, or null if none exists.

Parameters:

aIndex - the index of the attribute whose source description is to be returned.

Returns:

the source description of the attribute at the given index.

Throws:

IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getAttributeCount().

getAttributeValue

Object getAttributeValue(int aIndex)

Returns the attribute value at the given index.

Parameters:

aIndex - the index of the attribute whose value is to be returned.

Returns:

the attribute value at the given index.

Throws:

IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getAttributeCount().