com.esri.arcgis.geoprocessing
Interface IGPRandomNumberGenerator

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPRandomNumberGenerator

public interface IGPRandomNumberGenerator
extends Serializable

Provides access to the properties/methods of a geoprocessing random number generator object.

Product Availability

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

Method Summary

int	getSeed() Gets the value, as a non-negative long, of the seed.
int	getType() Gets the random number generator type.
double	getValue(String distribution) Generates the next random number value.
void	initialize(int seed, int type) Initializes random generator seed and type.
void	reset() Resets random number generator seed, type stays unchanged.

Method Detail

getSeed

int getSeed()
            throws IOException,
                   AutomationException

Gets the value, as a non-negative long, of the seed.

Product Availability

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

Returns:

The pSeed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

Gets the random number generator type.

Product Availability

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

Returns:

A com.esri.arcgis.geoprocessing.esriRandomNumberGeneratorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(int seed,
                int type)
                throws IOException,
                       AutomationException

Initializes random generator seed and type.

Product Availability

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

Parameters:

seed - The seed (in)

type - A com.esri.arcgis.geoprocessing.esriRandomNumberGeneratorType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets random number generator seed, type stays unchanged.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

double getValue(String distribution)
                throws IOException,
                       AutomationException

Generates the next random number value.

Product Availability

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

Parameters:

distribution - The distribution (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.