All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaPLMNavigationServices

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

interface CATIFmaPLMNavigationServices

This interface gives access to methods allowing navigating between all the elements that contribute to the fastener structure: the fastener instances, the fastener connections and the fasten instances of parts.

Method Index

o GetComponentsFromFastenerInstance(CATLISTP(CATBaseUnknown)**,CATBaseUnknown*): Gets the list of components of a given fastener instance.
o GetFastenConnectionsFromFastenerInstance(CATLISTP(CATBaseUnknown)**,CATBaseUnknown*): Gets all the fastener connections linked to a given instance of fastener.
o GetFastenConnectionsFromPart(CATLISTP(CATBaseUnknown)**,CATBaseUnknown*): Gets all the fastener connections linked to a given instance of part.
o GetFastenerFromFastenConnection(CATBaseUnknown**,CATBaseUnknown*): Gets the fastener instance that implements a given fastener connection.
o GetFastenersFromAttributes(CATLISTP(CATIAdpPLMIdentificator)&,CATString&,CATAdpAttributeSet&,CATLISTP(CATIAdpPLMIdentificator)&): Gets fasteners plm identificators according to given fastener plm attributes values.
o GetFirstCommonFatherProductReference(CATBaseUnknown**,CATLISTP(CATBaseUnknown)*): Gets first common father product reference for given list of products.
o GetPartsFromFastenConnection(CATLISTP(CATBaseUnknown)**,CATBaseUnknown*): Gets the set of part instances associated to a fastener connection.

Methods

o GetComponentsFromFastenerInstance

public virtual GetComponentsFromFastenerInstance(		`opListOfComponents`,
	const	`ipFstInstance`)

Gets the list of components of a given fastener instance.

Parameters:

ipFstInstance: the fastener instance.
opListOfComponents: the list of components parts of the fastener instance. After use, each element of the list must be released and the list must be deleted.

Returns:

S_OK: if the retrieving operation has been fully successful.
E_INVALIDARG: if ipFstInstance is NULL, or if the ipFstInstance pointer does not correspond to a fastener instance, or if opListOfComponents is not initially NULL.
E_FAIL: otherwise.

o GetFastenConnectionsFromFastenerInstance

public virtual GetFastenConnectionsFromFastenerInstance(		`opListOfConnections`,
	const	`ipFstInstance`)

Gets all the fastener connections linked to a given instance of fastener.

Parameters:

ipFstInstance

the instance the instance of fastener.

opListOfConnections

the list of fastener connections that are implemented by the given fastener instance. This list may:

be empty: then instance could be removed from the product structure depending on user’s need
contain more than one object: for example, when a given fastener instance is re-used through different configurations

After use, each element of the list must be released and the list must be deleted.

Returns:

S_OK: if the retrieving operation has been fully successful.
E_INVALIDARG: if ipFstInstance is NULL, or if the ipFstInstance pointer does not correspond to an instance of Fastener, or if opListOfConnections is not initially NULL.
E_FAIL: otherwise.

o GetFastenConnectionsFromPart

public virtual GetFastenConnectionsFromPart(		`opListOfConnections`,
	const	`ipPart`)

Gets all the fastener connections linked to a given instance of part.

Parameters:

ipPart: the instance of part
opListOfConnections: the list of fastener connections that defines the fasten link to the given instance of part. This list may be empty. After use, each element of the list must be released and the list must be deleted.

Returns:

S_OK: if the retrieving operation has been fully successful.
E_INVALIDARG: if ipPart is NULL, or if the ipPart pointer does not correspond to an instance of Part, or if opListOfConnections is not initially NULL.
E_FAIL: otherwise.

o GetFastenerFromFastenConnection

public virtual GetFastenerFromFastenConnection(		`opFstInstance`,
	const	`ipFstConnection`)

Gets the fastener instance that implements a given fastener connection.

Parameters:

ipFstConnection: the fastener connection
opFstInstance: [out, CATBaseUnknown#Release] the fastener instance that implements the fastener connection. After use, the pointer must be released.

Returns:

S_OK: if the retrieving operation has been fully successful.
E_INVALIDARG: if ipFstConnection is NULL, or if the ipFstConnection pointer does not correspond to a fastener connection, or if opFstInstance is not initially NULL.
E_FAIL: otherwise.

o GetFastenersFromAttributes

public virtual GetFastenersFromAttributes(		`iInputs`,
	const	`iFastenerType`,
	const	`iAttributeSet`,
		`oResults`)

Gets fasteners plm identificators according to given fastener plm attributes values.

Parameters:

iInputs

[in] The list of inputs to treat. (Can be empty) If the list is empty, the results are retrieved from database. If the list is not empty, the results are retrieved among elements of this list.

iFastenerType

[in] The type of fastener.
Legal Values:

"SpotFastener"
"SpotAssyFastener"
"SpotFastenerSet"
"BeadFastener"
"BeadFastenerInstance"
"BeadBundleFastener"

iAttributeSet

[in] The set of attributes and their values.

oResults

[out] The list of results. After use, all pointers of the list must be released.

Returns:

S_OK: If fasteners plm identificators have been successfully retrieved.
E_INVALIDARG: If iFastenerType is unknown.
E_FAIL: Otherwise.

o GetFirstCommonFatherProductReference

public virtual GetFirstCommonFatherProductReference(		`opFatherProd`,
		`ipListOfProductsToBeFastened`)

Gets first common father product reference for given list of products.

Parameters:

ipListOfProductsToBeFastened: the list of products to be fastened.
opFatherProd: first common father product reference. After use, the pointer must be released.

Returns:

S_OK: if common father product reference has been successfully retrieved.
E_INVALIDARG: if ipListOfProductsToBeFastened is NULL, or if the list ipListOfProductsToBeFastened is empty, or if opFatherProd is NULL, or *opFatherProd is not initially NULL.
E_FAIL: otherwise.

o GetPartsFromFastenConnection

public virtual GetPartsFromFastenConnection(		`opListOfParts`,
	const	`ipFstConnection`)

Gets the set of part instances associated to a fastener connection.

Parameters:

ipFstConnection: the fastener connection.
opListOfParts: the list of instances of parts. This list may be empty. After use, each element of the list must be released and the list must be deleted.

Returns:

S_OK: if the retrieving operation has been fully successful.
E_INVALIDARG: if ipFstConnection is NULL, or if the ipFstConnection pointer does not correspond to a fastener connection, or if opListOfParts is not initially NULL.
E_FAIL: otherwise.

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