Study¶
- class persalys.Study(*args)¶
Create the class to store a study.
Methods
Add
(study)Add a study in the tree view.
GetAvailableName
(rootName)Available name for a study accessor.
Files name accessor.
GetInstanceByName
(studyName)Study accessor.
Studies accessor.
HasInstanceNamed
(studyName)Whether the tree view contains a study named with the given name.
Open
(xmlFileName)Open a study.
Remove
(study)Remove a study from the tree view.
add
(*args)Add an object to the study.
Analysis accessor.
getAnalysisByName
(analysisName)Analysis accessor.
getAvailableAnalysisName
(rootName)Available name for an analysis accessor.
getAvailableDataFieldModelName
(modelRootName)Available name for a data field model accessor.
getAvailableDataModelName
(modelRootName)Available name for a data model accessor.
getAvailableLimitStateName
(rootName)Available name for a limit state accessor.
Available name for a physical model accessor.
Accessor to the object's name.
getDataFieldModelByName
(dataModelName)Data field model accessor.
Data field model accessor.
getDataModelByName
(dataModelName)Data model accessor.
Data model accessor.
File name accessor.
getId
()Accessor to the object's id.
Accessor to the underlying implementation.
Limit state accessor.
getName
()Accessor to the object's name.
getPhysicalModelByName
(physicalModelName)Physical model accessor.
Physical models accessor.
Python script accessor.
hasAnalysisNamed
(name)Whether it contains an analysis named with the given name.
hasDataModelNamed
(name)Whether it contains a data model named with the given name.
hasLimitStateNamed
(name)Whether it contains a limit state named with the given name.
hasPhysicalModelNamed
(name)Whether it contains a physical model named with the given name.
remove
(*args)Remove an object from the study.
save
(xmlFileName)Save it in an xml file.
setName
(name)Accessor to the object's name.
hasDataFieldModelNamed
- __init__(*args)¶
- static GetAvailableName(rootName)¶
Available name for a study accessor.
- Returns:
- namestr
Available name for a study
- static GetFileNames()¶
Files name accessor.
- Returns:
- filesNames
openturns.Description
The file names of all the opened studies
- filesNames
- static GetInstanceByName(studyName)¶
Study accessor.
- Parameters:
- namestr
The study name
- Returns:
- study
Study
Study
- study
- static GetInstances()¶
Studies accessor.
- Returns:
- studiessequence of
Study
Studies existing in the tree view
- studiessequence of
- static HasInstanceNamed(studyName)¶
Whether the tree view contains a study named with the given name.
- Parameters:
- namestr
A study name
- Returns:
- containsbool
Whether it contains a study named with the given name
- static Open(xmlFileName)¶
Open a study.
- Parameters:
- fileNamestr
The file name
- Returns:
- study
Study
The study saved in fileName
- study
- add(*args)¶
Add an object to the study.
- Parameters:
- object
PhysicalModel
,LimitState
,Analysis
… The object to add
- object
- getAnalysisByName(analysisName)¶
Analysis accessor.
- Parameters:
- namestr
The analysis name
- Returns:
- analysis
Analysis
Analysis
- analysis
- getAvailableAnalysisName(rootName)¶
Available name for an analysis accessor.
- Returns:
- namestr
Available name for an analysis
- getAvailableDataFieldModelName(modelRootName)¶
Available name for a data field model accessor.
- Returns:
- namestr
Available name for a data field model
- getAvailableDataModelName(modelRootName)¶
Available name for a data model accessor.
- Returns:
- namestr
Available name for a data model
- getAvailableLimitStateName(rootName)¶
Available name for a limit state accessor.
- Returns:
- namestr
Available name for a limit state
- getAvailablePhysicalModelName(physicalModelRootName)¶
Available name for a physical model accessor.
- Returns:
- namestr
Available name for a physical model
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getDataFieldModelByName(dataModelName)¶
Data field model accessor.
- Parameters:
- namestr
The data field model name
- Returns:
- model
DataFieldModel
Data field model
- model
- getDataFieldModels()¶
Data field model accessor.
- Returns:
- modelssequence of
DataFieldModel
Data field models
- modelssequence of
- getDataModelByName(dataModelName)¶
Data model accessor.
- Parameters:
- namestr
The data model name
- Returns:
- model
DataModel
Data model
- model
- getFileName()¶
File name accessor.
- Returns:
- fileNamestr
The file name
- 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.
- getLimitStates()¶
Limit state accessor.
- Returns:
- statessequence of
LimitState
Limit states
- statessequence of
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getPhysicalModelByName(physicalModelName)¶
Physical model accessor.
- Parameters:
- namestr
The model name
- Returns:
- model
PhysicalModel
Physical model
- model
- getPhysicalModels()¶
Physical models accessor.
- Returns:
- modelssequence of
PhysicalModel
Physical models
- modelssequence of
- getPythonScript()¶
Python script accessor.
- Returns:
- scriptstr
The Python script
- hasAnalysisNamed(name)¶
Whether it contains an analysis named with the given name.
- Parameters:
- namestr
An analysis name
- Returns:
- containsbool
Whether it contains an analysis named with the given name
- hasDataModelNamed(name)¶
Whether it contains a data model named with the given name.
- Parameters:
- namestr
A data model name
- Returns:
- containsbool
Whether it contains a data model named with the given name
- hasLimitStateNamed(name)¶
Whether it contains a limit state named with the given name.
- Parameters:
- namestr
A limit state name
- Returns:
- containsbool
Whether it contains a limit state named with the given name
- hasPhysicalModelNamed(name)¶
Whether it contains a physical model named with the given name.
- Parameters:
- namestr
A physical model name
- Returns:
- containsbool
Whether it contains a physical model named with the given name
- remove(*args)¶
Remove an object from the study.
- Parameters:
- object
PhysicalModel
,LimitState
,Analysis
… The object to remove
- object
- save(xmlFileName)¶
Save it in an xml file.
- Parameters:
- fileNamestr
The file name
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.