All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaCouplingBrowse

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

interface CATIFmaCouplingBrowse

Interface to get the information of the fastener joined parts.

Role: Components that implement CATIFmaCouplingBrowse are Fst_Coupling

Method Index

o GetFastenerRealization(CATOmbObjectInContext**): Gets the instance of fastener that realizes the fastener connection.
o GetZoneAccess(CATBaseUnknown**,int,IID&): Gets the joined zone from the input index.
o GetZoneAccessCount(int*): Gets the number of joined parts (PLM Fastener exposed attribute).

Methods

o GetFastenerRealization

public virtual GetFastenerRealization( opFstInstanceObjectInContext)

Gets the instance of fastener that realizes the fastener connection.

Parameters:

opFstInstanceObjectInContext: [out, CATOmbObjectInContext#Release] the fastener instance.

Returns:

S_OK: if the fastener instance has been successfully retrieved.
E_FAIL: otherwise (no realization of the connection).

o GetZoneAccess

public virtual GetZoneAccess(		`oZoneAccess`,
	const	`iIndex`,
	const	`iIID`	`= IID_CATIFmaJoinedZoneAccessBrowse`)

Gets the joined zone from the input index.

Parameters:

iIndex: the index.
iIID: the required interface on the returned joined zone .
oZoneAccess: [out, CATBaseUnknown#Release] the indexed fastener zone.

Returns:

S_OK: if the fastener joined zone was found.
E_INVALIDARG: if the index is negative or greatest than the number of joined zones.
E_FAIL: otherwise.

o GetZoneAccessCount

public virtual GetZoneAccessCount( oNb)

Gets the number of joined parts (PLM Fastener exposed attribute).

Parameters:

oNb: the number of joined parts.

Returns:

S_OK: if the fastener connects at least one joined part.
E_FAIL: otherwise.

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