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(self)	Accessor to the block size.
getClassName(self)	Accessor to the object’s name.
getId(self)	Accessor to the object’s id.
getName(self)	Accessor to the object’s name.
getOuterSampling(self)	Accessor to the outer sampling.
getShadowedId(self)	Accessor to the object’s shadowed id.
getVisibility(self)	Accessor to the object’s visibility state.
hasName(self)	Test if the object is named.
hasVisibleName(self)	Test if the object has a distinguishable name.
setBlockSize(self, blockSize)	Accessor to the block size.
setName(self, name)	Accessor to the object’s name.
setOuterSampling(self, outerSampling)	Accessor to the outer sampling.
setShadowedId(self, id)	Accessor to the object’s shadowed id.
setVisibility(self, visible)	Accessor to the object’s visibility state.

__init__(self, \*args)

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

getBlockSize(self)

Accessor to the block size.

Returns

blockSizeint

Number of terms in the probability simulation estimator grouped together.

getClassName(self)

Accessor to the object’s name.

Returns

class_namestr

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

getId(self)

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns

namestr

The name of the object.

getOuterSampling(self)

Accessor to the outer sampling.

Returns

outerSamplingint

Number of groups of terms in the probability simulation estimator.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns

visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool

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

setBlockSize(self, blockSize)

Accessor to the block size.

Parameters

blockSizeint,

Number of terms in the probability simulation estimator grouped together.

setName(self, name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setOuterSampling(self, outerSampling)

Accessor to the outer sampling.

Parameters

outerSamplingint,

Number of groups of terms in the probability simulation estimator.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.