RandomNumberGenerator Object

The RandomNumberGenerator object allows the user the flexibility to specify any of the included algorithms to generate a random number. The user can set the seed for each RandomNumberGenerator object individually, which allows the pseudo-random number generators to generate consistent number sequences between multiple runs.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Seed	Specifies the seed to use for the random number generator. The default value is randomized when a Mission Plan is run.	Type: Variable Access: Read/Write

Name	Description
CauchyDistribution	Returns a random number based on a continuous probability distribution which is used to describe resonance behavior.
ClearSavedStates	Clears previous saved states for this object.
GammaDistribution	Returns a random number based on a normal distribution whose frequency function involves the gamma function.
GaussianDistribution	Returns a random number with a Gaussian probability distribution defined by the specified mean and standard deviation.
GenerateSeed	Generates a random seed independent of the current RandomNumberGenerator.Seed property.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
IntegerUniformDistribution	Returns a random integer that is uniformly distributed over the specified range [min, max].
LogisticDistribution	Returns a random number based on a probability distribution of a random variable whose cumulative distribution function is the logistic function.
LogNormalDistribution	Returns a random number based on a probability distribution of a random variable whose logarithm is normally distributed.
PoissonDistribution	Returns a random number based on the time between events in a Poisson process (e.g. events occur continuously and independently at a constant average rate).
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
TriangleDistribution	Returns a random number based on a continuous probability distribution defined on the range using the probability density and distribution functions.
UniformDistribution	Returns a random number that is uniformly distributed over the specified range [min, max).

RandomNumberGenerator Object

Description

Available In Editions:

Timing Precision Mode