Version: 9.16.0
Home
Loading...
Searching...
No Matches
StructuralElementPart Class Reference

This class is the base class for all structural element parts. More...

Public Member Functions

 __init__ (self, groupName, groupGeomObj, parameters, name=DEFAULT_NAME, color=None)
 
 __repr__ (self)
 
 addOrientation (self, orientParams)
 Add orientation information to the structural element part.
 
 build (self)
 Build the geometric shapes and the markers corresponding to the structural element part in the study.
 

Data Fields

 groupName
 
 name
 
 geom
 
 baseShapesSet
 
 isMainShape
 
 color
 

Static Public Attributes

str DEFAULT_NAME = "StructElemPart"
 

Protected Member Functions

 _getParameter (self, nameList, default=None)
 This method finds the value of a parameter in the parameters dictionary.
 
 _getParamUserName (self, paramName)
 This method finds the user name for a parameter.
 
 _checkSize (self, value, mindim, expression)
 This method checks that some parameters or some expressions involving those parameters are greater than a minimum value.
 
 _buildPart (self)
 This abstract method must be implemented in subclasses and should create the geometrical shape(s) of the structural element part.
 
 _buildMarkers (self)
 This abstract method must be implemented in subclasses and should create the markers defining the orientation of the structural element part.
 
 _getSubShapes (self, minDim=MIN_LENGTH_FOR_EXTRUSION)
 Find and return the base sub-shapes in the structural element part.
 

Protected 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).

Parameters
groupName(string) the name of the underlying geometrical primitive in the study.
groupGeomObj(GEOM object) the underlying geometrical primitive.
parameters(dictionary) parameters defining the structural element (see subclasses for details).
name(string) name to use for the created object in the study.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  groupName,
  groupGeomObj,
  parameters,
  name = DEFAULT_NAME,
  color = None 
)

Member Function Documentation

◆ _getParameter()

_getParameter (   self,
  nameList,
  default = None 
)
protected

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.

References StructuralElementPart._parameters, and StructuralElementPart._paramUserName.

◆ _getParamUserName()

_getParamUserName (   self,
  paramName 
)
protected

This method finds the user name for a parameter.

References StructuralElementPart._paramUserName.

◆ __repr__()

◆ addOrientation()

addOrientation (   self,
  orientParams 
)

Add orientation information to the structural element part.

See class salome.geom.structelem.orientation.Orientation1D for the description of the parameters.

References StructuralElementPart._orientation, Beam._orientation, and StructuralElementPart2D._orientation.

◆ _checkSize()

_checkSize (   self,
  value,
  mindim,
  expression 
)
protected

This method checks that some parameters or some expressions involving those parameters are greater than a minimum value.

References InvalidParameterError.groupName, and StructuralElementPart.groupName.

◆ build()

build (   self)

◆ _buildPart()

_buildPart (   self)
protected

This abstract method must be implemented in subclasses and should create the geometrical shape(s) of the structural element part.

Reimplemented in Beam, ThickShell, and Grid.

◆ _buildMarkers()

_buildMarkers (   self)
protected

This abstract method must be implemented in subclasses and should create the markers defining the orientation of the structural element part.

Reimplemented in Beam, ThickShell, and Grid.

◆ _getSubShapes()

Field Documentation

◆ DEFAULT_NAME

str DEFAULT_NAME = "StructElemPart"
static

◆ _parameters

_parameters
protected

◆ groupName

groupName

◆ _groupGeomObj

_groupGeomObj
protected

◆ _orientation

_orientation
protected

◆ _paramUserName

_paramUserName
protected

◆ name

name

◆ geom

geom

◆ baseShapesSet

baseShapesSet

◆ isMainShape

isMainShape

◆ color

color