CATFmtModelInterfaces CATFmtFEEntities
Usage: you must use this class as is. You should never derive it.
public class CATFmtFEEntities
Class representing a group of finite element entities (nodes, elements, faces or edges) belonging to
the same instance of a Mesh.
Constructor and Destructor Index
- o
CATFmtFEEntities(CATFmtPath*,CATFmtFEEntityType)
-
Method Index
- o
AddEdges(int,CATFmtEdge*,CATBoolean)
- Add edges to the Group.
- o
AddElements(int,CATFmtElement**,CATBoolean)
- Add elements to the Group.
- o
AddFaces(int,CATFmtFace*,CATBoolean)
- Add faces to the Group.
- o
AddNodes(int,CATFmtNode**,CATBoolean)
- Add nodes to the Group.
- o
GetEdges()
- Retreives the list of finite element edges belonging to the Group.
- o
GetEdges(CATFmtEdge*&)
- Retreives the list of finite element edges belonging to the Group.
- o
GetElements()
- Retreives the list of finite elements belonging to the Group.
- o
GetElements(CATFmtElement**&)
- Retreives the list of finite elements belonging to the Group.
- o
GetFaces()
- Retreives the list of finite element faces belonging to the Group.
- o
GetFaces(CATFmtFace*&)
- Retreives the list of finite element faces belonging to the Group.
- o
GetMeshManager()
- Returns the instance of the Mesh Manager corresponding to finite elements entities contained in the Group.
- o
GetNodes()
- Retreives the list of finite element nodes belonging to the Group.
- o
GetNodes(CATFmtNode**&)
- Retreives the list of finite elements nodes belonging to the Group.
- o
GetSize()
- Returns the number of finite elements entities contained in the Group.
- o
GetType()
- Returns the type of finite elements entities contained in the Group.
Constructor and Destructor
o CATFmtFEEntities
| public CATFmtFEEntities( | | iMeshManager, |
| | iType) |
-
Methods
o AddEdges
| public AddEdges( | | iNbEdges, |
| | iEdges, |
| | iArrayManagedByGroup | = FALSE ) |
-
Add edges to the Group.
- Parameters:
-
- iNbEdges
- Number of edges to be added to the Group.
- iEdges
- Array containing pointers on all edges to be added to the Group.
- iArrayManagedByGroup
- A bolean.
Legal values:
- TRUE
- The life cycle of the input array is managed by the Group.
- FALSE
- A copy of the input array is done and managed by the Group.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The edges have been successfully added to the Group.
- E_FAIL
- An error occured.
o AddElements
| public AddElements( | | iNbElements, |
| | iElements, |
| | iArrayManagedByGroup | = FALSE ) |
-
Add elements to the Group.
- Parameters:
-
- iNbElements
- Number of elements to be added to the Group.
- iElements
- Array containing pointers on all elements to be added to the Group.
- iArrayManagedByGroup
- A bolean.
Legal values:
- TRUE
- The life cycle of the input array is managed by the Group.
- FALSE
- A copy of the input array is done and managed by the Group.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The elements have been successfully added to the Group.
- E_FAIL
- An error occured.
o AddFaces
| public AddFaces( | | iNbFaces, |
| | iFaces, |
| | iArrayManagedByGroup | = FALSE ) |
-
Add faces to the Group.
- Parameters:
-
- iNbFaces
- Number of faces to be added to the Group.
- iFaces
- Array containing pointers on all faces to be added to the Group.
- iArrayManagedByGroup
- A bolean.
Legal values:
- TRUE
- The life cycle of the input array is managed by the Group.
- FALSE
- A copy of the input array is done and managed by the Group.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The faces have been successfully added to the Group.
- E_FAIL
- An error occured.
o AddNodes
| public AddNodes( | | iNbNodes, |
| | iNodes, |
| | iArrayManagedByGroup | = FALSE ) |
-
Add nodes to the Group.
- Parameters:
-
- iNbNodes
- Number of nodes to be added to the Group.
- iNodes
- Array containing pointers on all nodes to be added to the Group.
- iArrayManagedByGroup
- A bolean.
Legal values:
- TRUE
- The life cycle of the input array is managed by the Group.
- FALSE
- A copy of the input array is done and managed by the Group.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The nodes have been successfully added to the Group.
- E_FAIL
- An error occured.
o GetEdges
-
Retreives the list of finite element edges belonging to the Group.
- Returns:
- An array containing pointers on all edges belonging to the Group.
o GetEdges
| public GetEdges( | | ioEdges) |
-
Retreives the list of finite element edges belonging to the Group.
- Parameters:
-
- ioEdges
- Array containing pointers on all edges belonging to the Group.
Lifecycle rules deviation: If ioEdges is set to NULL before calling this method, an array of appropriate size is allocated and should be desallocated by the callee.
Otherwise, the ioEdges array is assumed to be allocated with enougth space to store ouputs.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The edges belonging to the Group have been successfully retreived.
- E_FAIL
- An error occured.
o GetElements
-
Retreives the list of finite elements belonging to the Group.
- Returns:
- An array containing pointers on all elements belonging to the Group.
o GetElements
| public GetElements( | | ioElements) |
-
Retreives the list of finite elements belonging to the Group.
- Parameters:
-
- ioElements
- Array containing pointers on all elements belonging to the Group.
Lifecycle rules deviation: If ioElements is set to NULL before calling this method, an array of appropriate size is allocated and should be desallocated by the callee.
Otherwise, the ioElements array is assumed to be allocated with enougth space to store ouputs.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The elements belonging to the Group have been successfully retreived.
- E_FAIL
- An error occured.
o GetFaces
-
Retreives the list of finite element faces belonging to the Group.
- Returns:
- An array containing pointers on all faces belonging to the Group.
o GetFaces
| public GetFaces( | | ioFaces) |
-
Retreives the list of finite element faces belonging to the Group.
- Parameters:
-
- ioEdges
- Array containing pointers on all faces belonging to the Group.
Lifecycle rules deviation: If ioFaces is set to NULL before calling this method, an array of appropriate size is allocated and should be desallocated by the callee.
Otherwise, the ioFaces array is assumed to be allocated with enougth space to store ouputs.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The faces belonging to the Group have been successfully retreived.
- E_FAIL
- An error occured.
o GetMeshManager
-
Returns the instance of the Mesh Manager corresponding to finite elements entities contained in the Group.
o GetNodes
-
Retreives the list of finite element nodes belonging to the Group.
- Returns:
- An array containing pointers on all nodes belonging to the Group.
o GetNodes
| public GetNodes( | | ioNodes) |
-
Retreives the list of finite elements nodes belonging to the Group.
- Parameters:
-
- ioNodes
- Array containing pointers on all nodes belonging to the Group.
Lifecycle rules deviation: If ioNodes is set to NULL before calling this method, an array of appropriate size is allocated and should be desallocated by the callee.
Otherwise, the ioNodes array is assumed to be allocated with enougth space to store ouputs.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The nodes belonging to the Group have been successfully retreived.
- E_FAIL
- An error occured.
o GetSize
-
Returns the number of finite elements entities contained in the Group.
o GetType
-
Returns the type of finite elements entities contained in the Group.
This object is included in the file: CATFmtFEEntities.h
If needed, your Imakefile.mk should include the module: CATFmtModelInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.