Envinsa 4.1 Java Edition API Specification

com.mapinfo.miaware.clientsdk.common
Class WayPoint

java.lang.Object
  extended bycom.mapinfo.miaware.clientsdk.common.WayPoint
Direct Known Subclasses:
WayPointEx

public class WayPoint
extends java.lang.Object

This class represents a location to be visited along a route.

FUNCTIONALITY

A Location is represented by:

  1. Address
  2. Position
  3. PointOfInterest

USABILITY

  1. Used to create the way points for the DetermineRouteRequest request.
    DetermineRouteRequest
  2. Used to create the way points for the RouteMatrix response.
    RouteMatrix
  3. Used to create the way points for the DetermineRouteMatrixRequest response.
    DetermineRouteMatrixRequest
  4. Used to create the way points for the DetermineRouteIsoChroneRequest request.
    DetermineRouteIsoChroneRequest
  5. Used to create the way points for the DetermineRouteIsoDistanceRequest request.
    DetermineRouteIsoDistanceRequest

Since:
v3.0
See Also:
Address, Position, PointOfInterest

Constructor Summary
WayPoint(DirectPosition dpos, java.lang.String srsName)
          Contructs this object with a given direct position and SRS name.
WayPoint(double x, double y, java.lang.String srsName)
          Constructs this object with the given coordinates and SRS name.
WayPoint(Location location)
          Constructs this object with a given location.
WayPoint(Location location, GeocodingQOS geocodeMatchCode)
          Constructs this object with a given location and quality of the match operation.
WayPoint(Location location, GeocodingQOS geocodeMatchCode, boolean stop)
          Constructs this object with a given location, match code, and stop flag.
WayPoint(com.mapinfo.miaware.xls.WayPointType wayPointType)
          Constructs this object with the stub object.
 
Method Summary
 GeocodingQOS getGeocodeMatchCode()
          Returns the geocode match type that provides information on the quality of the match operation (accuracy and match code).
 Location getLocation()
          Returns the WayPoint location.
 boolean isStop()
          Returns the stop flag that specifies whether the traveler plans to stop at the waypoint, or simply pass through it.
 void setGeocodeMatchCode(GeocodingQOS geocodeMatchCode)
          Sets the new geocode match type.
 void setLocation(Location location)
          Sets the new WayPoint location.
 void setStop(boolean stop)
          Sets the new stop flag.
 java.lang.String toString()
          Returns the string representation of the WayPoint.
 com.mapinfo.miaware.xls.WayPointType toXLS()
          Returns a new WayPointType object from this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WayPoint

public WayPoint(Location location)
Constructs this object with a given location.

Parameters:
location - the WayPoint location.

WayPoint

public WayPoint(Location location,
                GeocodingQOS geocodeMatchCode)
Constructs this object with a given location and quality of the match operation.

Parameters:
location - the WayPoint location.
geocodeMatchCode - the Geocode match code.
See Also:
GeocodingQOS

WayPoint

public WayPoint(Location location,
                GeocodingQOS geocodeMatchCode,
                boolean stop)
Constructs this object with a given location, match code, and stop flag.

Parameters:
location - the WayPoint location.
geocodeMatchCode - the Geocode match code.
stop - a flag that specifies whether the traveler plans to stop at the waypoint or simply pass through it. True represents a stop, false represents a pass through.

WayPoint

public WayPoint(DirectPosition dpos,
                java.lang.String srsName)
         throws InvalidMessageException
Contructs this object with a given direct position and SRS name. The position location is created internally.

Parameters:
dpos - the WayPoint position.
srsName - the spatial reference system to which the data will be projected in EPSG:XXXX format.
Throws:
InvalidMessageException

WayPoint

public WayPoint(double x,
                double y,
                java.lang.String srsName)
         throws InvalidMessageException
Constructs this object with the given coordinates and SRS name. The position location is created internally.

Parameters:
x - the WayPoint X ordinate.
y - the WayPoint Y ordinate.
srsName - the spatial reference system to which the data will be projected in EPSG:XXXX format.
Throws:
InvalidMessageException

WayPoint

public WayPoint(com.mapinfo.miaware.xls.WayPointType wayPointType)
         throws InvalidMessageException
Constructs this object with the stub object.

Parameters:
wayPointType - the WayPointType stub object.
Throws:
InvalidMessageException - if the stub object is null.
Method Detail

getLocation

public Location getLocation()
Returns the WayPoint location.

Returns:
the WayPoint location.

setLocation

public void setLocation(Location location)
Sets the new WayPoint location.

Parameters:
location - the WayPoint location.

getGeocodeMatchCode

public GeocodingQOS getGeocodeMatchCode()
Returns the geocode match type that provides information on the quality of the match operation (accuracy and match code).

Returns:
the Geocode match code.

setGeocodeMatchCode

public void setGeocodeMatchCode(GeocodingQOS geocodeMatchCode)
Sets the new geocode match type.

Parameters:
geocodeMatchCode - the Geocode match code.

isStop

public boolean isStop()
Returns the stop flag that specifies whether the traveler plans to stop at the waypoint, or simply pass through it.

Returns:
boolean value for the stop flag. True represents a stop, false represents a pass through.

setStop

public void setStop(boolean stop)
Sets the new stop flag.

Parameters:
stop - boolean value for the stop flag. True represents a stop, false represents a pass through.

toString

public java.lang.String toString()
Returns the string representation of the WayPoint.

Returns:
the string representation of the WayPoint.

toXLS

public com.mapinfo.miaware.xls.WayPointType toXLS()
Returns a new WayPointType object from this object.

Returns:
a WayPointType stub object.

v4.1

MapInfo Corporation Copyright[2006]. All rights reserved