The GamePlanMapParameters class provides input parameters for the Game Plan Map task.

Object Model

Syntax

Visual Basic (Declaration)

Public Class GamePlanMapParameters 
   Inherits ESRI.ArcGIS.Client.BAServer.Tasks.AnalysisAndReportParameters
   Implements ESRI.ArcGIS.Client.BACore.Client.IBADatasetParameters, ESRI.ArcGIS.Client.BACore.Client.IBATaskParameters

public class GamePlanMapParameters : ESRI.ArcGIS.Client.BAServer.Tasks.AnalysisAndReportParameters, ESRI.ArcGIS.Client.BACore.Client.IBADatasetParameters, ESRI.ArcGIS.Client.BACore.Client.IBATaskParameters

Remarks

The AnalysisExtent parameter specifies the market area to thematically shade locations in. The SegmentationBase parameter specifies the base for assignment segments to geography sites. The SegmentationLevel parameter specifies the ID of a segmentation level.

There are two ways for dividing the Tapestry segments into categories—explicit specification of Core, Developmental, Niche, and Other segments, and categorizing segments on the base of a Game Plan Chart.

In the case of explicit specification, the DefineSegmentsExplicitly parameter should have the true value and the optional CoreSegments, DevelopmentalSegments, and NicheSegments parameters can specify the categorization of segments by explicit enumerating the IDs of segments belonging to their categories. If a Tapestry segment is missing in all these categories, it is considered to belong to the category of other segments. At least one category should be nonempty. For example, you can specify the core segments only and do not have to specify other categories.

In the case of using the Game Plan Chart, the DefineSegmentsExplicitly parameter should have the false value and two tapestry segmentation profiles should be specified—the base profile (BaseProfile parameter) is used for calculating the index and the target profile (TargetProfile parameter) is used for calculating the percent composition for each Tapestry segment. The IndexThreshold and PercentThreshold parameters specify positions of Index and Percent Composition axes on the Game Plan Chart. In most cases, the Index axis should be set to a value of at least 100. The Percent Composition axis should be set so you have at least three segments in the Core category. Often there will be a natural break in the percent composition values.

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 GamePlanMapParameters and then executes a Game Plan Map task.

C#	Copy Code
GamePlanMapParameters parameters = new GamePlanMapParameters(); // Set a data extent for analysis to ExtendData object specified with myExtent. parameters.AnalysisExtent = myExtent; // Set a segmentation base. parameters.SegmentationBase = "Total Households"; // Set a segmentation level ID. parameters.SegmentationLevel = "US.ZIP5"; // Define segments with the use of Game Plan Chart. parameters.DefineSegmentsExplicitly = false; // The ProfileData type could take either data as an XML string // or as ESRI.ArcGIS.Client.BAServer.FolderItem type, e.g. //FolderItem baseProfile = new FolderItem(workspaceName, projectName, FolderType.esriFolderSegProfiles, profileName); // Set a base segmentation profile as a FolderItem using implicit cast operator. parameters.BaseProfile = baseProfile; // Set a target segmentation profile. parameters.TargetProfile = targetProfile; // Set an index threshold. parameters.IndexThreshold = 110.0; // Set a percent composition threshold. parameters.PercentThreshold = 4.0; // Set report parameters. parameters.StandardReportOptions = new ReportOptions("PDF"); gamePlanMapTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Copy Code

GamePlanMapParameters parameters = new GamePlanMapParameters();
             
// Set a data extent for analysis to ExtendData object specified with myExtent.
parameters.AnalysisExtent = myExtent;
             
// Set a segmentation base.
parameters.SegmentationBase = "Total Households";
             
// Set a segmentation level ID.
parameters.SegmentationLevel = "US.ZIP5";
             
// Define segments with the use of Game Plan Chart.
parameters.DefineSegmentsExplicitly = false;
             
// The ProfileData type could take either data as an XML string
// or as ESRI.ArcGIS.Client.BAServer.FolderItem type, e.g.
//FolderItem baseProfile = new FolderItem(workspaceName, projectName, FolderType.esriFolderSegProfiles, profileName);
             
// Set a base segmentation profile as a FolderItem using implicit cast operator.
parameters.BaseProfile = baseProfile;
             
// Set a target segmentation profile.
parameters.TargetProfile = targetProfile;
             
// Set an index threshold.
parameters.IndexThreshold = 110.0;
             
// Set a percent composition threshold.
parameters.PercentThreshold = 4.0; 
             
// Set report parameters. 
parameters.StandardReportOptions = new ReportOptions("PDF");
 
gamePlanMapTask.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.Segmentation.GamePlanMapParameters

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