All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaAliasCtx

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

interface CATIFmaAliasCtx

Interface to provide the customized fastener connection name in given context.

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

Default implementation for the interface method is provided by adapter.

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

if the interface is not implemented, customized connection name won't be generated.
if is implemented, the alias of the fastener connection will be provided in the given context(FastenerUI, Report).

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

Method Index

o GetFastenerConnectionAlias(CATUnicodeString&,CATBaseUnknown*,CATFmaConnectionContext): Retrieves the user-defined alias of a fastener connection.

Methods

o GetFastenerConnectionAlias

public virtual GetFastenerConnectionAlias(		`oStrAlias`,
	const	`iFastenerMCX`,
	const	`iConnectionCtx`)

Retrieves the user-defined alias of a fastener connection.
Role: This method aims to allow to customize the "alias" of a given fastener connection in the downstream functions that handle them like the Fastener Report or FastenerUI for example. 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.
CATFmaUndef: if No context defined.

ostrAlias

[out] The alias corresponding to the fastener connection 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: CATIFmaAliasCtx.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces