Analysis¶
- class persalys.Analysis(*args)¶
Analysis base class.
Methods
Accessor to the object's name.
Error message accessor.
getId
()Accessor to the object's id.
Accessor to the underlying implementation.
getName
()Accessor to the object's name.
Physical model accessor.
Warning message accessor.
Whether the analysis has been run.
Whether the analysis involves reliability.
Whether the analysis is running.
run
()Launch the analysis.
setName
(name)Accessor to the object's name.
- __init__(*args)¶
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getErrorMessage()¶
Error message accessor.
- Returns:
- messagestr
Error message if the analysis failed
- getId()¶
Accessor to the object’s id.
- Returns:
- idint
Internal unique identifier.
- getImplementation()¶
Accessor to the underlying implementation.
- Returns:
- implImplementation
A copy of the underlying implementation object.
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getPythonScript()¶
Physical model accessor.
- Returns:
- scriptstr
Python script to replay the analysis
- getWarningMessage()¶
Warning message accessor.
- Returns:
- messagestr
Warning message which can appear during the analysis computation
- hasValidResult()¶
Whether the analysis has been run.
- Returns:
- hasValidResultbool
Whether the analysis has already been run
- isReliabilityAnalysis()¶
Whether the analysis involves reliability.
- Returns:
- isReliabilityAnalysisbool
Whether the analysis involves a reliability analysis
- isRunning()¶
Whether the analysis is running.
- Returns:
- isRunningbool
Whether the analysis is running
- run()¶
Launch the analysis.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.