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

This class represents a structural element, i.e. More...

Public Member Functions

 __init__ (self)
 
 addPart (self, newpart)
 Add a part to the structural element.
 
 addOrientation (self, meshGroup, orientParams)
 Add orientation information to a part in the structural element.
 
 build (self)
 Build the geometric shapes and the markers corresponding to the different parts of the structural element, and add them to the study.
 
 display (self)
 Display the structural element in the geom view.
 

Static Public Member Functions

 showElement (theSObject)
 Display the structural element corresponding to the study object theSObject.
 

Static Public Attributes

str MAIN_FOLDER_NAME = "Structural Elements"
 

Protected Member Functions

 _getSObject (self)
 Find or create the study object corresponding to the structural element.
 

Protected Attributes

 _parts
 
 _shapeDict
 
 _id
 
 _studyEditor
 
 _SObject
 

Static Protected Attributes

int _counter = 1
 

Detailed Description

This class represents a structural element, i.e.

a set of geometrical objects built along geometrical primitives. Structural elements are normally created by the class StructuralElementManager, so this class should not be instantiated directly in the general case.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self)

Member Function Documentation

◆ _getSObject()

_getSObject (   self)
protected

Find or create the study object corresponding to the structural element.

This object is a Geom Folder named "SE_N" where N is a numerical ID.

References SubShapeID._id, StructuralElement._id, StructuralElement._SObject, StructuralElementManager._studyEditor, and StructuralElement._studyEditor.

◆ addPart()

addPart (   self,
  newpart 
)

Add a part to the structural element.

Parameters
newpart(StructuralElementPart) the part to add to the structural element.

References StructuralElement._parts, and StructuralElement._shapeDict.

◆ addOrientation()

addOrientation (   self,
  meshGroup,
  orientParams 
)

Add orientation information to a part in the structural element.

This information will be used to build the corresponding markers.

Parameters
meshGroup(string) the name of a geometrical primitive. The orientation information will apply to the structural element part built along this primitive.
orientParams(dictionary) parameters defining the orientation of the structural element part. Those parameters are detailed in class orientation.Orientation1D.

References StructuralElement._parts, and StructuralElement.addOrientation().

◆ build()

build (   self)

Build the geometric shapes and the markers corresponding to the different parts of the structural element, and add them to the study.

References StructuralElement._getSObject(), and StructuralElement._parts.

◆ display()

display (   self)

Display the structural element in the geom view.

References StructuralElement._SObject.

◆ showElement()

showElement (   theSObject)
static

Display the structural element corresponding to the study object theSObject.

Field Documentation

◆ _counter

int _counter = 1
staticprotected

◆ MAIN_FOLDER_NAME

str MAIN_FOLDER_NAME = "Structural Elements"
static

◆ _parts

_parts
protected

◆ _shapeDict

_shapeDict
protected

◆ _id

_id
protected

◆ _studyEditor

_studyEditor
protected

◆ _SObject

_SObject
protected