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.
GetClassName
GetFileNames()	Files name accessor.
GetInstances()	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.
getAnalyses()	Analysis accessor.
getAnalysisByName(analysisName)	Analysis accessor.
getAvailableAnalysisName(rootName)	Available name for an analysis accessor.
getAvailableDataModelName(modelRootName)	Available name for a data model accessor.
getAvailableLimitStateName(rootName)	Available name for a limit state accessor.
getAvailablePhysicalModelName(…)	Available name for a physical model accessor.
getClassName()
getDataModelByName(dataModelName)	Data model accessor.
getDataModels()	Data model accessor.
getFileName()	File name accessor.
getId()	Accessor to the object’s id.
getImplementation(*args)	Accessor to the underlying implementation.
getLimitStates()	Limit state accessor.
getName()	Accessor to the object’s name.
getPhysicalModelByName(physicalModelName)	Physical model accessor.
getPhysicalModels()	Physical models accessor.
getPythonScript()	Python script accessor.
remove(*args)	Remove an object from the study.
save(xmlFileName)	Save it in an xml file.
setName(name)	Accessor to the object’s name.

__init__(*args)

static Add(study)

Add a study in the tree view.

Parameters:

object : Study

The study to add

static GetAvailableName(rootName)

Available name for a study accessor.

Returns:

name : str

Available name for a study

static GetFileNames()

Files name accessor.

Returns:

filesNames : openturns.Description

The file names of all the opened studies

static GetInstances()

Studies accessor.

Returns:

studies : sequence of Study

Studies existing in the tree view

static HasInstanceNamed(studyName)

Whether the tree view contains a study named with the given name.

Parameters:

name : str

A study name

Returns:

contains : bool

Whether it contains a study named with the given name

static Open(xmlFileName)

Open a study.

Parameters:

fileName : str

The file name

Returns:

study : Study

The study saved in fileName

static Remove(study)

Remove a study from the tree view.

Parameters:

object : Study

The study to remove

add(*args)

Add an object to the study.

Parameters:

object : PhysicalModel, LimitState, Analysis …

The object to add

getAnalyses()

Analysis accessor.

Returns:

analyses : sequence of Analysis

Analyses

getAnalysisByName(analysisName)

Analysis accessor.

Parameters:

name : str

The analysis name

Returns:

analysis : Analysis

Analysis

getAvailableAnalysisName(rootName)

Available name for an analysis accessor.

Returns:

name : str

Available name for an analysis

getAvailableDataModelName(modelRootName)

Available name for a data model accessor.

Returns:

name : str

Available name for a data model

getAvailableLimitStateName(rootName)

Available name for a limit state accessor.

Returns:

name : str

Available name for a limit state

getAvailablePhysicalModelName(physicalModelRootName)

Available name for a physical model accessor.

Returns:

name : str

Available name for a physical model

getDataModelByName(dataModelName)

Data model accessor.

Parameters:

name : str

The data model name

Returns:

model : DataModel

Data model

getDataModels()

Data model accessor.

Returns:

models : sequence of DataModel

Data models

getFileName()

File name accessor.

Returns:

fileName : str

The file name

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:

impl : Implementation

The implementation class.

getLimitStates()

Limit state accessor.

Returns:

states : sequence of LimitState

Limit states

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getPhysicalModelByName(physicalModelName)

Physical model accessor.

Parameters:

name : str

The model name

Returns:

model : PhysicalModel

Physical model

getPhysicalModels()

Physical models accessor.

Returns:

models : sequence of PhysicalModel

Physical models

getPythonScript()

Python script accessor.

Returns:

script : str

The Python script

remove(*args)

Remove an object from the study.

Parameters:

object : PhysicalModel, LimitState, Analysis …

The object to remove

save(xmlFileName)

Save it in an xml file.

Parameters:

fileName : str

The file name

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.