Module org.arakhne.afc.gis.gisroad

Package org.arakhne.afc.gis.road

Class StandardRoadConnection.Connection

java.lang.Object

org.arakhne.afc.gis.road.StandardRoadConnection.Connection

All Implemented Interfaces:

GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>

Enclosing class:

StandardRoadConnection

protected class StandardRoadConnection.Connection
extends Object
implements GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>

This class represents the information on a connected segment.

Since:

14.0

Version:

17.0 2020-01-04 14:41:55

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.gis

Maven Artifact Id:

gisroad

Field Summary

Fields

Modifier and Type	Field	Description
boolean	connectedWithStartPoint	Indicates if this connection is done with a start point.

Constructor Summary

Constructors

Constructor	Description
Connection(RoadPolyline segment, boolean connectedWithStartPoint)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
RoadConnection	getGraphPoint()	Replies the connection point.
RoadSegment	getGraphSegment()	Replies the connected segment.
RoadPolyline	getRoadPolyline()	Replies the linked road polyline.
int	hashCode()
boolean	isSegmentStartConnected()	Replies if the connected segment is connected by its start point or not.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

connectedWithStartPoint

public final boolean connectedWithStartPoint

Indicates if this connection is done with a start point.

Constructor Detail

Connection

public Connection(RoadPolyline segment,
                  boolean connectedWithStartPoint)

Constructor.

Parameters:

segment - the connected segment

connectedWithStartPoint - indicates if the segment is connected by its start point, or not.

Method Detail

getRoadPolyline

@Pure
public RoadPolyline getRoadPolyline()

Replies the linked road polyline.

Returns:

the connected segment.

equals

@Pure
public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class Object

toString

@Pure
public String toString()

Overrides:

toString in class Object

getGraphPoint

@Pure
public RoadConnection getGraphPoint()

Description copied from interface: GraphPoint.GraphPointConnection

Replies the connection point.

Specified by:

getGraphPoint in interface GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>

Returns:

the connection point.

getGraphSegment

@Pure
public RoadSegment getGraphSegment()

Description copied from interface: GraphPoint.GraphPointConnection

Replies the connected segment.

Specified by:

getGraphSegment in interface GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>

Returns:

the connected segment.

isSegmentStartConnected

@Pure
public boolean isSegmentStartConnected()

Description copied from interface: GraphPoint.GraphPointConnection

Replies if the connected segment is connected by its start point or not.

Specified by:

isSegmentStartConnected in interface GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>

Returns:

true if the segment replied by GraphPoint.GraphPointConnection.getGraphSegment() is connected to the point replied by GraphPoint.GraphPointConnection.getGraphPoint() by its start end, otherwise false