com.luciad.format.gdf

Graph and Routing EngineInterface ILcdGDFRelationship

public interface ILcdGDFRelationship

Represents a GDF relationship. Relationships allow to define characteristics which involve more than GDF feature, like a turn restriction involving two roads. A relationship consists of a relationship type, the features involved in this relationship, and the attributes that describe its properties.

Since:

5.1

Method Summary

Modifier and Type	Method and Description
ILcdGDFAttribute	getAttribute(int aIndex) Returns the attribute at the given index.
int	getAttributeCount() Returns the number of attributes.
ILcdGDFFeature	getFeature(int aIndex) Returns the feature at the given index.
int	getFeatureCount() Returns the number of features involved in this relationship.
TLcdGDFRelationshipType	getRelationshipType() Returns the relationship type of this relationship.
ILcdGDFSourceDescription	getSourceDescription() Returns the source description of this feature, or null if none exists.

Method Detail

getRelationshipType

TLcdGDFRelationshipType getRelationshipType()

Returns the relationship type of this relationship.

Returns:

the relationship type of this relationship.

getSourceDescription

ILcdGDFSourceDescription getSourceDescription()

Returns the source description of this feature, or null if none exists.

Returns:

the source description of this feature.

getFeatureCount

int getFeatureCount()

Returns the number of features involved in this relationship.

Returns:

the number of features involved in this relationship.

getFeature

ILcdGDFFeature getFeature(int aIndex)

Returns the feature at the given index.

Parameters:

aIndex - the index of the feature to be returned.

Returns:

the feature at the given index.

Throws:

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

getAttributeCount

int getAttributeCount()

Returns the number of attributes.

Returns:

the number of attributes.

getAttribute

ILcdGDFAttribute getAttribute(int aIndex)

Returns the attribute at the given index.

Parameters:

aIndex - the index of the attribute to be returned.

Returns:

the attribute at the given index.

Throws:

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