FRAMES | NO FRAMES
SimpleRings Method

Creates a new feature layer of ring-based trade area using a set of radii.

Availability: Business Analyst Server, Business Analyst Online.

TaskResultOutput SimpleRings ( 
    SimpleRingsParameters  Parameters, 
    esriReportFormat       ReportFormat, 
    RenderingParameters    RenderingParameters, 
    TaskOutputType[]       OutputTypes, 
    esriFolderItem         OutputAnalysisItem, 
    esriFolderItem[]       OutputReportItems
);
 

Parameter Description
Parameters Configuration options for trade area creation. Type SimpleRingsParameters.
ReportFormat This parameter should be null. This parameter is deprecated. Available with Business Analyst Server.
RenderingParameters Configuration options for rendering output when GetMapImage option is specified in the OutputTypes parameter. Type RenderingParameters.
OutputTypes Array of task output options. Options for this method include rendering output image (GetMapImage), creating a feature layer for subsequent analysis (GetFeatureClass), and creating a report (GetReport). Type TaskOutputType[].
OutputAnalysisItem (Optional parameter — can be null).
Configuration options for storing the output feature layer in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem. Available with Business Analyst Server.
OutputReportItems (Optional parameter - can be null).
Array of configuration options for storing the output reports in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem[]. Available with Business Analyst Server 10.0.

Returns

Variable of type TaskResultOutput

Remarks

Use the SimpleRings method when you want to create ring-based trade areas around your Business Analyst store layer. This is particularly useful for creating new trade areas that can be used to create Business Analyst reports and maps.

For example, suppose you are studying the sales for an existing network of store locations. You want to examine the underlying population for each of the stores for a 1, 3, and 5 mile radius. You can create simple rings and use other Business Analyst methods to determine the underlying demographic characteristics for each ring. You can also determine how many customers are in each ring and create a penetration report that compares the number of customers in each ring to the total population.

NOTE: Since Business Analyst Server 10.0, the OutputReportItem parameter is replaced with the OutputReportItems parameter which is an array of folder items. The number of items in this array should be equal to the number of items in the ReportOptions array.

Donut rings

Bands are created in the output feature layer by checking the Donut option. For example, if three radii are entered with values of 1, 3, and 5 miles, three output bands would be created with 0–1, 1–3, and 3–5 mile rings.


Set the Donut option to true to create bands. The image below illustrates a 1–3 mile donut ring.

Usage Tips


Examples

The example below generates ring-based donut trade areas and summarization reports based on the derived areas.

NOTE: The signature of the BAServerHelper.SimpleRings method is made compatible with the previous version of this method—the OutputReportItems parameter is specified with the params keyword allowing users to pass output report items in the variable-length list of parameters.

C#
// Instantiate the BAServerHelper class to access analysis methods
BAServerHelper baServerHelper = new BAServerHelper();
baServerHelper.ActiveDatasetID = "USA_ESRI"; // Optional parameter
baServerHelper.IsFullErrorMessage = true;    // Default is false
 
// You can specify below a domain of your local Business Analyst Server.
//baServerHelper.BAServerDomain = "esri.com";
 
// If a domain name is specified, a local server name in output URLs is replaced with the
// fully-addressable server name so people and machines outside the domain of your local
// Business Analyst Server instance can access these URLs.
 
PointRecord[] storePoints = new PointRecord[1];
 
storePoints[0] = new PointRecord();
storePoints[0].Name = "store_study_site";
storePoints[0].Description = "Store Study Site";
storePoints[0].StoreID = "1";
storePoints[0].Latitude = 34.057596;
storePoints[0].Longitude = -117.195683;
storePoints[0].StoreAddress = "Store Address";
 
// Create a store feature layer based on an array of point records.
PointLayer storeLayer = new PointLayer();
storeLayer.Points = storePoints;
 
SimpleRingsParameters parameters = new SimpleRingsParameters();
 
// Set specific analysis parameters
parameters.DistanceUnits = esriUnits.esriMiles;
parameters.Donut = true;
parameters.Radii = new double[] { 1, 2, 3 };
parameters.SingleStoreID = "1";
parameters.Stores = storeLayer;
 
// StoreIDField is useless for stores specified with array of PointRecord
//parameters.StoreIDField = "STORE_ID";
 
// Set summary report parameters
ReportOptions ageReport = new ReportOptions();
ageReport.ReportFormat = "PDF";
ageReport.TemplateName = "Age by Income Profile";
 
ReportOptions ageSexReport = new ReportOptions();
ageSexReport.ReportFormat = "HTML";
ageSexReport.TemplateName = "Age by Sex Profile";
 
ReportOptions demoReport = new ReportOptions();
demoReport.ReportFormat = "PDF";
demoReport.TemplateName = "Demographic and Income Report";
parameters.ReportOptions = new ReportOptions[] { ageReport, ageSexReport, demoReport };
 
// Set other parameters
RenderingParameters imageOptions = null;
TaskOutputType[] outputOptions = new TaskOutputType[] { TaskOutputType.GetFeatureClass, TaskOutputType.GetReport };
esriFolderItem outputLayer = null;
esriFolderItem outputReport = null;
 
TaskResultOutput result = baServerHelper.SimpleRings(parameters, imageOptions, outputOptions, outputLayer, outputReport);
 
ReportInfo[] reports = result.Reports;

See Also