public class

StopGraphic

extends Graphic
java.lang.Object
   ↳ com.esri.core.map.Graphic
     ↳ com.esri.core.tasks.na.StopGraphic

Class Overview

Class providing some convenient methods for setting attributes of a Graphic that are related to routing.

Summary

[Expand]
Inherited Fields
From class com.esri.core.map.Graphic
Public Constructors
StopGraphic(Geometry geometry)
Constructor taking the geometry for the stop graphic.
StopGraphic(Geometry geometry, Map<String, Object> attributes)
Constructor taking the geometry and list of attributes for the stop graphic.
StopGraphic(Graphic graphic)
Constructor taking a Graphic and creating a StopGraphic from it.
Public Methods
double getAddedCost(String attributeName)
Get the amount of additional cost that has been added for a particular attribute on this Stop.
String getName()
Gets the name of the stop
String getRouteName()
Gets the name of the route this stop belongs to
int getSequence()
Gets the sequence in which this stop should be visited (e.g.
Date getTimeWindowEnd()
Gets the end of the time window for visiting this stop (e.g.
Date getTimeWindowStart()
Gets the start of the time window for visiting this stop (e.g.
void setAddedCost(String attributeName, double value)
Set the amount of additional cost for an attribute by name.
void setName(String name)
Sets the name of the stop
void setRouteName(String routeName)
Sets the name of the route this stop belongs to
void setSequence(int sequence)
Sets the sequence in which this stop should be visited (e.g.
void setTimeWindowEnd(Date timeWindowEnd)
Sets the end of the time window for visiting this stop (e.g.
void setTimeWindowStart(Date timeWindowStart)
Sets the start of the time window for visiting this stop (e.g.
[Expand]
Inherited Methods
From class com.esri.core.map.Graphic
From class java.lang.Object
From interface com.esri.core.map.Feature

Public Constructors

public StopGraphic (Geometry geometry)

Constructor taking the geometry for the stop graphic.

public StopGraphic (Geometry geometry, Map<String, Object> attributes)

Constructor taking the geometry and list of attributes for the stop graphic.

public StopGraphic (Graphic graphic)

Constructor taking a Graphic and creating a StopGraphic from it.

Public Methods

public double getAddedCost (String attributeName)

Get the amount of additional cost that has been added for a particular attribute on this Stop. If no cost has been added, or an incorrect name is specified, a value of zero will be returned.

Parameters
attributeName String: The name of the attribute.
Returns
double The additional cost being added to this stop for the attribute.

public String getName ()

Gets the name of the stop

Returns
String the name of the stop

public String getRouteName ()

Gets the name of the route this stop belongs to

Returns
String the name of the route this stop belongs to

public int getSequence ()

Gets the sequence in which this stop should be visited (e.g. a value of 2 means this stop is visited second)

Returns
int the sequence in which this stop should be visited

public Date getTimeWindowEnd ()

Gets the end of the time window for visiting this stop (e.g. the latest time at which we should arrive)

Returns
Date the end of the time window for visiting this stop

public Date getTimeWindowStart ()

Gets the start of the time window for visiting this stop (e.g. the earliest time at which we should arrive)

Returns
Date the start of the time window for visiting this stop

public void setAddedCost (String attributeName, double value)

Set the amount of additional cost for an attribute by name. Any additional cost, e.g. Minutes, TravelTime, Kilometers, can be modified with this method.

Parameters
attributeName String: The name of the attribute to add additional cost to.
value double: The additional cost to add to the attribute.

public void setName (String name)

Sets the name of the stop

Parameters
name String: the name of the stop

public void setRouteName (String routeName)

Sets the name of the route this stop belongs to

Parameters
routeName String: the name of the route this stop belongs to

public void setSequence (int sequence)

Sets the sequence in which this stop should be visited (e.g. a value of 2 means this stop is visited second)

Parameters
sequence int: the sequence in which this stop should be visited

public void setTimeWindowEnd (Date timeWindowEnd)

Sets the end of the time window for visiting this stop (e.g. the latest time at which we should arrive)

Parameters
timeWindowEnd Date: the end of the time window for visiting this stop

public void setTimeWindowStart (Date timeWindowStart)

Sets the start of the time window for visiting this stop (e.g. the earliest time at which we should arrive)

Parameters
timeWindowStart Date: the start of the time window for visiting this stop