All Frameworks Class Hierarchy This Framework Indexes
AnalysisMeshingModel Interface CATIMSHLocalSpecification
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMSHLocalSpecification
Interface representing a local specification within a Mesh Part.
Role: This interface should be used to create local Specifications of a Mesh Part,
Method Index
- o
AddSupport(CATUnicodeString&,CATIProduct*,CATILinkableObject*)
- Defines the support of the local specification.
- o
AddSupports(CATUnicodeString&,int,CATIProduct**,CATILinkableObject**)
- Defines the support of the local specification.
- o
GetAttribute(CATUnicodeString&,int&)
- Retreives the integer value of a local specification.
- o
GetAttribute(CATUnicodeString&,double&)
- Retreives the real double value of a local specification.
- o
GetAttribute(CATUnicodeString&,CATUnicodeString&)
- Retreives the Character Value of a local specification.
- o
GetSupports(CATUnicodeString&,int&,CATIProduct**&,CATILinkableObject**&)
- Retreives all supports.
- o
SetAttribute(CATUnicodeString&,double)
- Valuates a local specification attribute to a real double value.
- o
SetAttribute(CATUnicodeString&,CATUnicodeString&)
- Valuates a local specification attribute to a Character value.
- o
SetAttribute(CATUnicodeString&,int)
- Valuates a local specification attribute to an integer value.
Methods
o AddSupport
| public virtual AddSupport( | const | iName, |
| | iProduct, |
| | iSupport) |
-
Defines the support of the local specification.
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:
-
- iName
- Name of the support of local specification.
- iProduct
- The product instance which contains the support.
- iSupport
- CATILinkableObject interface of the geometric support.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The support has been successfully created.
- E_FAIL
- The support is not allowed for this local specification.
o AddSupports
| public virtual AddSupports( | const | iName, |
| | iNbSupports, |
| | iProducts, |
| | iSupports) |
-
Defines the support of the local specification.
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:
-
- iName
- Name of the support of local specification.
- iNbSupports
- Number of the supports to add in the local specification.
- iProducts
- The product instances which contains the supports.
- iSupports
- CATILinkableObject interface of the geometric supports.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The support has been successfully created.
- E_FAIL
- The support is not allowed for this local specification.
o GetAttribute
| public virtual GetAttribute( | const | iName, |
| | oValue) |
-
Retreives the integer value of a local specification.
- Parameters:
-
- iName
- Name of the local specification.
- oValue
- Integer value.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The attribute has been successfully set.
- E_FAIL
- The attribute does not exist for this specification.
o GetAttribute
| public virtual GetAttribute( | const | iName, |
| | oValue) |
-
Retreives the real double value of a local specification.
- Parameters:
-
- iName
- Name of the local specification.
- iValue
- Real double value.
( In case of Length, oValue is evaluated in millimeters ).
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The attribute has been successfully set.
- E_FAIL
- The attribute does not exist for this specification.
o GetAttribute
| public virtual GetAttribute( | const | iName, |
| | oValue) |
-
Retreives the Character Value of a local specification.
- Parameters:
-
- iName
- Name of the local specification.
- oValue
- Character value.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The attribute has been successfully set.
- E_FAIL
- The attribute does not exist for this specification.
o GetSupports
| public virtual GetSupports( | const | iName, |
| | oNbSupports, |
| | oProducts, |
| | oSupports) |
-
Retreives all supports.
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:
-
- oNbSupports
- The product instances which contains the supports.
CATILinkableObject interfaces of the geometric support.
o SetAttribute
| public virtual SetAttribute( | const | iName, |
| | iValue) |
-
Valuates a local specification attribute to a real double value.
- Parameters:
-
- iName
- Name of the local specification.
- iValue
- Real double value to be used for the attribute.
( In case of Length, oValue is evaluated in millimeters ).
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The attribute has been successfully set.
- E_FAIL
- The attribute does not exist for this specification.
o SetAttribute
| public virtual SetAttribute( | const | iName, |
| const | iValue) |
-
Valuates a local specification attribute to a Character value.
- Parameters:
-
- iName
- Name of the local specification.
- iValue
- Character value to be used for the attribute.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The attribute has been successfully set.
- E_FAIL
- The attribute does not exist for this specification.
o SetAttribute
| public virtual SetAttribute( | const | iName, |
| | iValue) |
-
Valuates a local specification attribute to an integer value.
- Parameters:
-
- iName
- Name of the local specification.
- iValue
- Integer value to be used for the attribute.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The attribute has been successfully set.
- E_FAIL
- The attribute does not exist for this specification.
This object is included in the file: CATIMSHLocalSpecification.h
If needed, your Imakefile.mk should include the module: CATAmtModel