RoutingRequest
extends Object| java.lang.Object | |
| ↳ | com.carto.routing.RoutingRequest |
Class Overview
A class that defines required attributes for routing (end points, etc).
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
RoutingRequest(Projection projection, MapPosVector points)
Constructs a new RoutingRequest instance from projection and via points.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| boolean |
equals(Object obj)
Checks if this object is equal to the specified object.
| ||||||||||
| Variant |
getCustomParameter(String param)
Returns the custom parameter value of the request.
| ||||||||||
| Variant |
getPointParameter(int index, String param)
Returns the parameter value for the given routing point.
| ||||||||||
| MapPosVector |
getPoints()
Returns the point list of the request.
| ||||||||||
| Projection |
getProjection()
Returns the projection of the points in the request.
| ||||||||||
| int |
hashCode()
Returns the hash value of this object.
| ||||||||||
| void |
setCustomParameter(String param, Variant value)
Sets a custom parameter value for the the request.
| ||||||||||
| void |
setPointParameter(int index, String param, Variant value)
Sets the parameter value for the given routing point.
| ||||||||||
| String |
toString()
Creates a string representation of this request object, useful for logging.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public RoutingRequest (Projection projection, MapPosVector points)
Constructs a new RoutingRequest instance from projection and via points.
Parameters
| projection | The projection of the points. |
|---|---|
| points | The list of points that the route must pass. Must contains at least 2 elements. |
Public Methods
public synchronized void delete ()
public boolean equals (Object obj)
Checks if this object is equal to the specified object.
Parameters
| obj | The reference object. |
|---|
Returns
- True when objects are equal, false otherwise.
public Variant getCustomParameter (String param)
Returns the custom parameter value of the request.
Parameters
| param | The name of the parameter to return. |
|---|
Returns
- The value of the parameter. If the parameter does not exist, empty variant is returned.
public Variant getPointParameter (int index, String param)
Returns the parameter value for the given routing point.
Parameters
| index | The routing point index. |
|---|---|
| param | The name of the parameter. |
Returns
- The value of the specified parameter of the given routing point. If the parameter does not exist, empty variant is returned.
public MapPosVector getPoints ()
Returns the point list of the request.
Returns
- The point list of the request.
public Projection getProjection ()
Returns the projection of the points in the request.
Returns
- The projection of the request.
public int hashCode ()
Returns the hash value of this object.
Returns
- The hash value of this object.
public void setCustomParameter (String param, Variant value)
Sets a custom parameter value for the the request.
Parameters
| param | The name of the parameter. For example, "trace_options.search_radius". |
|---|---|
| value | The new value for the parameter. |
public void setPointParameter (int index, String param, Variant value)
Sets the parameter value for the given routing point.
This is currently supported by Valhalla routing engine and can be used to specify initial or final heading, for example.
In addition to Valhalla, SGRE routing engine supports 'geometry_tag_filter' parameter for specifying how to filter matching edges.
Parameters
| index | The routing point index. |
|---|---|
| param | The name of the parameter to set. |
| value | The new value for the parameter of the given routing point. |
public String toString ()
Creates a string representation of this request object, useful for logging.
Returns
- The string representation of this request object.