GEOM_PY.structelem.StructuralElementManager Class Reference

Public Member Functions
def	__init__
def	createElement
Private Member Functions
def	_extractMeshGroups
def	_getMeshGroupListFromString
Private Attributes
	_studyEditor

---

Detailed Description

This class manages the structural elements in the study. It is used to
create a new structural element from a list of commands. The parameter
`studyId` defines the ID of the study in which the manager will create
structural elements. If it is :const:`None` or not specified, it will use
the ID of the current study as defined by
:func:`salome.kernel.studyedit.getActiveStudyId` function.

---

Constructor & Destructor Documentation

def GEOM_PY.structelem.StructuralElementManager.__init__	(		self,
			studyId = None
	)

---

Member Function Documentation

def GEOM_PY.structelem.StructuralElementManager.createElement	(		self,
			commandList
	)

Create a structural element from the list of commands `commandList`.
Each command in this list represent a part of the structural element,
that is a specific kind of shape (circular beam, grid, etc.)
associated with one or several geometrical primitives. A command must
be a tuple. The first element is the structural element part class
name or alias name. The second element is a dictionary containing the
parameters describing the part. Valid class names are all the classes
defined in the module :mod:`~salome.geom.structelem.parts` and inheriting
class :class:`~parts.StructuralElementPart`. There are also several
aliases for backward compatibility. Here is the complete list:

* :class:`~parts.GeneralBeam`
* :class:`~parts.CircularBeam`
* :class:`~parts.RectangularBeam`
* :class:`~parts.ThickShell`
* :class:`~parts.Grid`

* :func:`~parts.VisuPoutreGenerale` (alias for
  :class:`~parts.GeneralBeam`)
* :func:`~parts.VisuPoutreCercle` (alias for
  :class:`~parts.CircularBeam`)
* :func:`~parts.VisuPoutreRectangle` (alias for
  :class:`~parts.RectangularBeam`)
* :func:`~parts.VisuBarreGenerale` (alias for
  :class:`~parts.GeneralBeam`)
* :func:`~parts.VisuBarreRectangle` (alias for
  :class:`~parts.RectangularBeam`)
* :func:`~parts.VisuBarreCercle` (alias for
  :class:`~parts.CircularBeam`)
* :func:`~parts.VisuCable` (alias for :class:`~parts.CircularBeam`)
* :func:`~parts.VisuCoque` (alias for :class:`~parts.ThickShell`)
* :func:`~parts.VisuGrille` (alias for :class:`~parts.Grid`)

* ``Orientation``: This identifier is used to specify the orientation
  of one or several 1D structural element parts (i.e. beams). The
  parameters are described in class
  :class:`~orientation.Orientation1D`.

The valid parameters in the dictionary depend on the type of the
structural element part, and are detailed in the documentation of
the corresponding class. The only parameter that is common to all the
classes is "MeshGroups" (that can also be named "Group_Maille"). It
defines the name of the geometrical object(s) in the study that will
be used as primitives to build the structural element part. This
parameter can be either a list of strings or a single string with
comma separated names.

def GEOM_PY.structelem.StructuralElementManager._extractMeshGroups	(		self,
			command
	)		[private]

This method extracts the names of the mesh groups (i.e. the
geometrical objects used to build the structural element part) in the
command in parameter. It returns a tuple containing the mesh groups as
a list of strings and the other parameters of the command as a new
dictionary.

def GEOM_PY.structelem.StructuralElementManager._getMeshGroupListFromString	(		self,
			meshString
	)		[private]

This method splits the string in parameter to extract comma separated
names. Those names are returned as a list of strings.

---

Field Documentation

GEOM_PY.structelem.StructuralElementManager._studyEditor [private]