Packagecom.esri.bao.tasks.tradeareas
Classpublic class DriveTimeParameters
InheritanceDriveTimeParameters Inheritance SummaryReportParameters Inheritance BATaskParameters Inheritance Object

The DriveTimeParameters class provides input parameters for the Drive Time task.

Output options for this task include creating a feature class for subsequent analysis (outputTypes.getFeatureClass), rendering an output image (outputTypes.getMapImage), and creating a report (outputTypes.getReport). If no output options are specified, the required output options are specified as follows. If the reportOptions parameter is specified, the report output is requested. Otherwise, the feature class output is requested.

View the examples

See also

DriveTimeTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  distanceUnits : DriveTimeUnits
The time or distance units of the radii parameter which is used to calculate the Drive Time trade/service areas.
DriveTimeParameters
  donut : Boolean
Whether to create non-overlapping donut-style Drive Time trade/service area bands instead of overlapping areas that all originate from the store/point origins.
DriveTimeParameters
  outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in.
DriveTimeParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
  radii : Array
An array of Drive Time times or distances in the units specified in the distanceUnits parameter.
DriveTimeParameters
 InheritedreportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type.
SummaryReportParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
  storeIDField : String
The attribute field name in the input stores parameter which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations).
DriveTimeParameters
  stores : PointLayer
A point layer containing point features such as businesses, hospitals, schools, etc., which represent the locations from which the Drive Time trade/service areas will originate.
DriveTimeParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
Public Methods
 MethodDefined By
  
DriveTimeParameters(outputTypes:OutputTypes = null)
Creates a new instance of the DriveTimeParameters class.
DriveTimeParameters
Property Detail
distanceUnitsproperty
distanceUnits:DriveTimeUnits

The time or distance units of the radii parameter which is used to calculate the Drive Time trade/service areas.

The default value is DriveTimeUnits.DRIVE_MINUTES.


Implementation
    public function get distanceUnits():DriveTimeUnits
    public function set distanceUnits(value:DriveTimeUnits):void
donutproperty 
donut:Boolean

Whether to create non-overlapping donut-style Drive Time trade/service area bands instead of overlapping areas that all originate from the store/point origins.

The default value is false.


Implementation
    public function get donut():Boolean
    public function set donut(value:Boolean):void
outputSpatialReferenceproperty 
outputSpatialReference:SpatialReference

The spatial reference to return the output feature set in.


Implementation
    public function get outputSpatialReference():SpatialReference
    public function set outputSpatialReference(value:SpatialReference):void
radiiproperty 
radii:Array

An array of Drive Time times or distances in the units specified in the distanceUnits parameter. This property expects an array containing one or more positive numerical values. Drive Time distances should be limited to 90 minutes. Realistic analyses on trade/service areas beyond this value should be executed using trade/service areas derived from straight-line distances such as with the Simple Rings task.


Implementation
    public function get radii():Array
    public function set radii(value:Array):void

See also

SimpleRingsTask
storeIDFieldproperty 
storeIDField:String

The attribute field name in the input stores parameter which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations).

The default value is "STORE_ID".


Implementation
    public function get storeIDField():String
    public function set storeIDField(value:String):void
storesproperty 
stores:PointLayer

A point layer containing point features such as businesses, hospitals, schools, etc., which represent the locations from which the Drive Time trade/service areas will originate. In situations where the input stores parameter does not contain a field named "STORE_ID" (case insensitive), specification of the storeIDField parameter is required so the analyses can be properly executed.


Implementation
    public function get stores():PointLayer
    public function set stores(value:PointLayer):void
Constructor Detail
DriveTimeParameters()Constructor
public function DriveTimeParameters(outputTypes:OutputTypes = null)

Creates a new instance of the DriveTimeParameters class.

Parameters
outputTypes:OutputTypes (default = null) — Task output types.
Examples
ActionScript to create DriveTimeParameters and then use in the DriveTimeTask: 
                     
     var parameters : DriveTimeParameters = new DriveTimeParameters();
     
     // stores is a PointLayer that could take either data as type 
     // com.esri.ags.tasks.FeatureSet or an array of com.esri.bacore.PointRecord types, e.g.
     //var points:Array = [new PointRecord("store_1", "Store 1", "1", 34.052074, -117.207841)];
     parameters.stores = new PointLayer(points);
     
     // DriveTimeUnits.DRIVE_MINUTES is the default value for distanceUnits.
     parameters.distanceUnits = DriveTimeUnits.DRIVE_MINUTES;
     
     parameters.radii = [ 3,5,10 ];
     
     // false is the default value for donut.
     //parameters.donut = false;
     
     // STORE_ID is the default value for storeIDField.
     //parameters.storeIDField = "STORE_ID";
     
     // Set report options.
     var reportOptions:ReportOptions = new ReportOptions("PDF", "market_profile");
     reportOptions.header = new ReportHeader("3-5-7 Min Drive Time Study Areas");
     parameters.reportOptions = [ reportOptions ];
     
     driveTimeTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00