Esri Business Analyst Server API for Silverlight 2.2 Reference
AverageDriveTimeReportParameters Class
Members  Example  See Also  Send Feedback
ESRI.ArcGIS.Client.BAServer.Tasks.Reports Namespace : AverageDriveTimeReportParameters Class

Glossary Item Box

The AverageDriveTimeReportParameters class provides input parameters for the Average Drive Time Report task.

Object Model

AverageDriveTimeReportParameters ClassBoundaries ClassFolderItem ClassOutputTypes ClassBAResultType ClassReportOptions ClassPointLayer Class

Syntax

Remarks

As a default this task uses the geographic center of the trade areas for the average drive time calculation. You can alternately choose the actual store center points if specify the Stores parameter. In this case, the AreaLinkField parameter should specify an attribute field in the input Boundaries layer containing IDs of associated stores and the optional StoreIDField parameter can specify an attribute field in the input Stores layer containing unique ID of store.

Output options for this task include creating a report (OutputTypes.GetReport). You need not specify the output options for this task because the GetReport output type is set by default.

Example

C#Copy Code
AverageDriveTimeReportParameters parameters = new AverageDriveTimeReportParameters();
            
// The Boundaries type could take either data as
// ESRI.ArcGIS.Client.Tasks.FeatureSet, ESRI.ArcGIS.Client.BAServer.FolderItem, 
// or ESRI.ArcGIS.Client.BACore.StandardLayer.
            
// Set Boundaries with a valid data type.
// It is recommended that the average drive time report be run using customer derived trade areas.
parameters.Boundaries = boundaries;
            
// Set an attribute field name which describes every trade area in the Boundaries layer.
parameters.AreaDescField = "AREA_DESC";
            
// DriveTimeUnits.esriMiles is the default value for DistanceUnits.
//parameters.DistanceUnits = DriveTimeUnits.esriMiles;
            
// The origins for average drive time calculations are either geographic centers of trade areas
// or actual store points. In the last case, you should also specify the Stores and AreaLinkField
// parameters and can specify the optional StoreIDField parameter.
//parameters.Stores = stores;
//parameters.AreaLinkField = "STORE_ID";
            
// Set report parameters. 
parameters.StandardReportOptions = new ReportOptions("PDF");
            
averageDriveTimeReportTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.BATaskParameters
      ESRI.ArcGIS.Client.BACore.Client.StandardReportParameters
         ESRI.ArcGIS.Client.BAServer.Tasks.StandardReportParameters
            ESRI.ArcGIS.Client.BAServer.Tasks.Reports.AverageDriveTimeReportParameters

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2010-2012 Esri, Inc. All Rights Reserved.