All Frameworks Class Hierarchy This Framework Previous Next Indexes
AnalysisMeshingModel Interface CATIMSHMeshPart
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIMSHMeshPart
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMSHMeshPart
Interface representing a Mesh Part.
Role: This interface should be used to access all data associated to a Mesh Part,
such as global and local mesh specifications or geometry to be meshed (supports).
A Mesh Part is an Analysis Set which has some specific attributes (global specifications
and supports) and can contain Analysis Entities which represent local mesh specifications.
Associated to each Mesh Part, there is a Mesher which is called to check the supports and
to build the mesh, see CATIMSHMesher.
Method Index
- o
Check()
- Check the Mesh Part.
- o
CloseEdition(CATBoolean)
- Exit the Mesh Part from the edition mode.
- o
Contains(CATMSHElement*)
- Check if the Mesh Part contains a given finite element.
- o
Copy(CATIMSHMeshPart*,CATMathTransformation*,int)
- Copy the content (nodes & elements) of a Mesh Part into the current one.
- o
CreateLocalSpecification(CATUnicodeString&,CATUnicodeString&)
- Creates a new local specification within the Mesh Part.
- o
CreateLocalSpecification(CATUnicodeString&,CATUnicodeString&,CATIMSHLocalSpecification*&)
- Creates a new local specification within the Mesh Part.
- o
GetActivity()
- Returns the current state of the Mesh Part.
- o
GetElements(CATMSHElement**&)
- Retreives the list of finite elements belonging to the Mesh Parts.
- o
GetExternalReference(CATUnicodeString&,CATIProduct*&,CATILinkableObject*&,int,CATMSHExternalReferenceStatus*)
- Retreive an external reference in a global mesh specification.
- o
GetFirstMeshDomain()
- Returns the first Mesh Domain of the Mesh Part.
- o
GetGlobalSpecification(CATUnicodeString&,CATISpecObject*&)
- Retreives the CATISpecObject value of a global mesh specification.
- o
GetGlobalSpecification(CATUnicodeString&,CATUnicodeString&)
- Retreives the character value of a global mesh specification.
- o
GetGlobalSpecification(CATUnicodeString&,double&)
- Retreives the real double value of a global mesh specification.
- o
GetGlobalSpecification(CATUnicodeString&,int&)
- Retreives the integer value of a global mesh specification.
- o
GetLastMeshDomain()
- Returns the last Mesh Domain of the Mesh Part.
- o
GetMeshManager()
- Returns the Mesh Manager corresponding to the Mesh Part.
- o
GetMeshVisibility()
- Retrieves the visibility status of the Mesh Part.
- o
GetNumberOfElements()
- Returns the number of finite elements belonging to the Mesh Part.
- o
GetNumberOfExternalReferences(CATUnicodeString&)
- Returns the number of references defined in a global mesh specification.
- o
GetNumberOfSupports()
- Returns the number of supports defined.
- o
GetParentMeshParts(CATMSHListOfMeshPart*&,CATMSHExternalReferenceStatus*)
- Retreives the parent Mesh Parts of the part.
- o
GetSupport(CATIProduct*&,CATILinkableObject*&,int,CATMSHExternalReferenceStatus*)
- Retreives a support from it's number.
- o
GetSupportConnector(int)
- Returns a CATISamAnalysisConnector interface on a Mesh Part geometric support.
- o
IsInEdition()
- Check if the Mesh Part is in edition mode.
- o
IsOfType(CATUnicodeString&)
- Query the Mesh Part about the type of mesh generated.
- o
Next()
- Returns the next Mesh Part of the Mesh.
- o
OpenEdition(CATBoolean)
- Enter the Mesh Part into edition mode.
- o
RemoveMesh()
- Remove the mesh corresponding to the Mesh Part.
- o
SetActivity(int)
- Set the current state of the Mesh Part.
- o
SetExternalReference(CATUnicodeString&,CATIProduct*,CATILinkableObject*,int)
- Valuates a global mesh specification with external reference.
- o
SetGlobalSpecification(CATUnicodeString&,CATUnicodeString&)
- Valuates a global mesh specification to a character value.
- o
SetGlobalSpecification(CATUnicodeString&,double)
- Valuates a global mesh specification to a real double value.
- o
SetGlobalSpecification(CATUnicodeString&,int)
- Valuates a global mesh specification to a integer value.
- o
SetMeshPartsToCapture(CATMSHListOfMeshPart*)
- Set the list of candidate Mesh Parts for capture.
- o
SetMeshVisibility(CATBoolean)
- Sets the Mesh Part visualization status.
- o
SetSupport(CATIProduct*,CATILinkableObject*,int)
- Defines a support.
Methods
o Check
-
Check the Mesh Part.
Role: The Mesh Part is analysed to see if the supports are still valid.
The Check method is also called at the end of the SetSupport method.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The supports are still valid
- E_FAIL
- The supports are no longer valid, the Mesh Part can no longer be updated.
o CloseEdition
-
Exit the Mesh Part from the edition mode.
Role: This method should be called after editing the content of the Mesh Part,
i.e. after modifying nodes and elements independently from the meshser of the Mesh Part.
- Parameters:
-
- iUpTodate
-
Legal values:
- "TRUE"
- The Mesh Part should be considered as up to date at the end of edition.
- "FALSE"
- The Mesh Part is not up to date at the end of edition.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The edition mode have been successfully exited.
- E_FAIL
- Some problems encountered while exiting the edition mode.
o Contains
-
Check if the Mesh Part contains a given finite element.
- Parameters:
-
- iElement
- The finite element to be checked.
- Returns:
- An integer value:.
- 0
- if the Mesh Part contains the finite element.
- 1
- otherwise.
o Copy
-
Copy the content (nodes & elements) of a Mesh Part into the current one.
Role: This method should be used only to copy nodes and elements of a Mesh Part
while implementing a Mesher. See
CATIMSHMesher.Mesh method.
- Parameters:
-
- iMeshPart
- Mesh Parts containing nodes and elements to copy.
- iTransfo
- Transformation to be applied during copy.
- iDoNotCopyAssociativity
-
Legal values:
- 0
- Nodes and elements associativity is copied.
- 1
- Nodes and elements associativity is not copied.
o CreateLocalSpecification
-
Creates a new local specification within the Mesh Part.
Role: A local mesh specification is an Analysis Entity which is
created in the Analysis Set corresponding to the Mesh Part.
- Parameters:
-
- iType
- Type of the local specification (Late type of the Analysis Entity).
- iName
- Name of the local specification.
- iNumber
- Number of the requested reference
Legal values between 1 and the number of references.
- Returns:
- The created local specification.
o CreateLocalSpecification
-
Creates a new local specification within the Mesh Part.
Role: This methods creates local specification within the Mesh Part.
- Parameters:
-
- iType
- Type of the local specification (Late type of the local specification).
- iName
- Name of the local specification.
- LocalSpec
- [out, CATBaseUnknown#Release] Pointer on the created local specification.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The local specification has been successfully set.
- E_FAIL
- The local specification was not created.
o GetActivity
public virtual int GetActivity( | )=0 |
-
Returns the current state of the Mesh Part.
Possible values:
- 0
- Mesh Part is not active.
- 1
- Mesh Part is active.
When a Mesh Part is active, all its elements are visible and will be taken into account for computation.
When a Mesh Part is not active, all its elements are not visible and will be ignored in any computation.
o GetElements
-
Retreives the list of finite elements belonging to the Mesh Parts.
- Parameters:
-
- oElements
- Array containing pointers on all elements belonging to the Mesh Parts.
- Returns:
- The number of finite elements belonging to the Mesh Parts.
o GetExternalReference
-
Retreive an external reference in a global mesh specification.
Role: An external reference is defined by a product instance which is use for positionning the mesh and
an external object which is handled by its CATILinkableObject interface.
- Parameters:
-
- iName
- Name of the global mesh specification.
- oProduct
- [out, CATBaseUnknown#Release] The product instance which contains the reference.
- oReference
- [out, CATBaseUnknown#Release] CATILinkableObject interface of the reference.
- oStatus
- The status explaining failure causes:
Legal values:
- CATMSHRefNotDefined
- The external reference has not been defined.
- CATMSHRefDeleted
- The external reference has been deleted.
- CATMSHRefNotLoaded
- The external reference is not loaded.
- CATMSHRefLoaded
- The external reference has been retreived, execution successful.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The external reference has been successfully retreived.
- E_FAIL
- The external reference has not been retreived.
o GetFirstMeshDomain
-
Returns the first Mesh Domain of the Mesh Part.
See
CATMSHMeshDomain.Next method to scan the other Mesh Domains.
o GetGlobalSpecification
-
Retreives the CATISpecObject value of a global mesh specification.
- Parameters:
-
- iName
- Name of the global specification.
- oValue
- [out, CATBaseUnknown#Release] CATISpecObject value of the specification.
o GetGlobalSpecification
-
Retreives the character value of a global mesh specification.
- Parameters:
-
- iName
- Name of the global specification.
- oValue
- Character value of the specification.
o GetGlobalSpecification
public virtual void GetGlobalSpecification( | const CATUnicodeString& | iName, |
| double& | oValue)= 0 |
-
Retreives the real double value of a global mesh specification.
- Parameters:
-
- iName
- Name of the global specification.
- oValue
- Real double value of the specification.
( In case of Length, oValue is evaluated in millimeters ).
o GetGlobalSpecification
public virtual void GetGlobalSpecification( | const CATUnicodeString& | iName, |
| int& | oValue)= 0 |
-
Retreives the integer value of a global mesh specification.
- Parameters:
-
- iName
- Name of the global specification.
- oValue
- Integer value of the specification.
o GetLastMeshDomain
-
Returns the last Mesh Domain of the Mesh Part.
See
CATMSHMeshDomain.Previous method to scan the other Mesh Domains.
o GetMeshManager
-
Returns the Mesh Manager corresponding to the Mesh Part.
- Returns:
- CATBaseUnknown#Release
o GetMeshVisibility
-
Retrieves the visibility status of the Mesh Part.
- Returns:
- A CATBoolean.
Legal values:
- FALSE
- The Mesh Part is not visible.
- TRUE
- The Mesh Part is visible.
o GetNumberOfElements
public virtual int GetNumberOfElements( | )= 0 |
-
Returns the number of finite elements belonging to the Mesh Part.
o GetNumberOfExternalReferences
-
Returns the number of references defined in a global mesh specification.
- Parameters:
-
- iName
- Name of the global mesh specification.
- Returns:
- the number of references defined.
o GetNumberOfSupports
public virtual int GetNumberOfSupports( | )= 0 |
-
Returns the number of supports defined.
o GetParentMeshParts
-
Retreives the parent Mesh Parts of the part.
Role: A parent Mesh Part
is a Mesh Part 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 (see
CATIMSHMesher ).
- Parameters:
-
- oParents
- The list of parent Mesh Parts.
- oStatus
- The status explaining failure causes:
Legal values:
- CATMSHRefNotLoaded
- At leat one parent Mesh Parts is not loaded.
- CATMSHRefLoaded
- Parent Mesh Parts have been retreived, execution successful.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The list has been successfully retreived.
- E_FAIL
- The operation failed.
o GetSupport
-
Retreives a support from it's number.
Role: A support is defined by a product instance which is use for positionning the mesh and
a geometric support which is handled by its CATILinkableObject interface.
- Parameters:
-
- oProduct
- [out, CATBaseUnknown#Release] The product instance which contains the support.
- oSupport
- [out, CATBaseUnknown#Release] CATILinkableObject interface of the geometric support.
- iNumber
- Number of the requested support
Legal values between 1 and the number of supports.
- oStatus
- The status explaining failure causes:
Legal values:
- CATMSHRefNotDefined
- The support has not been defined.
- CATMSHRefDeleted
- The support has been deleted.
- CATMSHRefNotLoaded
- The support is not loaded.
- CATMSHRefLoaded
- The support has been retreived, execution successful.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The support has been successfully retreived.
- E_FAIL
- The support can not be retreived for this Mesh Part. See Status output argument for a more detailed explanation.
o GetSupportConnector
-
Returns a CATISamAnalysisConnector interface on a Mesh Part geometric support.
- Returns:
- CATBaseUnknown#Release
- Parameters:
-
- iNumber
- Number of the requested support
Legal values between 1 and the number of supports.
o IsInEdition
public virtual int IsInEdition( | )=0 |
-
Check if the Mesh Part is in edition mode.
Returns:
- 0
- if the Mesh Part is in edition.
- 1
- if the Mesh Part is not in edition.
When a Mesh Part is active, all its elements are visible and will be taken into account for computation.
When a Mesh Part is not active, all its elements are not visible and will be ignored in any computation.
o IsOfType
-
Query the Mesh Part about the type of mesh generated.
- Parameters:
-
- iType
- String representing the query made to the Mesh Part.
Legal values:
- "1D"
- Is the Mesh Part generating 1D finite elements?
- "2D"
- Is the Mesh Part generating 2D finite elements?
- "3D"
- Is the Mesh Part generating 3D finite elements?
- "Connection"
- Is the Mesh Part generating connecting elements between meshes?
- Returns:
- The result of the query.
Legal values:
- 1
- The answer is yes.
- 0
- The answer is no.
o Next
-
Returns the next Mesh Part of the Mesh.
This method should be used with the
CATIMSHMesh.GetFirstMeshPart method to scan all Mesh Parts. Take care of the fact that the order in which Mesh Parts are returned is arbitrary qnd
that only Mesh Parts containing elements are returned.
- Returns:
- CATBaseUnknown#Release
o OpenEdition
-
Enter the Mesh Part into edition mode.
Role: This method should be called before editing the content of the Mesh Part,
i.e. before modifying nodes and elements independently from the mesher of the Mesh Part.
- Parameters:
-
- iInvalidateOperators
-
Legal values:
- "TRUE"
- The Mesh Operators are invalidated and will be re-updated when existing from the edition modeas up to date at the end of edition.
- "FALSE"
- The Mesh Operators are not invalidated.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The edition mode have been successfully activated.
- E_FAIL
- Unable to enter in edition mode.
o RemoveMesh
public virtual void RemoveMesh( | )= 0 |
-
Remove the mesh corresponding to the Mesh Part.
Role: Deletes all the nodes and elements that have been generated by the Mesher corresponding to the
Mesh Part.
o SetActivity
public virtual void SetActivity( | int | iActivity)=0 |
-
Set the current state of the Mesh Part.
- Parameters:
-
- iActivity
-
Legal values:
- 0
- to set the Mesh Part unactive.
- 1
- to set the Mesh Part active.
o SetExternalReference
-
Valuates a global mesh specification with external reference.
Role: An object is defined by a product instance which is use for positionning the mesh and
a geometric support which is handled by its CATILinkableObject interface.
- Parameters:
-
- iName
- Name of the global mesh specification.
- iProduct
- The product instance of the external reference.
- iReference
- CATILinkableObject interface of the external reference.
- iMode
- The mode used to valuate the reference global specification.
Legal values:
- 0
- the global specification is defined as a single reference.
- 1
- the global specification is added to exising references.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The external reference has been successfully created.
- E_FAIL
- The external reference is not allowed for this local specification.
o SetGlobalSpecification
-
Valuates a global mesh specification to a character value.
- Parameters:
-
- iName
- Name of the global specification.
- iValue
- Character value to be used for the specification.
o SetGlobalSpecification
public virtual void SetGlobalSpecification( | const CATUnicodeString& | iName, |
| double | iValue)= 0 |
-
Valuates a global mesh specification to a real double value.
- Parameters:
-
- iName
- Name of the global specification.
- iValue
- Real double value to be used for the specification.
( In case of Length, iValue is evaluated in millimeters ).
o SetGlobalSpecification
public virtual void SetGlobalSpecification( | const CATUnicodeString& | iName, |
| int | iValue)= 0 |
-
Valuates a global mesh specification to a integer value.
- Parameters:
-
- iName
- Name of the global specification.
- iValue
- Integer value to be used for the specification.
o SetMeshPartsToCapture
-
Set the list of candidate Mesh Parts for capture.
- Parameters:
-
- iParents
- List of candidate Mesh Parts for capture.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- Operation successfull.
- E_FAIL
- Operation failed.
o SetMeshVisibility
-
Sets the Mesh Part visualization status.
Role: Hide / Show the mesh part.
- Parameters:
-
- iVisibility
-
Legal values:
- FALSE
- The Mesh Part is not visible
- TRUE
- The Mesh Part is visible
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The mesh visibility status has been set.
- E_FAIL
- The mesh visibility status cannot be set.
o SetSupport
-
Defines a support.
Role: A support is defined by a product instance which is use for positionning the mesh and
a geometric support which is handled by its CATILinkableObject interface.
- Parameters:
-
- iProduct
- The product instance which contains the support.
- iSupport
- CATILinkableObject interface of the geometric support.
- iMode
- The mode used to define support.
Legal values:
- 0
- the support is defined as a single support.
- 1
- the support is added to exising supports.
- 2
- switch, ie. added if new, suppressed if already existing.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The support has been successfully created.
- E_FAIL
- The support is not allowed for this Mesh Part.
This object is included in the file: CATIMSHMeshPart.h
If needed, your Imakefile.mk should include the module: CATAmtModel