StructuralElementPart Class Reference

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

Public Member Functions
def	__init__
def	__repr__
def	addOrientation
	Add orientation information to the structural element part. More...
def	build
	Build the geometric shapes and the markers corresponding to the structural element part in the study studyId. More...

Data Fields
	groupName
	name
	geom
	baseShapesSet
	isMainShape
	color

Static Public Attributes
string	DEFAULT_NAME = "StructElemPart"

Private Member Functions
def	_getParameter
	This method finds the value of a parameter in the parameters dictionary. More...
def	_getParamUserName
	This method finds the user name for a parameter. More...
def	_checkSize
	This method checks that some parameters or some expressions involving those parameters are greater than a minimum value. More...
def	_buildPart
	This abstract method must be implemented in subclasses and should create the geometrical shape(s) of the structural element part. More...
def	_buildMarkers
	This abstract method must be implemented in subclasses and should create the markers defining the orientation of the structural element part. More...
def	_getSubShapes
	Find and return the base sub-shapes in the structural element part. More...

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

Parameters

studyId	(integer) the ID of the study in which the part is created.
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

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

Member Function Documentation

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

References StructuralElementPart._parameters, and StructuralElementPart._paramUserName.

def _getParamUserName (   self,   paramName  )

private

This method finds the user name for a parameter.

References StructuralElementPart._paramUserName.

def __repr__

(

self

)

References InvalidParameterError.groupName, and StructuralElementPart.groupName.

def addOrientation	(		self,
			orientParams
	)

Add orientation information to the structural element part.

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

def _checkSize (   self,   value,   mindim,   expression  )

private

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

References InvalidParameterError.groupName, and StructuralElementPart.groupName.

def build

(

self

)

Build the geometric shapes and the markers corresponding to the structural element part in the study studyId.

References StructuralElementPart._buildMarkers(), StructuralElementPart._buildPart(), and StructuralElementPart.color.

def _buildPart (   self )

private

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

def _buildMarkers (   self )

private

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

def _getSubShapes (   self,   minDim = MIN_LENGTH_FOR_EXTRUSION  )

private

Find and return the base sub-shapes in the structural element part.

References StructuralElementPart._groupGeomObj, StructuralElementPart.baseShapesSet, Orientation1D.geom, StructuralElementPart.geom, Orientation2D.geom, InvalidParameterError.groupName, StructuralElementPart.groupName, and StructuralElementPart.isMainShape.

Field Documentation

string DEFAULT_NAME = "StructElemPart"

static

_parameters

private

groupName

_groupGeomObj

private

_orientation

private

_paramUserName

private

name

geom

baseShapesSet

isMainShape

color