Packagecom.esri.bacore.domain
Classpublic class MeanBenchmark
InheritanceMeanBenchmark Inheritance Object

Since : Community Analyst API for Flex 2.2.

The MeanBenchmark class provides average or median benchmark options accompanied with user-friendly name.



Public Properties
 PropertyDefined By
  name : String
User-friendly name of this instance.
MeanBenchmark
  options : BenchmarkOptions
[read-only] Benchmark options associated with this instance.
MeanBenchmark
Public Methods
 MethodDefined By
  
MeanBenchmark(options:BenchmarkOptions, name:String = null)
Creates a new instance of the MeanBenchmark class.
MeanBenchmark
  
createAverageBenchmark(name:String = Average of Sites):MeanBenchmark
[static] Creates a new average benchmark.
MeanBenchmark
  
createMedianBenchmark(name:String = Median of Sites):MeanBenchmark
[static] Creates a new median benchmark.
MeanBenchmark
Property Detail
nameproperty
name:String

User-friendly name of this instance.


Implementation
    public function get name():String
    public function set name(value:String):void
optionsproperty 
options:BenchmarkOptions  [read-only]

Benchmark options associated with this instance.

This value is either BenchmarkOptions.USE_AVERAGE_VALUES or BenchmarkOptions.USE_MEDIAN_VALUES.


Implementation
    public function get options():BenchmarkOptions
Constructor Detail
MeanBenchmark()Constructor
public function MeanBenchmark(options:BenchmarkOptions, name:String = null)

Creates a new instance of the MeanBenchmark class.

The options parameter should be either BenchmarkOptions.USE_AVERAGE_VALUES or BenchmarkOptions.USE_MEDIAN_VALUES. Otherwise, an ArgumentError will be thrown.

Parameters
options:BenchmarkOptions — Benchmark options.
 
name:String (default = null) — User-friendly name of this instance.
Method Detail
createAverageBenchmark()method
public static function createAverageBenchmark(name:String = Average of Sites):MeanBenchmark

Creates a new average benchmark.

Parameters

name:String (default = Average of Sites) — User-friendly name of the benchmark.

Returns
MeanBenchmark — A new instance of the benchmark.
createMedianBenchmark()method 
public static function createMedianBenchmark(name:String = Median of Sites):MeanBenchmark

Creates a new median benchmark.

Parameters

name:String (default = Median of Sites) — User-friendly name of the benchmark.

Returns
MeanBenchmark — A new instance of the benchmark.