| Package | com.esri.bao.tasks.tradeareas |
| Class | public final class DriveTimeTask |
| Inheritance | DriveTimeTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
Drive Time trade/service areas use street networks and approximate driving times based on attributes associated with the traversed streets around the Drive Time area origins. These area origins are point features such as businesses, store fronts, organizations, agencies, hospitals, or service centers that may serve the area or region, and may have competitors or affiliates nearby.
The Drive Time analysis using the donut parameter option creates output
trade/service areas that are in bands instead of concentric overlapping areas.
For example, if three radii are entered with values of one, three, and five minutes, three output bands
would be created with 0-1, 1–3, and 3–5 minute Drive Time trade areas instead of 0-1, 0-3, and 0-5 minute
Drive Time trade areas. This will result in the creation of non-overlapping trade/service areas that will
have significantly different results in subsequent analysis such as with Summary Reports.
Some applications of Drive Time include the following:
In order to compensate for traffic patterns in the analysis task, adjust driving distances or times
(the radii parameter) accordingly. For example, if the analysis needs to be performed for
a time of day when traffic patterns are heavy (i.e. rush hour) and the drive time takes twice as long,
then enter driving distances or times that are half as long to reflect this pattern.
The Drive Time analysis task differs significantly from Simple Rings-based trade/service areas, which define these areas based on straight-line ("as the crow flies") distances from the origin points.
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.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAOnlineTask | |
| 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 | |
| lastResult : TaskResultOutput [read-only]
The last result of executing the DriveTime 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 DriveTime task to the Community Analyst HTTP (REST) Service. | DriveTimeTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/DriveTime [static] Task name. | DriveTimeTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the DriveTime 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 BAOnlineClient type instance
with other tasks (the urlOrClient parameter has the BAOnlineClient type) or
as a standalone task encapsulating its own client.
The base URL to the Community Analyst Web Services looks as follows:
http://{host}:{port}
The {host} and {port} parameters in this URL should be substituted with
valid Community Analyst host name and port, respectively.
If urlOrClient is null, the "http://baoapi.esri.com" value is assigned as the base URL.
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 DriveTime task to the Community Analyst 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 = report/DriveTimeTask name.