All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFmtModelInterfaces Interface CATIFmtMesher

Usage: you can reimplement this interface by deriving the supplied CATFmtExtIMesher adapter class.

interface CATIFmtMesher

Interface representing the Mesher.
Role: The Mesher is the object which generates the mesh from all the mesh specifications stored within its associated Mesh Part, see .

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

Method Index

o AfterUpdating(CATIFmtMeshPart*): Performs cleaning operations after updating a Mesh Part.
o BeforeUpdating(CATIFmtMeshPart*): Performs cleaning operations before updating a Mesh Part.
o Check(CATIFmtMeshPart*): Checks the supports of the Mesh Part.
o CloseEdition(): Performs mesher-specific operations before exiting edition mode for a Mesh Part.
o GetMeshedBodies(CATIFmtMeshPart*,CATFmtListOfPath*&)
o GetMeshedShapes(CATIFmtMeshPart*,CATFmtListOfPath*&)
o GetParentMeshParts(CATIFmtMeshPart*,CATFmtListOfPath*&): Retrieves the parent Mesh Part.
o Invalidate(CATIFmtMeshPart*): Invalidates the mesh and the topology corresponding to the Mesh Part.
o IsATypeOf(CATIFmtMeshPart*,CATUnicodeString&): Queries the mesher about the type of the Mesh Part.
o IsMeshingBodies(CATIFmtMeshPart*,CATBoolean&): Queries the mesher to know if the Mesh Part is meshing 3D bodies or not.
o IsMeshingShapes(CATIFmtMeshPart*,CATBoolean&): Queries the mesher to know if the Mesh Part is meshing 3D shapes or not.
o Mesh(CATIFmtMeshPart*): Builds the mesh corresponding to the Mesh Part.
o OnMeshPartRemove(CATIFmtMeshPart*): Performs cleaning operations before removing a Mesh Part.

Methods

o AfterUpdating

public virtual AfterUpdating( iMeshPart)

Performs cleaning operations after updating a Mesh Part.
Role: This method is called after updating a Mesh Part and should perform necessary cleaning operations.
Default implementation does nothing.

Parameters:

iMeshPart: The Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: Cleaning operations successful.
E_FAIL: Cleaning operations failed.

o BeforeUpdating

public virtual BeforeUpdating( iMeshPart)

Performs cleaning operations before updating a Mesh Part.
Role: This method is called before updating a Mesh Part and performs necessary cleaning operations.

Parameters:

iMeshPart: The Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: Cleaning operations successful.
E_FAIL: Cleaning operations failed.

o Check

public virtual Check( iMeshPart)

Checks the supports of the Mesh Part.
Role: This method is called whenever a support is defined on its Mesh Part to check if it can be meshed.
It also retreives the parents Mesh Parts if any. A parent Mesh Parts is a Mesh Parts that should updated before the actual mesh. For example, in the case of a mesher connecting to geometric parts, the parents Mesh Parts are the one corresponding to these two parts.

Parameters:

iMeshPart: The Mesh Part to check.
oParentMeshParts: The list of parents Mesh Parts.

Returns:

An HRESULT.
Legal values:

S_OK: The support are valid and can be meshed.
E_FAIL: The support are not valid or the parent Mesh Parts can not be found.

o CloseEdition

public virtual CloseEdition(

)

Performs mesher-specific operations before exiting edition mode for a Mesh Part.
Role: This method is called before exiting edition mode for a Mesh Part and can be used to perform mesher-specific operations ( see ).

Parameters:

iMeshPart: The Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: Operations successful.
E_FAIL: Operations failed.

o GetMeshedBodies

public virtual GetMeshedBodies(		`iMeshPart`,
		`oMeshedBodies`)

Deprecated:

R417 This method is replaced with Retrieves the 3D Bodies meshed by the Mesh Part.
Role: This method is called to retrieve the 3D Bodies meshed by the Mesh Part.

Parameters:

iMeshPart: The Mesh Part.
oMeshedBodies: The 3D Bodies meshed by the Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: The meshed 3D Bodies has been successfully retrieved.
E_FAIL: The retrieval of the meshed 3D Bodies failed.

o GetMeshedShapes

public virtual GetMeshedShapes(		`iMeshPart`,
		`oMeshedShapes`)

Deprecated:

R417 This method is replaced with Retrieves the 3D Shapes meshed by the Mesh Part.
Role: This method is called to retrieve the 3D Shapes meshed by the Mesh Part.

Parameters:

iMeshPart: The Mesh Part.
oMeshedShapes: The 3D Shapes meshed by the Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: The meshed 3D Shapes has been successfully retrieved.
E_FAIL: The retrieval of the meshed 3D Shapes failed.

o GetParentMeshParts

public virtual GetParentMeshParts(		`iMeshPart`,
		`oParentMeshParts`)

Retrieves the parent Mesh Part. the parent Mesh Part must be updated before the mesh of Mesh Part.
Role: This method retreives the parents Mesh Parts if any. A parent Mesh Parts is a Mesh Parts that should updated before the actual mesh. For example, in the case of a mesher connecting to geometric parts, the parents Mesh Parts are the one corresponding to these two parts.

Parameters:

iMeshPart: The Mesh Part to retrieve his parent.
oParentMeshParts: The list Paths to the parents Mesh Parts.

Returns:

An HRESULT.
Legal values:

S_OK: the parent Mesh Parts are found.
E_FAIL: the parent Mesh Parts can not be found.

o Invalidate

public virtual Invalidate( iMeshPart)

Invalidates the mesh and the topology corresponding to the Mesh Part. The mesh and the topology will have to be regenerated.
Role: This method is called to regenerate the mesh and the topology from scratch.

Parameters:

iMeshPart: The Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: Mesh and topology successfully invalidated.
E_FAIL: Invalidation failed.

o IsATypeOf

public virtual IsATypeOf(		`iMeshPart`,
	const	`iType`)

Queries the mesher about the type of the Mesh Part.

Parameters:

iMeshPart

The Mesh Part to check.

iType

String representing the query made to the mesher.
Legal values:

"1D": Is the mesher generating 1D finite elements?
"2D": Is the mesher generating 2D finite elements?
"3D": Is the mesher generating 3D finite elements?
"Connection": Is the mesher generating connecting elements between meshes?

Returns:

The result of the query.
Legal values:

1: The answer is yes.
0: The answer is no.

o IsMeshingBodies

public virtual IsMeshingBodies(		`iMeshPart`,
		`oIsMeshingBodies`)

Queries the mesher to know if the Mesh Part is meshing 3D bodies or not.

Parameters:

iMeshPart: The Mesh Part.
oIsMeshingBodies: The query result.

Returns:

An HRESULT.
Legal values:

S_OK: The query has been proceeded with success.
E_FAIL: Query failed.

o IsMeshingShapes

public virtual IsMeshingShapes(		`iMeshPart`,
		`oIsMeshingShapes`)

Queries the mesher to know if the Mesh Part is meshing 3D shapes or not.

Parameters:

iMeshPart: The Mesh Part.
oIsMeshingShapes: The query result.

Returns:

An HRESULT.
Legal values:

S_OK: The query has been proceeded with success.
E_FAIL: Query failed.

o Mesh

public virtual Mesh( iMeshPart)

Builds the mesh corresponding to the Mesh Part.
Role: This method is called to build the mesh from a Mesh Part according all local and global specifications.
The generated nodes and finite elements are created using the interface and the corresponding links with geometry are created using the interface.

Parameters:

iMeshPart: The Mesh Part to mesh.

Returns:

An HRESULT.
Legal values:

S_OK: The mesh have been successfully generated.
E_FAIL: The mesh operation failed.

o OnMeshPartRemove

public virtual OnMeshPartRemove( iMeshPart)

Performs cleaning operations before removing a Mesh Part.
Role: This method is called before removing a Mesh Part and performs necessary cleaning operations.

Parameters:

iMeshPart: The Mesh Part.

Returns:

An HRESULT.
Legal values:

S_OK: Cleaning operations successful.
E_FAIL: Cleaning operations failed.

This object is included in the file: CATIFmtMesher.h
If needed, your Imakefile.mk should include the module: CATFmtModelInterfaces