All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATEngConnectionUseItf Interface CATIEngConnectionManager

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

interface CATIEngConnectionManager

Interface dedicated to manage the lifecycle of an Engineering Connection object.
Role: This interface allows to create, retrieve or delete Engineering Connections. This interface is implemented by the product.

Method Index

o CreateEngConnection(CATIEngConnection::Type,CATListValCATBaseUnknown_var*,CATIEngConnection*&,CATOmbObjectInContext*): Creates an Engineering Connection.
o ListEngConnection(CATListValCATBaseUnknown_var&): Retrieves all Engineering connections from a product.
o RemoveEngConnection(CATIEngConnection*): Removes an Engineering Connection from a product.

Methods

o CreateEngConnection

public virtual CreateEngConnection(		`iEngCntType`,
	const	`iListOfImpacted`,
		`oEngCnt`,
	const	`iContext`	`=NULL`)

Creates an Engineering Connection.
Role: The Engineering Connection may aggregate Assembly Constraints.

Parameters:

iEngCntType: [in] The Engineering Connection type.
iListOfImpacted: [in] List of Impacted. An Engineering Connection references - One Impacted (For example: Fix Constraint case). - Two Impacteds (For example: Coincidence Constraint case) - three Impacteds (For example: Hinge Constraint case)
If iContext is not NULL, the MCX is called contextual and one and only one impacted must be contextual.
A contextual impacted is characterized by the fact that the impacted's Path of First Instances must end with an instance of the MCX's father.
A non contextual impacted is characterized by the fact that the impacted's Path of First Instances must start with a child instance of the MCX's father.
oEngCnt: [out] The created Engineering Connection.
iContext: [in] To Create contextual Engineering Connection.

Returns:

E_INVALIDARG: if the number of impacted is incorrect.
E_FAIL: if the operation is failed.
S_OK: if the operation is successful.

o ListEngConnection

public virtual ListEngConnection( oListEngConnection)

Retrieves all Engineering connections from a product.

Parameters:

oListEngConnection: [out] The list of Engineering Connections. The returned items contained in the list adhere to CATIEngConnection.

Returns:

S_OK: if the engineering connection exists
E_FAIL: elsewhere

o RemoveEngConnection

public virtual RemoveEngConnection( const iEngCnt)

Removes an Engineering Connection from a product.

Parameters:

iEngCnt: [in] the Engineering Connection to remove.

Returns:

E_INVALIDARG: The input Engineering Connection is not an applicative Engineering Connection contained by the product.
S_OK: if the engineering connection is correctly removed.
E_FAIL: if the operation is failed.

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