SimulationResult

class SimulationResult(*args)

EventSimulation result base class.

Notes

Structure created by the method run() of a EventSimulation, and obtained thanks to the method getResult().

Methods

getBlockSize() Accessor to the block size.
getClassName() Accessor to the object’s name.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getOuterSampling() Accessor to the outer sampling.
getShadowedId() Accessor to the object’s shadowed id.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setBlockSize(blockSize) Accessor to the block size.
setName(name) Accessor to the object’s name.
setOuterSampling(outerSampling) Accessor to the outer sampling.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

getBlockSize()

Accessor to the block size.

Returns:
blockSize : int

Number of terms in the probability simulation estimator grouped together.

getClassName()

Accessor to the object’s name.

Returns:
class_name : str

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

getOuterSampling()

Accessor to the outer sampling.

Returns:
outerSampling : int

Number of groups of terms in the probability simulation estimator.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
id : int

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleName : bool

True if the name is not empty and not the default one.

setBlockSize(blockSize)

Accessor to the block size.

Parameters:
blockSize : int, blockSize \geq 0

Number of terms in the probability simulation estimator grouped together.

setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.

setOuterSampling(outerSampling)

Accessor to the outer sampling.

Parameters:
outerSampling : int, outerSampling \geq 0

Number of groups of terms in the probability simulation estimator.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visible : bool

Visibility flag.