ilog.cpl.network
Class IlpGeographicPolyline

java.lang.Object
  extended by ilog.cpl.network.IlpGeographicPolyPoints
      extended by ilog.cpl.network.IlpGeographicPolyline
All Implemented Interfaces:
IlpPosition

public class IlpGeographicPolyline
extends IlpGeographicPolyPoints

This class describes a polyline on the earth's surface, given a set of longitude and latitude,where the starting point and the end point are not necessarily the same.

Since:
JTGO 3.0

Constructor Summary
IlpGeographicPolyline(IlpGeographicPosition[] positions)
          Creates a new IlpGeographicPolyline instance, connecting given points.
 
Method Summary
 IlpGeographicPosition getFrom()
          Returns the starting point of the polyline.
 int getNumberOfPoints()
          Returns the number of points in the polyline.
 IlpGeographicPosition getPoint(int index)
          Returns a specific point (0 <= index < getNumberOfPoints()).
 IlpGeographicPosition[] getPoints()
          Returns the array of points.
 IlpGeographicPosition getPosition(int index)
          Deprecated. Please use getPoint instead.
 IlpGeographicPosition[] getPositions()
          Deprecated. Please use getPoints instead.
 IlpGeographicPosition getTo()
          Returns the end point of the polyline.
 
Methods inherited from class ilog.cpl.network.IlpGeographicPolyPoints
equals, hashCode, setPositions, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IlpGeographicPolyline

public IlpGeographicPolyline(IlpGeographicPosition[] positions)
Creates a new IlpGeographicPolyline instance, connecting given points.

Parameters:
positions - A non-empty array of points.
Method Detail

getFrom

public IlpGeographicPosition getFrom()
Returns the starting point of the polyline.


getTo

public IlpGeographicPosition getTo()
Returns the end point of the polyline.


getNumberOfPoints

public int getNumberOfPoints()
Returns the number of points in the polyline.

Specified by:
getNumberOfPoints in class IlpGeographicPolyPoints
Returns:
The number of points

getPoint

public IlpGeographicPosition getPoint(int index)
Returns a specific point (0 <= index < getNumberOfPoints()). The point should not be modified.


getPosition

public IlpGeographicPosition getPosition(int index)
Deprecated. Please use getPoint instead.

Returns a specific point (0 <= index < getNumberOfPoints()). The point should not be modified.

Overrides:
getPosition in class IlpGeographicPolyPoints
Deprecated Since:
JTGO 3.5

getPoints

public IlpGeographicPosition[] getPoints()
Returns the array of points. Neither the array nor the points contained therein should be modified.


getPositions

public IlpGeographicPosition[] getPositions()
Deprecated. Please use getPoints instead.

Returns the array of points. Neither the array nor the points contained therein should be modified.

Overrides:
getPositions in class IlpGeographicPolyPoints
Deprecated Since:
JTGO 3.5


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.   . All Rights Reserved.