Documentation of the programming interface (API)

This section describes the python packages and modules of the salome.smesh python package. The main part is generated from the code documentation included in source python files.

salome.smesh – Package containing the SMESH python utilities

smeshstudytools – Tools to access SMESH objects in the study

This module provides a new class SMeshStudyTools to facilitate the use of mesh objects in Salome study.

class salome.smesh.smeshstudytools.SMeshStudyTools(studyEditor=None)

This class provides several methods to manipulate mesh objects in Salome study. The parameter studyEditor defines a StudyEditor object used to access the study. If None, the method returns a StudyEditor object on the current study.

editor

This instance attribute contains the underlying StudyEditor object. It can be used to access the study but the attribute itself should not be modified.

getMeshFromGroup(meshGroupItem)

Get the mesh item owning the mesh group meshGroupItem.

Parameters:meshGroupItem (SObject) – Mesh group belonging to the searched mesh. Returns:The SObject corresponding to the mesh, or None if it was not found.