CATPLMFastenerUseItf CATAFmaAlias
Usage: you can derive this class.
public class CATAFmaAlias
Adapter for the interface
.
Role: This adapter facilitates the implementation of the interface
.
The user who implement the interface
must derive the implementation from this adapter class
Constructor and Destructor Index
- o
CATAFmaAlias()
-
- o
~CATAFmaAlias()
-
Method Index
- o
GetFastenedPartAlias(CATUnicodeString&,CATOmbObjectInContext*)
- Retrieve the user-defined alias of an occurrence of fastened part.
- o
GetFastenerAlias(CATUnicodeString&,CATOmbObjectInContext*)
- Retrieve the user-defined alias of an occurrence of fastener.
- o
GetFastenerAnnotationAlias(CATUnicodeString&,CATBaseUnknown*)
- Retrieve the user-defined alias of fastener annotation.
- o
GetFastenerConnectionAlias(CATUnicodeString&,CATBaseUnknown*,CATFmaConnectionContext)
- Retrieve the user-defined alias of a fastener connection.
Constructor and Destructor
o CATAFmaAlias
-
o ~CATAFmaAlias
| public virtual ~CATAFmaAlias( | ) |
-
Methods
o GetFastenedPartAlias
| public virtual GetFastenedPartAlias( | | ostrAlias, |
| const | ipPart) |
-
Retrieve the user-defined alias of an occurrence of fastened part.
Role: This method aims to allow to customize the "alias" of
a given occurrence of fastened part in the downstream functions that
handle them like the Fastener Report for example. For more information
on the list of the functions that support this protocol of openness
please refer to CATIA documentation.
- Parameters:
-
- ipPart
- [in] The part occurrence.
- ostrAlias
- [out] The alias corresponding to the part occurrence.
- Returns:
-
Legal values:
- S_OK
- if the alias was successfully retrieved.
- E_FAIL
- a failure has been encountered while retrieving the alias.
o GetFastenerAlias
| public virtual GetFastenerAlias( | | ostrAlias, |
| const | ipFastener) |
-
Retrieve the user-defined alias of an occurrence of fastener.
Role: This method aims to allow to customize the "alias" of
a given occurrence of fastener in the downstream functions that handle
them like the Fastener Report for example. For more information on the
list of the functions that support this protocol of openness please
refer to CATIA documentation.
- Parameters:
-
- ipFastener
- [in] The fastener occurrence.
- ostrAlias
- [out] The alias corresponding to the fastener occurrence.
- Returns:
-
Legal values:
- S_OK
- if the alias was successfully retrieved.
- E_FAIL
- a failure has been encountered while retrieving the alias.
o GetFastenerAnnotationAlias
| public virtual GetFastenerAnnotationAlias( | | ostrFTAAlias, |
| const | iFastenerMCX) |
-
Retrieve the user-defined alias of fastener annotation.
Role: This method aims to allow to customize the "alias" of
fastener annotation of a given fastener PLO.
For more information on the list of the functions that support this
protocol of openness please refer to CATIA documentation.
- Parameters:
-
- ipFastener
- [in] The fastener PLO.
- ostrFTAAlias
- [out] The alias corresponding to the fastener annotation.
- Returns:
-
Legal values:
- S_OK
- if the alias was successfully retrieved.
- E_FAIL
- a failure has been encountered while retrieving the alias.
o GetFastenerConnectionAlias
| public virtual GetFastenerConnectionAlias( | | oStrAlias, |
| const | iFastenerMCX, |
| const | iConnectionCtx) |
-
Retrieve the user-defined alias of a fastener connection.
Role: This method allows to customize the "alias" of
a given fastener connection in the downstream functions that handle
them for e.g. Fastener Report or FastenerUI. For more information on the
list of the functions that support this protocol of openness please
refer to CATIA documentation.
- Parameters:
-
- iFastenerMCX
- [in] The fastener connection.
- iConnectionCtx
- [in] The fastener connection context.
Legal values:
- CATFmaReport
- if the alias required in context of Report.
- CATFmaFastenerUI
- if the alias required in context of Fastener UI.
- Undef
- if No context defined.
- ostrAlias
- [out] The alias corresponding to the fastener connection.
- Returns:
-
Legal values:
- S_OK
- if the alias was successfully retrieved.
- E_FAIL
- a failure has been encountered while retrieving the alias.
This object is included in the file: CATAFmaAlias.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.