StructuralElement Class Reference

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

Public Member Functions
def	__init__
def	addPart
	Add a part to the structural element. More...
def	addOrientation
	Add orientation information to a part in the structural element. More...
def	build
	Build the geometric shapes and the markers corresponding to the different parts of the structural element, and add them to the study. More...
def	display
	Display the structural element in the geom view. More...

Static Public Member Functions
def	showElement
	Display the structural element corresponding to the study object theSObject. More...

Static Public Attributes
string	MAIN_FOLDER_NAME = "Structural Elements"

Private Member Functions
def	_getSObject
	Find or create the study object corresponding to the structural element. More...

Private Attributes
	_parts
	_shapeDict
	_id
	_studyEditor
	_SObject

Static Private Attributes
int	_counter = 1

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 None or not specified, the constructor will use the ID of the active study as defined by salome.kernel.studyedit.getActiveStudyId function. Structural elements are normally created by the class StructuralElementManager, so this class should not be instantiated directly in the general case.

Constructor & Destructor Documentation

def __init__	(		self,
			studyId = None
	)

Member Function Documentation

def _getSObject (   self )

private

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, and geomtools.getGeompy().

def 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.

def 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.

def 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 geomtools.getGeompy().

def display

(

self

)

Display the structural element in the geom view.

References StructuralElement._SObject.

def showElement (   theSObject )

static

Display the structural element corresponding to the study object theSObject.

Field Documentation

int _counter = 1

staticprivate

string MAIN_FOLDER_NAME = "Structural Elements"

static

_parts

private

_shapeDict

private

_id

private

_studyEditor

private

_SObject

private