SMeshStudyTools Class Reference

This class provides several methods to manipulate mesh objects in Salome study. More...

Public Member Functions
def	__init__
def	updateStudy
	This function updates the tools so that it works on the specified study. More...
def	getMeshFromGroup
	Get the mesh item owning the mesh group meshGroupItem. More...
def	getMeshObjectSelected
	Returns the MESH object currently selected in the active study. More...
def	getMeshObjectFromEntry
	Returns the MESH object associated to the specified entry, (the entry is the identifier of an item in the objects browser). More...
def	getMeshObjectFromSObject
	Returns the SMESH object associated to the specified SObject, (the SObject is an item in the objects browser). More...
def	displayMeshObjectFromEntry
	Display the SMESH object associated to the specified entry (the entry is the identifier of an item in the objects browser). More...

Data Fields
	editor
	smeshGui

Detailed Description

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.

Constructor & Destructor Documentation

def __init__	(		self,
			studyEditor = None
	)

Member Function Documentation

def updateStudy	(		self,
			studyId = None
	)

This function updates the tools so that it works on the specified study.

References SMeshStudyTools.editor, and Mesh.editor.

def getMeshFromGroup	(		self,
			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.

def getMeshObjectSelected

(

self

)

Returns the MESH object currently selected in the active study.

References SMeshStudyTools.getMeshObjectFromEntry().

def getMeshObjectFromEntry	(		self,
			entry
	)

Returns the MESH object associated to the specified entry, (the entry is the identifier of an item in the objects browser).

References smeshBuilder.New().

def getMeshObjectFromSObject	(		self,
			sobject
	)

Returns the SMESH object associated to the specified SObject, (the SObject is an item in the objects browser).

def displayMeshObjectFromEntry	(		self,
			entry
	)

Display the SMESH object associated to the specified entry (the entry is the identifier of an item in the objects browser).

References SMeshStudyTools.smeshGui.

Field Documentation

editor

smeshGui