Version: 6.3.1
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes

GEOM_PY.structelem.StructuralElement Class Reference

Public Member Functions

def __init__
def addPart
def addOrientation
def build
def display
def showElement

Private Member Functions

def _getSObject

Private Attributes

 _parts
 _shapeDict
 _id
 _studyEditor
 _SObject

Static Private Attributes

int _counter = 1
int _mainFolderTag = 14725

Detailed Description

This class represents a structural element, i.e. a set of geometrical
objects built along geometrical primitives. The parameter `studyId`
defines the ID of the study that will contain the structural element. If
it is :const:`None` or not specified, the constructor will use the ID of
the active study as defined by :func:`salome.kernel.studyedit.getActiveStudyId`
function. Structural elements are normally created by the class
:class:`StructuralElementManager`, so this class should not be
instantiated directly in the general case.

Constructor & Destructor Documentation

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

Member Function Documentation

def GEOM_PY.structelem.StructuralElement._getSObject (   self) [private]
Find or create the study object corresponding to the structural
element. This object is named "SE_N" where N is a numerical ID. 
def GEOM_PY.structelem.StructuralElement.addPart (   self,
  newpart 
)
Add a part to the structural element.

:type  newpart: :class:`~parts.StructuralElementPart`
:param newpart: the part to add to the structural element.

def GEOM_PY.structelem.StructuralElement.addOrientation (   self,
  meshGroup,
  orientParams 
)
Add orientation information to a part in the structural element. This
information will be used to build the corresponding markers.

:type  meshGroup: string
:param meshGroup: the name of a geometrical primitive. The orientation
          information will apply to the structural element
          part built along this primitive.

:type  orientParams: dictionary
:param orientParams: parameters defining the orientation of the
             structural element part. Those parameters are
             detailed in class
             :class:`~orientation.Orientation1D`.

def GEOM_PY.structelem.StructuralElement.build (   self)
Build the geometric shapes and the markers corresponding to the
different parts of the structural element, and add them to the study.
def GEOM_PY.structelem.StructuralElement.display (   self)
Display the structural element in the geom view.
def GEOM_PY.structelem.StructuralElement.showElement (   theSObject)
Display the structural element corresponding to the study object
`theSObject`

Field Documentation

Copyright © 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS