| Package | com.esri.baserver.tasks.tradeareas |
| Class | public final class DriveTimeTask |
| Inheritance | DriveTimeTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
Equal competition market areas do not adjust for the way people actually travel on the ground. Equal competition market areas are based on as the crow flies distances, while people in the real world have to use roads and streets. A two mile trip might take five minutes on one road network and 15 minutes on another.
Using this task, you can generate the drive time areas that use actual street networks and approximated driving times.
Pizza delivery provides a good case example for the use of drive time polygons. A company may want to limit deliveries to a total of 15 minutes. This means that the delivery radius of each store would be restricted to a 6 minute drive time (six minutes to the delivery point, three minutes at the delivery site, and six minutes to return, for a total of 15 minutes).
Overlap can occur. Some store chains solve this problem by using equal competition areas where drive time overlap occurs, to make each service zone unique and using the drive times at the edge of the built up urban areas to restrict delivery distances and times.
The result of this task is a TaskResultOutput object,
which is compatible with ArcGIS Server's mapping APIs. FeatureSet, MapImage, and an array of
ReportInfo objects can be returned in it depending on task output options requested.
Additionally, the output analysis layer and/or report can be stored to the Business Analyst Server repository.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAServerTask | |
| concurrency : String
Value that indicates how to handle multiple calls to the same task. | AbstractTask | |
| disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from
being loaded from the browser's cache. | AbstractTask | |
| isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false). | BAServerTask | |
| lastResult : TaskResultOutput [read-only]
The last result of executing the Drive Time task. | DriveTimeTask | ||
| proxyURL : String
The URL to proxy the request through. | AbstractTask | |
| requestTimeout : Number
The request timeout in seconds. | AbstractTask | |
| showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | AbstractTask | |
| token : String
Token for accessing a secure task. | AbstractTask | |
| tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | BATask | |
| url : String
URL of the task. | AbstractTask | |
| Method | Defined By | ||
|---|---|---|---|
DriveTimeTask(urlOrClient:Object = null)
Creates a new instance of the DriveTimeTask class. | DriveTimeTask | ||
Creates a new command encapsulating this task and the given parameters. | DriveTimeTask | ||
execute(parameters:DriveTimeParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Drive Time task to the Business Analyst Server HTTP (REST) Service. | DriveTimeTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = DriveTime [static] Task name. | DriveTimeTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the Drive Time task.
public function get lastResult():TaskResultOutput| DriveTimeTask | () | Constructor |
public function DriveTimeTask(urlOrClient:Object = null)Creates a new instance of the DriveTimeTask class.
A new task can be constructed in two ways: as a task sharing a BAServerClient type instance
with other tasks (the urlOrClient parameter has the BAServerClient type) or
as a standalone task encapsulating its own client.
The base URL to the Business Analyst Server HTTP Service looks as follows:
http://{host}:{port}/ArcGIS/baserver/REST/services/DefaultMap/BAServer
The {host} and {port} parameters in this URL should be substituted with
valid Business Analyst Server host name and port, respectively.
urlOrClient:Object (default = null) |
See also
| createCommand | () | method |
public function createCommand(parameters:DriveTimeParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:DriveTimeParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:DriveTimeParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Drive Time task to the Business Analyst Server HTTP (REST) Service.
A response can be received in two ways—in an optional
responder object passed in parameters
of this method and/or in listeners of fault and taskCompleted
events registered for this task.
The responder is notified first when a response is received and parsed.
Its fault method receives a parameter of the FaultEvent type and its
result method receives a parameter of the BATaskCompletedEvent type
whose result property contains the result object.
After that the received event is dispatched to listeners of this task.
If a response is succesfully received and parsed, the result is assigned to the
lastResult property of this task.
Parameters
parameters:DriveTimeParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = DriveTimeTask name.