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
Accessor to the block size.
Accessor to the object’s name.
getId
()Accessor to the object’s id.
getName
()Accessor to the object’s name.
Accessor to the outer sampling.
Accessor to the object’s shadowed id.
Accessor to the object’s visibility state.
hasName
()Test if the object is named.
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
- blockSizeint
Number of terms in the probability simulation estimator grouped together.
- getClassName()¶
Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
- getId()¶
Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
- getName()¶
Accessor to the object’s name.
- Returns
- namestr
The name of the object.
- getOuterSampling()¶
Accessor to the outer sampling.
- Returns
- outerSamplingint
Number of groups of terms in the probability simulation estimator.
- getShadowedId()¶
Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
- getVisibility()¶
Accessor to the object’s visibility state.
- Returns
- visiblebool
Visibility flag.
- hasName()¶
Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
- hasVisibleName()¶
Test if the object has a distinguishable name.
- Returns
- hasVisibleNamebool
True if the name is not empty and not the default one.
- setBlockSize(blockSize)¶
Accessor to the block size.
- Parameters
- blockSizeint,
Number of terms in the probability simulation estimator grouped together.
- setName(name)¶
Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
- setOuterSampling(outerSampling)¶
Accessor to the outer sampling.
- Parameters
- outerSamplingint,
Number of groups of terms in the probability simulation estimator.
- setShadowedId(id)¶
Accessor to the object’s shadowed id.
- Parameters
- idint
Internal unique identifier.
- setVisibility(visible)¶
Accessor to the object’s visibility state.
- Parameters
- visiblebool
Visibility flag.