All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaAlias

Usage: you can reimplement this interface by deriving the supplied CATAFmaAlias adapter class.

interface CATIFmaAlias

Interface to fill the fastener report with Customer-defined attributes.

Role: User has to implement the interface on the component CAAFmaAliasImplementation.

Default implementation for both the methods is provided by adapter.

The customer has the choice to implement. Example: In case of Fastener Report,

if the interface is not implemented, report won't be customized.
if is implemented, report will be customized to mention the alias of the fastened parts.
if is implemented, report will be customized to mention the alias of the Fastener.

BOA information: this interface CAN NOT be implemented using the BOA (Basic Object Adapter).

Method Index

o GetFastenedPartAlias(CATUnicodeString&,CATOmbObjectInContext*): Retrieves the user-defined alias of an occurrence of fastened part.
o GetFastenerAlias(CATUnicodeString&,CATOmbObjectInContext*): Retrieves the user-defined alias of an occurrence of fastener.

Methods

o GetFastenedPartAlias

public virtual GetFastenedPartAlias(		`ostrAlias`,
	const	`ipPart`)

Retrieves 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`)

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

This object is included in the file: CATIFmaAlias.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces