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

Glossary Item Box

The MarketPenetrationParameters class provides input parameters for the Market Penetration task.

Object Model

MarketPenetrationParameters ClassExtentData ClassBoundaries ClassPointLayer ClassFolderItem ClassFolderItem ClassOutputTypes ClassRenderingParameters ClassBAResultType ClassReportOptions Class

Syntax

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent parameter is specified. The optional SingleAreaID parameter restrict the analysis to a single area of the boundary layer.

Market penetration options:

  • The UseGeographyLevel parameter specifies the use of a geography layer or not (default) in the calculation of market penetration. If the geography layer is in use, the DataHierarchy parameter can be specified.
  • The TotalMarketCountField parameter specifies the total market count field from the geography layer if the last one is in use or from the boundary layer otherwise.
  • The CustomerWeightField parameter can specify a weight field in the customer layer for calculating a weight rather than number of customers, Sales for example.

Output options for this task include rendering an output image (OutputTypes.GetMapImage), creating a feature class for subsequent analysis (OutputTypes.GetFeatureClass), and/or creating a report (OutputTypes.GetReport). If no output options are specified, the required output options are specified as follows. If the RenderingParameters parameter is specified, the image output is requested. If the StandardReportOptions parameter is specified, the report is requested. If the OutputAnalysisItem parameter is specified, the output analysis feature class will be stored in the repository. If RenderingParameters, StandardReportOptions, and OutputAnalysisItem parameters are missing, the feature class output is requested.

Example

The code snippet below creates MarketPenetrationParameters and then executes a Market Penetration task.
C#Copy Code
MarketPenetrationParameters parameters = new MarketPenetrationParameters();
             
// The PointLayer type could take either data as
// ESRI.ArcGIS.Client.Tasks.FeatureSet, ESRI.ArcGIS.Client.BAServer.FolderItem,
// or a list of ESRI.ArcGIS.Client.BACore.PointRecord items, e.g.
//List<PointRecord> points = new List<PointRecord>() {
//    new PointRecord("Customer 1", "Steiner St. & Geary Blvd", "1", 37.78415, -122.4346)};
             
// Set Customers as a list of PointRecord using implicit cast operator.
parameters.Customers = points;
             
// 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.
parameters.Boundaries = boundaries;
            
// Set name of area description field in the Boundaries layer.
parameters.AreaDescField = "Area_Desc";
             
// Set total market count field name.
parameters.TotalMarketCountField = totalMarketCountField;
             
// Optionally restrict analysis to ExtendData object specified with myExtent.
//parameters.AnalysisExtent = myExtent;
             
marketPenetrationTask.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.AnalysisAndReportParameters
            ESRI.ArcGIS.Client.BAServer.Tasks.Reports.MarketPenetrationParameters

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.