Inheritance diagram for GEOM_PY.structelem.parts.StructuralElementPart:
Public Member Functions | |
| def | __init__ |
| def | __repr__ |
| def | addOrientation |
| def | build |
Data Fields | |
| groupName | |
| name | |
| geom | |
| baseShapesSet | |
Static Public Attributes | |
| string | DEFAULT_NAME = "StructElemPart" |
Private Member Functions | |
| def | _getParameter |
| def | _getParamUserName |
| def | _checkSize |
| def | _buildPart |
| def | _buildMarkers |
| def | _getSubShapes |
Private Attributes | |
| _parameters | |
| _groupGeomObj | |
| _orientation | |
| _paramUserName | |
Detailed Description
This class is the base class for all structural element parts. It should
not be instantiated directly (consider it as an "abstract" class).
:type studyId: integer
:param studyId: the ID of the study in which the part is created.
:type groupName: string
:param groupName: the name of the underlying geometrical primitive in the
study.
:type groupGeomObj: GEOM object
:param groupGeomObj: the underlying geometrical primitive.
:type parameters: dictionary
:param parameters: parameters defining the structural element (see
subclasses for details).
:type name: string
:param name: name to use for the created object in the study.
Constructor & Destructor Documentation
| def GEOM_PY.structelem.parts.StructuralElementPart.__init__ | ( | self, | |
| studyId, | |||
| groupName, | |||
| groupGeomObj, | |||
| parameters, | |||
name = DEFAULT_NAME |
|||
| ) |
Member Function Documentation
| def GEOM_PY.structelem.parts.StructuralElementPart._getParameter | ( | self, | |
| nameList, | |||
default = None |
|||
| ) | [private] |
This method finds the value of a parameter in the parameters dictionary. The argument is a list because some parameters can have several different names.
| def GEOM_PY.structelem.parts.StructuralElementPart._getParamUserName | ( | self, | |
| paramName | |||
| ) | [private] |
This method finds the user name for a parameter.
| def GEOM_PY.structelem.parts.StructuralElementPart.__repr__ | ( | self | ) |
| def GEOM_PY.structelem.parts.StructuralElementPart.addOrientation | ( | self, | |
| orientParams | |||
| ) |
Add orientation information to the structural element part. See class :class:`~salome.geom.structelem.orientation.Orientation1D` for the description of the parameters.
| def GEOM_PY.structelem.parts.StructuralElementPart._checkSize | ( | self, | |
| value, | |||
| mindim, | |||
| expression | |||
| ) | [private] |
This method checks that some parameters or some expressions involving those parameters are greater than a minimum value.
| def GEOM_PY.structelem.parts.StructuralElementPart.build | ( | self | ) |
Build the geometric shapes and the markers corresponding to the structural element part in the study `studyId`.
| def GEOM_PY.structelem.parts.StructuralElementPart._buildPart | ( | self | ) | [private] |
This abstract method must be implemented in subclasses and should create the geometrical shape(s) of the structural element part.
Reimplemented in GEOM_PY.structelem.parts.Beam, GEOM_PY.structelem.parts.GeneralBeam, GEOM_PY.structelem.parts.ThickShell, and GEOM_PY.structelem.parts.Grid.
| def GEOM_PY.structelem.parts.StructuralElementPart._buildMarkers | ( | self | ) | [private] |
This abstract method must be implemented in subclasses and should create the markers defining the orientation of the structural element part.
Reimplemented in GEOM_PY.structelem.parts.Beam, GEOM_PY.structelem.parts.ThickShell, and GEOM_PY.structelem.parts.Grid.
| def GEOM_PY.structelem.parts.StructuralElementPart._getSubShapes | ( | self, | |
minDim = MIN_LENGTH_FOR_EXTRUSION |
|||
| ) | [private] |
Find and return the base subshapes in the structural element part.
Field Documentation
string GEOM_PY.structelem.parts.StructuralElementPart.DEFAULT_NAME = "StructElemPart" [static] |
Reimplemented in GEOM_PY.structelem.parts.Beam, and GEOM_PY.structelem.parts.StructuralElementPart2D.