All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFmaModelerInterfaces Interface CATIFmaCoupling

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

interface CATIFmaCoupling

Interface to set the information of the fastener joined parts.
This information is ordered.
Role: Components that implement CATIFmaCoupling are Fst_Coupling

Method Index

o AddZoneAccess(int,CATIFmaJoinedZoneAccess**): Adds a joined zone from the input index.
o RemoveZoneAccess(int): Removes a joined zone from the input index.
o RemoveZoneAccess(CATIFmaJoinedZoneAccess*): Removes a zone from the list of the joined zones.
o SetFastenerRealization(CATOmbObjectInContext*): Defines the fastener instance that realizes the fastener connection.

Methods

o AddZoneAccess

public virtual AddZoneAccess(	const	`iIndex`,
		`oZoneAccess`)

Adds a joined zone from the input index.

Parameters:

iIndex: the index.
oZoneAccess: [out, CATIFmaJoinedZoneAccess#Release] the indexed fastener zone, the pointer must be released.

Returns:

S_OK: if the fastener joined zone has been successfully added.
E_FAIL: otherwise.

o RemoveZoneAccess

public virtual RemoveZoneAccess( const iIndex)

Removes a joined zone from the input index.

Parameters:

iIndex: the index.

Returns:

S_OK: if the fastener joined zone has been successfully removed.
E_INVALIDARG: if the index is negative or greatest than the number of joined zones.
E_FAIL: otherwise.

o RemoveZoneAccess

public virtual RemoveZoneAccess( iZoneAccess)

Removes a zone from the list of the joined zones.

Parameters:

iZoneAccess: the pointer on the zone to remove from the list.

Returns:

S_OK: if the fastener joined zone has been successfully removed.
E_INVALIDARG: if iZoneAccess is NULL or is not part of the list.
E_FAIL: otherwise.

o SetFastenerRealization

public virtual SetFastenerRealization( ipFstInstanceObjectInContext)

Defines the fastener instance that realizes the fastener connection.

Parameters:

ipFstInstanceObjectInContext: the fastener instance.

Returns:

S_OK: if the valuation is successful.
E_INVALIDARG: if ipFstInstanceObjectInContext is NULL or is not a path to a fastener instance.
E_FAIL: otherwise.

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