import "SMESH_Gen.idl";

Inheritance diagram for SMESH::SMESH_Gen:

Public Member Functions
void	SetGeomEngine (in GEOM::GEOM_Gen geomcompo)

FilterManager	CreateFilterManager ()

SMESH_Pattern	GetPattern ()

Measurements	CreateMeasurements ()

void	SetEmbeddedMode (in boolean theMode)
	Set the current mode. More...

boolean	IsEmbeddedMode ()
	Get the current mode. More...

void	SetCurrentStudy (in SALOMEDS::Study theStudy)
	Set the current study. More...

SALOMEDS::Study	GetCurrentStudy ()
	Get the current study. More...

SMESH_Hypothesis	CreateHypothesis (in string theHypName, in string theLibName) raises ( SALOME::SALOME_Exception )
	Create a hypothesis that can be shared by differents parts of the mesh. More...

SMESH_Hypothesis	GetHypothesisParameterValues (in string theHypName, in string theLibName, in SMESH_Mesh theMesh, in GEOM::GEOM_Object theGeom, in boolean byMesh) raises ( SALOME::SALOME_Exception )
	Return a hypothesis holding parameter values corresponding either to the mesh existing on the given geometry or to size of the geometry. More...

boolean	GetSoleSubMeshUsingHyp (in SMESH_Hypothesis theHyp, out SMESH_Mesh theMesh, out GEOM::GEOM_Object theShape)
	Returns `True` if a hypothesis is assigned to a sole sub-mesh in a current Study. More...

void	SetBoundaryBoxSegmentation (in long theNbSegments) raises ( SALOME::SALOME_Exception )
	Sets number of segments per diagonal of boundary box of geometry by which default segment length of appropriate 1D hypotheses is defined. More...

void	SetDefaultNbSegments (in long theNbSegments) raises ( SALOME::SALOME_Exception )
	Sets default number of segments per edge. More...

void	SetName (in string theObjectIOR, in string theObjectName) raises ( SALOME::SALOME_Exception )
	Set the object name. More...

SMESH_Mesh	CreateMesh (in GEOM::GEOM_Object theObject) raises ( SALOME::SALOME_Exception )
	Create a Mesh object, given a geometry shape. More...

SMESH_Mesh	CreateEmptyMesh () raises ( SALOME::SALOME_Exception )
	Create an empty mesh object. More...

SMESH_Mesh	CreateMeshesFromUNV (in string theFileName) raises ( SALOME::SALOME_Exception )
	Create Mesh object importing data from given UNV file (UNV supported version is I-DEAS 10) More...

mesh_array	CreateMeshesFromMED (in string theFileName, out SMESH::DriverMED_ReadStatus theStatus) raises ( SALOME::SALOME_Exception )
	Create Mesh object(s) importing data from given MED file. More...

mesh_array	CreateMeshesFromSAUV (in string theFileName, out SMESH::DriverMED_ReadStatus theStatus) raises ( SALOME::SALOME_Exception )
	Create Mesh object(s) importing data from given MED file. More...

SMESH_Mesh	CreateMeshesFromSTL (in string theFileName) raises ( SALOME::SALOME_Exception )
	Create Mesh object importing data from given STL file. More...

mesh_array	CreateMeshesFromCGNS (in string theFileName, out SMESH::DriverMED_ReadStatus theStatus) raises ( SALOME::SALOME_Exception )
	Create Mesh object(s) importing data from given CGNS file. More...

SMESH_Mesh	CreateMeshesFromGMF (in string theFileName, in boolean theMakeRequiredGroups, out SMESH::ComputeError theError) raises ( SALOME::SALOME_Exception )
	Create Mesh object importing data from given GMF file. More...

SMESH_Mesh	CopyMesh (in SMESH_IDSource meshPart, in string meshName, in boolean toCopyGroups, in boolean toKeepIDs) raises ( SALOME::SALOME_Exception )
	Create a mesh by copying a part of another mesh. More...

SMESH_Mesh	Concatenate (in ListOfIDSources theMeshesArray, in boolean theUniteIdenticalGroups, in boolean theMergeNodesAndElements, in double theMergeTolerance) raises ( SALOME::SALOME_Exception )
	Concatenate the given meshes or groups into one mesh. More...

SMESH_Mesh	ConcatenateWithGroups (in ListOfIDSources theMeshesArray, in boolean theUniteIdenticalGroups, in boolean theMergeNodesAndElements, in double theMergeTolerance) raises ( SALOME::SALOME_Exception )
	Concatenate the given meshes into one mesh. More...

boolean	Compute (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject) raises ( SALOME::SALOME_Exception )
	Mesh a subShape. More...

void	CancelCompute (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject)
	Cancel a computation. More...

boolean	IsReadyToCompute (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject) raises ( SALOME::SALOME_Exception )
	Return true if hypotheses are defined well. More...

long_array	Evaluate (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject) raises ( SALOME::SALOME_Exception )
	Evaluates size of prospective mesh on a shape. More...

MeshPreviewStruct	Precompute (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject, in Dimension theDimension, inout long_array theShapesId) raises ( SALOME::SALOME_Exception )
	Calculate Mesh as preview till indicated dimension First, verify list of hypothesis associated with the Sub-shape. More...

algo_error_array	GetAlgoState (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject) raises ( SALOME::SALOME_Exception )
	Return errors of hypotheses definintion algo_error_array is empty if everything is OK. More...

compute_error_array	GetComputeErrors (in SMESH_Mesh theMesh, in GEOM::GEOM_Object theSubObject) raises ( SALOME::SALOME_Exception )
	Return errors of mesh computation compute_error_array is empty if everything is OK. More...

MeshPreviewStruct	GetBadInputElements (in SMESH_Mesh theMesh, in short theSubShapeID) raises ( SALOME::SALOME_Exception )
	Return mesh elements preventing computation of a sub-shape. More...

SMESH::ListOfGroups	MakeGroupsOfBadInputElements (in SMESH_Mesh theMesh, in short theSubShapeID, in string theGroupName) raises ( SALOME::SALOME_Exception )
	Create groups of elements preventing computation of a sub-shape. More...

long_array	GetSubShapesId (in GEOM::GEOM_Object theMainObject, in object_array theListOfSubObjects) raises ( SALOME::SALOME_Exception )
	Return indices of faces, edges and vertices of given sub-shapes within theMainObject. More...

GEOM::GEOM_Object	GetGeometryByMeshElement (in SMESH_Mesh theMesh, in long theElementID, in string theGeomName) raises ( SALOME::SALOME_Exception )
	Return geometrical object the given element is built on. More...

GEOM::GEOM_Object	FindGeometryByMeshElement (in SMESH_Mesh theMesh, in long theElementID) raises ( SALOME::SALOME_Exception )
	Return geometrical object the given element is built on. More...

long	GetObjectId (in Object theObject)
	Return id of object, registered in current study context. More...

boolean	GetMEDVersion (in string theFileName, out MED_VERSION theVersion)
	Get MED version of the file by its name. More...

string_array	GetMeshNames (in string theFileName)
	Get names of meshes defined in file with the specified name. More...

void	Move (in sobject_list what, in SALOMEDS::SObject where, in long row)
	Moves objects to the specified position. More...

boolean	IsApplicable (in string theAlgoType, in string theLibName, in GEOM::GEOM_Object theShapeObject, in boolean toCheckAll)
	Returns true if algorithm can be used to mesh a given geometry. More...

long_array	GetInsideSphere (in SMESH_IDSource theSource, in ElementType theElemType, in double theX, in double theY, in double theZ, in double theR)
	Return indices of elements, which are located inside the sphere. More...

long_array	GetInsideBox (in SMESH_IDSource theSource, in ElementType theElemType, in double theX1, in double theY1, in double theZ1, in double theX2, in double theY2, in double theZ2)
	Return indices of elements, which are located inside the box. More...

long_array	GetInsideCylinder (in SMESH_IDSource theSource, in ElementType theElemType, in double theX, in double theY, in double theZ, in double theDX, in double theDY, in double theDZ, in double theH, in double theR)
	Return indices of elements, which are located inside the box. More...

long_array	GetInside (in SMESH_IDSource theSource, in ElementType theElemType, in GEOM::GEOM_Object theGeom, in double theTolerance)
	Return indices of elements, which are located inside the geometry. More...

Member Function Documentation

void SMESH::SMESH_Gen::CancelCompute	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject
	)

Cancel a computation.

boolean SMESH::SMESH_Gen::Compute	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject
	)		raises ( SALOME::SALOME_Exception )

Mesh a subShape.

First, verify list of hypothesis associated with the Sub-shape, return NOK if hypothesis are not sufficient

SMESH_Mesh SMESH::SMESH_Gen::Concatenate	(	in ListOfIDSources	theMeshesArray,
		in boolean	theUniteIdenticalGroups,
		in boolean	theMergeNodesAndElements,
		in double	theMergeTolerance
	)		raises ( SALOME::SALOME_Exception )

Concatenate the given meshes or groups into one mesh.

Union groups with the same name and type if theUniteIdenticalGroups flag is true. Merge coincident nodes and elements if theMergeNodesAndElements flag is true.

SMESH_Mesh SMESH::SMESH_Gen::ConcatenateWithGroups	(	in ListOfIDSources	theMeshesArray,
		in boolean	theUniteIdenticalGroups,
		in boolean	theMergeNodesAndElements,
		in double	theMergeTolerance
	)		raises ( SALOME::SALOME_Exception )

Concatenate the given meshes into one mesh.

Union groups with the same name and type if theUniteIdenticalGroups flag is true. Merge coincident nodes and elements if theMergeNodesAndElements flag is true. Create the groups of all elements from initial meshes.

SMESH_Mesh SMESH::SMESH_Gen::CopyMesh	(	in SMESH_IDSource	meshPart,
		in string	meshName,
		in boolean	toCopyGroups,
		in boolean	toKeepIDs
	)		raises ( SALOME::SALOME_Exception )

Create a mesh by copying a part of another mesh.

Parameters

meshPart	- a part of mesh to copy
meshName	- a name of the new mesh
toCopyGroups	- to create in the new mesh groups the copied elements belongs to
toKeepIDs	- to preserve IDs of the copied elements or not

SMESH_Mesh SMESH::SMESH_Gen::CreateEmptyMesh ( ) raises ( SALOME::SALOME_Exception )

Create an empty mesh object.

FilterManager SMESH::SMESH_Gen::CreateFilterManager ( )

SMESH_Hypothesis SMESH::SMESH_Gen::CreateHypothesis	(	in string	theHypName,
		in string	theLibName
	)		raises ( SALOME::SALOME_Exception )

Create a hypothesis that can be shared by differents parts of the mesh.

An hypothesis is either:

a method used to generate or modify a part of the mesh (algorithm).
a parameter or a law used by an algorithm. Algorithms are 1D, 2D or 3D.

Measurements SMESH::SMESH_Gen::CreateMeasurements ( )

SMESH_Mesh SMESH::SMESH_Gen::CreateMesh ( in GEOM::GEOM_Object theObject ) raises ( SALOME::SALOME_Exception )

Create a Mesh object, given a geometry shape.

Mesh is created empty (no points, no elements). Shape is explored via GEOM_Client to create local copies. of TopoDS_Shapes and bind CORBA references of shape & subshapes with TopoDS_Shapes

mesh_array SMESH::SMESH_Gen::CreateMeshesFromCGNS	(	in string	theFileName,
		out SMESH::DriverMED_ReadStatus	theStatus
	)		raises ( SALOME::SALOME_Exception )

Create Mesh object(s) importing data from given CGNS file.

SMESH_Mesh SMESH::SMESH_Gen::CreateMeshesFromGMF	(	in string	theFileName,
		in boolean	theMakeRequiredGroups,
		out SMESH::ComputeError	theError
	)		raises ( SALOME::SALOME_Exception )

Create Mesh object importing data from given GMF file.

Parameters

theFileName	- a name of file to import
theMakeRequiredGroups	- if true, groups of required entities will be created

mesh_array SMESH::SMESH_Gen::CreateMeshesFromMED	(	in string	theFileName,
		out SMESH::DriverMED_ReadStatus	theStatus
	)		raises ( SALOME::SALOME_Exception )

Create Mesh object(s) importing data from given MED file.

mesh_array SMESH::SMESH_Gen::CreateMeshesFromSAUV	(	in string	theFileName,
		out SMESH::DriverMED_ReadStatus	theStatus
	)		raises ( SALOME::SALOME_Exception )

Create Mesh object(s) importing data from given MED file.

SMESH_Mesh SMESH::SMESH_Gen::CreateMeshesFromSTL ( in string theFileName ) raises ( SALOME::SALOME_Exception )

Create Mesh object importing data from given STL file.

SMESH_Mesh SMESH::SMESH_Gen::CreateMeshesFromUNV ( in string theFileName ) raises ( SALOME::SALOME_Exception )

Create Mesh object importing data from given UNV file (UNV supported version is I-DEAS 10)

long_array SMESH::SMESH_Gen::Evaluate	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject
	)		raises ( SALOME::SALOME_Exception )

Evaluates size of prospective mesh on a shape.

GEOM::GEOM_Object SMESH::SMESH_Gen::FindGeometryByMeshElement	(	in SMESH_Mesh	theMesh,
		in long	theElementID
	)		raises ( SALOME::SALOME_Exception )

Return geometrical object the given element is built on.

The returned geometrical object not published in study by this method.

algo_error_array SMESH::SMESH_Gen::GetAlgoState	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject
	)		raises ( SALOME::SALOME_Exception )

Return errors of hypotheses definintion algo_error_array is empty if everything is OK.

MeshPreviewStruct SMESH::SMESH_Gen::GetBadInputElements	(	in SMESH_Mesh	theMesh,
		in short	theSubShapeID
	)		raises ( SALOME::SALOME_Exception )

Return mesh elements preventing computation of a sub-shape.

compute_error_array SMESH::SMESH_Gen::GetComputeErrors	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject
	)		raises ( SALOME::SALOME_Exception )

Return errors of mesh computation compute_error_array is empty if everything is OK.

SALOMEDS::Study SMESH::SMESH_Gen::GetCurrentStudy ( )

Get the current study.

GEOM::GEOM_Object SMESH::SMESH_Gen::GetGeometryByMeshElement	(	in SMESH_Mesh	theMesh,
		in long	theElementID,
		in string	theGeomName
	)		raises ( SALOME::SALOME_Exception )

Return geometrical object the given element is built on.

The returned geometrical object, if not nil, is either found in the study or is published by this method with the given name

SMESH_Hypothesis SMESH::SMESH_Gen::GetHypothesisParameterValues	(	in string	theHypName,
		in string	theLibName,
		in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theGeom,
		in boolean	byMesh
	)		raises ( SALOME::SALOME_Exception )

Return a hypothesis holding parameter values corresponding either to the mesh existing on the given geometry or to size of the geometry.

The returned hypothesis may be the one existing in a study and used to compute the mesh, or a temporary one created just to pass parameter values.

long_array SMESH::SMESH_Gen::GetInside	(	in SMESH_IDSource	theSource,
		in ElementType	theElemType,
		in GEOM::GEOM_Object	theGeom,
		in double	theTolerance
	)

Return indices of elements, which are located inside the geometry.

Parameters

theSource	- mesh, sub-mesh or group
theElemType	- mesh element type
theGeom	- geometrical object
theTolerance	- tolerance for selection.

long_array SMESH::SMESH_Gen::GetInsideBox	(	in SMESH_IDSource	theSource,
		in ElementType	theElemType,
		in double	theX1,
		in double	theY1,
		in double	theZ1,
		in double	theX2,
		in double	theY2,
		in double	theZ2
	)

Return indices of elements, which are located inside the box.

Parameters

theSource	- mesh, sub-mesh or group
theElemType	- mesh element type
theX1	- x cooridate of the first opposite point
theY1	- y cooridate of the first opposite point
theZ1	- y cooridate of the first opposite point
theX2	- x cooridate of the second opposite point
theY2	- y cooridate of the second opposite point
theZ2	- y cooridate of the second opposite point

long_array SMESH::SMESH_Gen::GetInsideCylinder	(	in SMESH_IDSource	theSource,
		in ElementType	theElemType,
		in double	theX,
		in double	theY,
		in double	theZ,
		in double	theDX,
		in double	theDY,
		in double	theDZ,
		in double	theH,
		in double	theR
	)

Return indices of elements, which are located inside the box.

Parameters

theSource	- mesh, sub-mesh or group
theElemType	- mesh element type
theX	- x cooridate of the cented of the bottom face
theY	- y cooridate of the cented of the bottom face
theZ	- y cooridate of the cented of the bottom face
theDX	- x cooridate of the cented of the base vector
theDY	- y cooridate of the cented of the base vector
theDZ	- z cooridate of the cented of the base vector
theH	- height of the cylinder
theR	- radius of the cylinder

long_array SMESH::SMESH_Gen::GetInsideSphere	(	in SMESH_IDSource	theSource,
		in ElementType	theElemType,
		in double	theX,
		in double	theY,
		in double	theZ,
		in double	theR
	)

Return indices of elements, which are located inside the sphere.

Parameters

theSource	- mesh, sub-mesh or group
theElemType	- mesh element type
theX	- x cooridate of the center of the sphere
theY	- y cooridate of the center of the sphere
theZ	- y cooridate of the center of the sphere
theR	- radius of the sphere

boolean SMESH::SMESH_Gen::GetMEDVersion	(	in string	theFileName,
		out MED_VERSION	theVersion
	)

Get MED version of the file by its name.

string_array SMESH::SMESH_Gen::GetMeshNames ( in string theFileName )

Get names of meshes defined in file with the specified name.

long SMESH::SMESH_Gen::GetObjectId ( in Object theObject )

Return id of object, registered in current study context.

Can be used to check if the object was created in the same container, as this engine.

SMESH_Pattern SMESH::SMESH_Gen::GetPattern ( )

boolean SMESH::SMESH_Gen::GetSoleSubMeshUsingHyp	(	in SMESH_Hypothesis	theHyp,
		out SMESH_Mesh	theMesh,
		out GEOM::GEOM_Object	theShape
	)

Returns True if a hypothesis is assigned to a sole sub-mesh in a current Study.

Parameters

[in]	theHyp	- the hypothesis of interest
[out]	theMesh	- the sole mesh using theHyp
[out]	theShape	- the sole geometry theHyp is assigned to

Returns: boolean - True if theMesh and theShape are sole using theHyp

long_array SMESH::SMESH_Gen::GetSubShapesId	(	in GEOM::GEOM_Object	theMainObject,
		in object_array	theListOfSubObjects
	)		raises ( SALOME::SALOME_Exception )

Return indices of faces, edges and vertices of given sub-shapes within theMainObject.

boolean SMESH::SMESH_Gen::IsApplicable	(	in string	theAlgoType,
		in string	theLibName,
		in GEOM::GEOM_Object	theShapeObject,
		in boolean	toCheckAll
	)

Returns true if algorithm can be used to mesh a given geometry.

Parameters

theAlgoType	- the algorithm type
theLibName	- a name of the Plug-in library implementing the algorithm
theShapeObject	- the geometry to mesh
toCheckAll	- if `True`, returns `True` if all shapes are meshable, else, returns `True` if at least one shape is meshable

boolean SMESH::SMESH_Gen::IsEmbeddedMode ( )

Get the current mode.

boolean SMESH::SMESH_Gen::IsReadyToCompute	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject
	)		raises ( SALOME::SALOME_Exception )

Return true if hypotheses are defined well.

SMESH::ListOfGroups SMESH::SMESH_Gen::MakeGroupsOfBadInputElements	(	in SMESH_Mesh	theMesh,
		in short	theSubShapeID,
		in string	theGroupName
	)		raises ( SALOME::SALOME_Exception )

Create groups of elements preventing computation of a sub-shape.

void SMESH::SMESH_Gen::Move	(	in sobject_list	what,
		in SALOMEDS::SObject	where,
		in long	row
	)

Moves objects to the specified position.

Parameters

what	objects being moved
where	parent object where objects are moved to
row	position in the parent object's children list at which objects are moved

This function is used in the drag-n-drop functionality.

MeshPreviewStruct SMESH::SMESH_Gen::Precompute	(	in SMESH_Mesh	theMesh,
		in GEOM::GEOM_Object	theSubObject,
		in Dimension	theDimension,
		inout long_array	theShapesId
	)		raises ( SALOME::SALOME_Exception )

Calculate Mesh as preview till indicated dimension First, verify list of hypothesis associated with the Sub-shape.

Return mesh preview structure

void SMESH::SMESH_Gen::SetBoundaryBoxSegmentation ( in long theNbSegments ) raises ( SALOME::SALOME_Exception )

Sets number of segments per diagonal of boundary box of geometry by which default segment length of appropriate 1D hypotheses is defined.

void SMESH::SMESH_Gen::SetCurrentStudy ( in SALOMEDS::Study theStudy )

Set the current study.

void SMESH::SMESH_Gen::SetDefaultNbSegments ( in long theNbSegments ) raises ( SALOME::SALOME_Exception )

Sets default number of segments per edge.

void SMESH::SMESH_Gen::SetEmbeddedMode ( in boolean theMode )

Set the current mode.

void SMESH::SMESH_Gen::SetGeomEngine ( in GEOM::GEOM_Gen geomcompo )

void SMESH::SMESH_Gen::SetName	(	in string	theObjectIOR,
		in string	theObjectName
	)		raises ( SALOME::SALOME_Exception )

Set the object name.

Public Member Functions

Member Function Documentation