com.esri.arcgis.system
Interface IGenerateStatistics

All Superinterfaces:
Serializable
All Known Implementing Classes:
BaseStatistics

public interface IGenerateStatistics
extends Serializable

Provides access to members used for generating statistics.

Description

IGenerateStatistics is used after cocreating a BaseStatistics object directly rather than getting one from IDataStatistics::Statistics. You populate the object with data using the AddValue method before returning statistics. Always set the SimpleStats property to True, unless you want frequency statistics (see IFrequencyStatistics).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addValue(double value)
          Adds a data value to the collection of values used to derive the statistics.
 void finalCompute()
          May be called after all values have been added to establish frequeny table (the function is not required any more).
 void reset(boolean simpleStats)
          Clears out the currently gathered statistics.
 void setSample(boolean rhs1)
          Indicates if the statistics represent a sample of the data (used for calculating standard deviation).
 void setSimpleStats(boolean rhs1)
          Indicates if simple statistics are sufficient.
 

Method Detail

setSimpleStats

void setSimpleStats(boolean rhs1)
                    throws IOException,
                           AutomationException
Indicates if simple statistics are sufficient. These are Count, Minimum, Maximum, Sum, Mean, Standard Deviation.

Description

Set SimpleStats to True to obtain statistics using the IStatisticsResults interface, and set SimpleStats to False to obtain statistics using the IFrequencyStatistics interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSample

void setSample(boolean rhs1)
               throws IOException,
                      AutomationException
Indicates if the statistics represent a sample of the data (used for calculating standard deviation).

Description

Set Sample to True before calling IStatisticsResults::StandardDeviation if the BaseStatistics data values are a sample of the real data. Set Sample to False to retrieve the Population Standard Deviation with IStatisticsResults::StandardDeviation.

Remarks

By default IStatisticResults::StandardDeviation returns the Sample Standard Deviation, so there is no need to set the Sample property to True.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IStatisticsResults.getStandardDeviation()

reset

void reset(boolean simpleStats)
           throws IOException,
                  AutomationException
Clears out the currently gathered statistics.

Description

Removes all of the data values from the BaseStatistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
simpleStats - The simpleStats (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addValue

void addValue(double value)
              throws IOException,
                     AutomationException
Adds a data value to the collection of values used to derive the statistics.

Description

The AddValue method adds the specified data value to the BaseStatistics. After adding all of the data values you can then generate statistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finalCompute

void finalCompute()
                  throws IOException,
                         AutomationException
May be called after all values have been added to establish frequeny table (the function is not required any more).

Description

The FinalCompute method is no longer required when generating statistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.