All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFmtModelInterfaces Interface CATIFmtMeshPart

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIFmtMeshPart

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 .

Method Index

o Check(): Check the Mesh Part.
o CloseEdition(CATBoolean): Exit the Mesh Part from the edition mode.
o Contains(CATFmtElement*): Check if the Mesh Part contains a given finite element.
o Copy(CATIFmtMeshPart*,CATMathTransformation*,int): Copy the content (nodes & elements) of a Mesh Part into the current one.
o CreateLocalSpecification(CATString&,CATUnicodeString&,CATUnicodeString&,CATIFmtLocalSpecification*&): Creates a new local specification within the Mesh Part.
o GetActivity(): Returns the current state of the Mesh Part.
o GetExternalReference(CATString&,CATUnicodeString&,CATFmtPath*&,int): Retreive an external reference in a global mesh specification.
o GetFeature(CATString&): Returns features aggregated in the Mesh Part.
o GetFirstMeshDomain(): Returns the first Mesh Domain of the Mesh Part.
o GetGlobalSpecification(CATString&,CATUnicodeString&,int&): Retreives the integer value of a global mesh specification.
o GetGlobalSpecification(CATString&,CATUnicodeString&,double&): Retreives the real double value of a global mesh specification.
o GetGlobalSpecification(CATString&,CATUnicodeString&,CATBaseUnknown*&): Retreives the pointer value of a global mesh specification.
o GetGlobalSpecification(CATString&,CATUnicodeString&,CATUnicodeString&): Retreives the character value of a global mesh specification.
o GetLastMeshDomain(): Returns the last Mesh Domain of the Mesh Part.
o GetLocalSpecifications(CATString&,CATUnicodeString&,CATListValCATBaseUnknown_var&): Get local specifications of the Mesh.
o GetMesh(): Returns the Mesh corresponding to 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(CATString&,CATUnicodeString&): Returns the number of references defined in a global mesh specification.
o GetNumberOfSupports(): Returns the number of supports defined.
o GetParentMeshParts(CATFmtListOfPath*&): Retreives the parent Mesh Parts of the part.
o GetSupport(CATFmtPath*&,int): Retreives a support from it's number.
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 RemoveExternalReference(CATString&,CATUnicodeString&,CATFmtPath*): Remove a support of an external reference in a global mesh specification.
o RemoveMesh(): Remove the mesh corresponding to the Mesh Part.
o RemoveSupport(CATFmtPath*): Remove a support.
o SetActivity(int): Set the current state of the Mesh Part.
o SetExternalReference(CATString&,CATUnicodeString&,CATFmtPath*,int,CATUnicodeString&): Valuates a global mesh specification with external reference.
o SetGlobalSpecification(CATString&,CATUnicodeString&,int): Valuates a global mesh specification to a integer value.
o SetGlobalSpecification(CATString&,CATUnicodeString&,double): Valuates a global mesh specification to a real double value.
o SetGlobalSpecification(CATString&,CATUnicodeString&,CATUnicodeString&): Valuates a global mesh specification to a character value.
o SetMeshPartsToCapture(CATFmtListOfPath*): Set the list of candidate Mesh Parts for capture.
o SetMeshVisibility(CATBoolean): Sets the Mesh Part visualization status.
o SetSupport(CATFmtPath*,int,CATUnicodeString&): Defines a support.

Methods

o Check

public virtual 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

public virtual CloseEdition( iUpTodate = TRUE )

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

public virtual Contains( iElement)

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

public virtual Copy(	`iMeshPart`,
	`iTransfo`	`= NULL` ,
	`iDoNotCopyAssociativity`	`= 0` )

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

public virtual CreateLocalSpecification(	const	`iType`,
	const	`iLateType`,
	const	`iName`,
		`oLocalSpec`)

Creates a new local specification within the Mesh Part.
Role: This methods creates local specification within the Mesh Part.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the local specification (Late type of the local specification).
oLocalSpec: [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 GetActivity(

)

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 GetExternalReference

public virtual GetExternalReference(	const	`iType`,
	const	`iName`,
		`oReference`,
		`iNumber`	`= 1` )

Retreive an external reference in a global mesh specification.
Role: An external reference is defined by a Product Linkable Object ( PLO )

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global mesh specification.
oReference: [out, CATBaseUnknown#Release] Path to the external reference.
iNumber: The reference number. Should be between 1 and the number of external reference.

Returns:

An HRESULT.
Legal values:

S_OK: The external reference has been successfully retreived.
E_FAIL: The external reference has not been retreived.

o GetFeature

public virtual GetFeature( const Type)

Returns features aggregated in the Mesh Part.

Parameters:

iType: Type of the feature ("Mesh" or "Topology").

Returns:

the feature to access.
Lifecycle rules deviation: No AddRef is done on returned value.

o GetFirstMeshDomain

public virtual GetFirstMeshDomain(

)

Returns the first Mesh Domain of the Mesh Part.
See method to scan the other Mesh Domains.

o GetGlobalSpecification

public virtual GetGlobalSpecification(	const	`iType`,
	const	`iName`,
		`oValue`)

Retreives the integer value of a global mesh specification.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global specification.
oValue: Integer value of the specification.

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o GetGlobalSpecification

public virtual GetGlobalSpecification(	const	`iType`,
	const	`iName`,
		`oValue`)

Retreives the real double value of a global mesh specification.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global specification.
oValue: Real double value of the specification. ( In case of Length, oValue is evaluated in millimeters ).

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o GetGlobalSpecification

public virtual GetGlobalSpecification(	const	`iType`,
	const	`iName`,
		`oValue`)

Retreives the pointer value of a global mesh specification.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global specification.
oValue: [out, CATBaseUnknown#Release] Pointer to the value of the specification.

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o GetGlobalSpecification

public virtual GetGlobalSpecification(	const	`iType`,
	const	`iName`,
		`oValue`)

Retreives the character value of a global mesh specification.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global specification.
oValue: Character value of the specification.

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o GetLastMeshDomain

public virtual GetLastMeshDomain(

)

Returns the last Mesh Domain of the Mesh Part.
See method to scan the other Mesh Domains.

o GetLocalSpecifications

public virtual GetLocalSpecifications(	const	`iType`,
	const	`iLateType`,
		`oListOfSpecifications`)

Get local specifications of the Mesh.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iLateType: Name of the local specification.
LocalSpec: Collection of local specifications

o GetMesh

public virtual GetMesh(

)

Returns the Mesh corresponding to the Mesh Part.
Lifecycle rules deviation: No AddRef is done on returned value.

o GetMeshManager

public virtual GetMeshManager(

)

Returns the Mesh Manager corresponding to the Mesh Part.

Returns:: CATBaseUnknown#Release

o GetMeshVisibility

public virtual 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 GetNumberOfElements(

)

Returns the number of finite elements belonging to the Mesh Part.

o GetNumberOfExternalReferences

public virtual GetNumberOfExternalReferences(	const	`iType`,
	const	`iName`)

Returns the number of references defined in a global mesh specification.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global mesh specification.

Returns:

the number of references defined.

o GetNumberOfSupports

public virtual GetNumberOfSupports(

)

Returns the number of supports defined.

o GetParentMeshParts

public virtual GetParentMeshParts( oParents)

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

Parameters:

oParents: The list of Paths to the parent Mesh Parts.

Returns:

An HRESULT.
Legal values:

S_OK: The list has been successfully retreived.
E_FAIL: The operation failed.

o GetSupport

public virtual GetSupport(		`oSupport`,
		`iNumber`	`= 1` )

Retreives a support from it's number.
Role: A support is defined by a CATFmtPath ( PLO )

Parameters:

oSupport: [out, CATBaseUnknown#Release] Path to the suppport of mesh part.
iNumber: Number of the requested support
Legal values between 1 and the number of supports.

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 IsInEdition

public virtual IsInEdition(

)

Check if the Mesh Part is in edition mode. Returns:
Legal values:

0: if the Mesh Part is in edition.
1: if the Mesh Part is not in edition.

o IsOfType

public virtual IsOfType( const iType)

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

public virtual Next(

)

Returns the next Mesh Part of the Mesh. This method should be used with the 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

public virtual OpenEdition( iInvalidate = TRUE )

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 meshser of the Mesh Part.

Parameters:

iInvalidate

Legal values:

"TRUE": The Mesh Part is no more up to date if edited.
"FALSE": The Mesh Part is still up to date if edited.

Returns:

An HRESULT.
Legal values:

S_OK: The edition mode have been successfully activated.
E_FAIL: Unable to enter in edition mode.

o RemoveExternalReference

public virtual RemoveExternalReference(	const	`iType`,
	const	`iName`,
		`iSupport`)

Remove a support of an external reference in a global mesh specification.
Role: An object is defined by a Product Linkable Object ( PLO ).

Parameters:

iType: Type of specification ("Mesh" or "Topology").
iName: Name of the global mesh specification.
iSupport: Path to the external reference.

Returns:

An HRESULT.
Legal values:

S_OK: The support has been successfully removed.
E_FAIL: The support removal of the external reference is not allowed for this local specification.

o RemoveMesh

public virtual RemoveMesh(

)

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. An HRESULT.
Legal values:

S_OK: Mesh succesfuly removed.
E_FAIL: Operation failed.

o RemoveSupport

public virtual RemoveSupport( iSupport = NULL )

Remove a support.

Parameters:

iSupport: Path to the support to be removed. If NULL all supports are removed.

Returns:

An HRESULT.
Legal values:

S_OK: The support has been successfully removed.
E_FAIL: The support is not allowed for this Mesh Part.

o SetActivity

public virtual SetActivity( iActivity)

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

public virtual SetExternalReference(	const	`iType`,
	const	`iName`,
		`iSupport`,
		`iMode`	`= 0` ,
	const	`iLinkType`	`= ""` )

Valuates a global mesh specification with external reference.

Parameters:

iType

type of specification ("Mesh" or "Topology").

iName

Name of the global mesh specification.

iSupport

Path to 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.

iLinkType

Type of the created link pointing to the external reference. (Should be left blank)

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

public virtual SetGlobalSpecification(	const	`iType`,
	const	`iName`,
		`iValue`)

Valuates a global mesh specification to a integer value.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global specification.
iValue: Integer value to be used for the specification.

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o SetGlobalSpecification

public virtual SetGlobalSpecification(	const	`iType`,
	const	`iName`,
		`iValue`)

Valuates a global mesh specification to a real double value.

Parameters:

iType: type of specification ("Mesh" or "Topology").
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 ).

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o SetGlobalSpecification

public virtual SetGlobalSpecification(	const	`iType`,
	const	`iName`,
	const	`iValue`)

Valuates a global mesh specification to a character value.

Parameters:

iType: type of specification ("Mesh" or "Topology").
iName: Name of the global specification.
iValue: Character value to be used for the specification.

Returns:

An HRESULT.
Legal values:

S_OK: The valuation successfully done.
E_FAIL: Invalid specification.

o SetMeshPartsToCapture

public virtual SetMeshPartsToCapture( iParents)

Set the list of candidate Mesh Parts for capture.

Parameters:

iParents: List of candidate Path to Mesh Parts for capture.

Returns:

An HRESULT.
Legal values:

S_OK: Operation successful.
E_FAIL: Operation failed.

o SetMeshVisibility

public virtual SetMeshVisibility( iVisibility)

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

public virtual SetSupport(		`iSupport`,
		`iMode`	`= 0` ,
	const	`iType`	`= ""` )

Defines a support.
Role: A support is defined by a CATFmtPath

Parameters:

iSupport

CATFmtPath object representing the 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.
iType: Type of the simulation connector which is created to point to the support.

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: CATIFmtMeshPart.h
If needed, your Imakefile.mk should include the module: CATFmtModelInterfaces