Package | com.esri.bao.tasks.tradeareas |
Class | public final class SimpleRingsTask |
Inheritance | SimpleRingsTask BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
Simple Rings analysis using the donut
parameter option creates output ring-based
trade/service areas that are in bands instead of concentric overlapping rings.
For example, if three radii are entered with values of one, three, and five miles, three output bands
would be created with 0-1, 1–3, and 3–5 mile trade/service area rings instead of 0-1, 0-3, and 0-5 mile rings.
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 Simple Rings include the following:
The Simple Rings task trade/service areas differs significantly from the Drive Time task trade/service areas, which define these areas based on driving times or driving distances from the origin points over a street network. In highly urbanized areas, Drive Time may be a more logical choice for analysis since it takes into account the street network surrounding the store/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 SimpleRings task. | SimpleRingsTask | ||
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 | ||
---|---|---|---|
SimpleRingsTask(urlOrClient:Object = null)
Creates a new instance of the SimpleRingsTask class. | SimpleRingsTask | ||
Creates a new command encapsulating this task and the given parameters. | SimpleRingsTask | ||
execute(parameters:SimpleRingsParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a SimpleRings task to the Community Analyst HTTP (REST) Service. | SimpleRingsTask |
Constant | Defined By | ||
---|---|---|---|
name : String = report/SimpleRings [static] Task name. | SimpleRingsTask |
lastResult | property |
lastResult:TaskResultOutput
[read-only] The last result of executing the SimpleRings task.
public function get lastResult():TaskResultOutput
SimpleRingsTask | () | Constructor |
public function SimpleRingsTask(urlOrClient:Object = null)
Creates a new instance of the SimpleRingsTask 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 ) — A variable containing either Community Analyst HTTP Service base URL string or an
instance of the BAOnlineClient class.
|
See also
createCommand | () | method |
public function createCommand(parameters:SimpleRingsParameters, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
Parameters
parameters:SimpleRingsParameters — Parameters of a task to be executed.
| |
commandName:String (default = null ) — Command name.
|
BACommand — A new command.
|
execute | () | method |
public function execute(parameters:SimpleRingsParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a SimpleRings 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:SimpleRingsParameters — Parameters of the task.
| |
responder:IResponder (default = null ) — A responder to call on result or fault.
|
AsyncToken — Asynch token associated with the response.
|
name | Constant |
public static const name:String = report/SimpleRings
Task name.