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.
`GetFileNames`()	Files name accessor.
`GetInstanceByName`(studyName)	Study 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.
`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.
`getAvailablePhysicalModelName`(...)	Available name for a physical model accessor.
`getClassName`()	Accessor to the object's name.
`getDataFieldModelByName`(dataModelName)	Data field model accessor.
`getDataFieldModels`()	Data field model accessor.
`getDataModelByName`(dataModelName)	Data model accessor.
`getDataModels`()	Data model accessor.
`getFileName`()	File name accessor.
`getId`()	Accessor to the object's id.
`getImplementation`()	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.
`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 Add(study)¶

Add a study in the tree view.

Parameters:

objectStudy: The study to add

static GetAvailableName(rootName)¶

Available name for a study accessor.

Returns:

namestr: Available name for a study

static GetFileNames()¶

Files name accessor.

Returns:

filesNamesopenturns.Description: The file names of all the opened studies

static GetInstanceByName(studyName)¶

Study accessor.

Parameters:

namestr: The study name

Returns:

studyStudy: Study

static GetInstances()¶

Studies accessor.

Returns:

studiessequence of Study: Studies existing in the tree view

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:

studyStudy: The study saved in fileName

static Remove(study)¶

Remove a study from the tree view.

Parameters:

objectStudy: The study to remove

add(*args)¶

Add an object to the study.

Parameters:

objectPhysicalModel, LimitState, Analysis …: The object to add

getAnalyses()¶

Analysis accessor.

Returns:

analysessequence of Analysis: Analyses

getAnalysisByName(analysisName)¶

Analysis accessor.

Parameters:

namestr: The analysis name

Returns:

analysisAnalysis: 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:

modelDataFieldModel: Data field model

getDataFieldModels()¶

Data field model accessor.

Returns:

modelssequence of DataFieldModel: Data field models

getDataModelByName(dataModelName)¶

Data model accessor.

Parameters:

namestr: The data model name

Returns:

modelDataModel: Data model

getDataModels()¶

Data model accessor.

Returns:

modelssequence of DataModel: Data models

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

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:

modelPhysicalModel: Physical model

getPhysicalModels()¶

Physical models accessor.

Returns:

modelssequence of PhysicalModel: Physical models

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:

objectPhysicalModel, LimitState, Analysis …: The object to remove

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.

Study¶

Previous topic

Next topic

This Page