SMESH_PY.smeshstudytools.SMeshStudyTools Class Reference

Public Member Functions
def	__init__
def	getMeshFromGroup
Data Fields
	editor

---

Detailed Description

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

.. attribute:: editor

   This instance attribute contains the underlying
   :class:`~salome.kernel.studyedit.StudyEditor` object. It can be used to access
   the study but the attribute itself should not be modified.

Definition at line 31 of file smeshstudytools.py.

---

Constructor & Destructor Documentation

def SMESH_PY.smeshstudytools.SMeshStudyTools.__init__	(		self,
			studyEditor = None
	)

Definition at line 47 of file smeshstudytools.py.

                                          :
        global SMESH
        if SMESH is None:
            SMESH = __import__("SMESH")
        if studyEditor is None:
            studyEditor = getStudyEditor()
        self.editor = studyEditor

---

Member Function Documentation

def SMESH_PY.smeshstudytools.SMeshStudyTools.getMeshFromGroup	(		self,
			meshGroupItem
	)

Get the mesh item owning the mesh group `meshGroupItem`.

:type   meshGroupItem: SObject
:param  meshGroupItem: Mesh group belonging to the searched mesh.

:return: The SObject corresponding to the mesh, or None if it was not
 found.

Definition at line 55 of file smeshstudytools.py.

                                             :
        """
        Get the mesh item owning the mesh group `meshGroupItem`.

        :type   meshGroupItem: SObject
        :param  meshGroupItem: Mesh group belonging to the searched mesh.
        
        :return: The SObject corresponding to the mesh, or None if it was not
                 found.
        """
        meshItem = None
        obj = self.editor.getOrLoadObject(meshGroupItem)
        group = obj._narrow(SMESH.SMESH_GroupBase)
        if group is not None: # The type of the object is ok
            meshObj = group.GetMesh()
            meshItem = salome.ObjectToSObject(meshObj)
        return meshItem

---

Field Documentation

SMESH_PY.smeshstudytools.SMeshStudyTools.editor

Definition at line 47 of file smeshstudytools.py.