All Frameworks Class Hierarchy This Framework Next Indexes
CATAssemblyInterfaces Class CATAsmConstraintServices
CATAsmConstraintServices
Usage: you must use this class as is. You should never derive it.
public class CATAsmConstraintServices
Class dedicated to Assembly Constraints services.
Method Index
- o
ListConstraints(CATIProduct*,CATLISTV(CATICst_var)&)
- Gets the list of constraints under a given reference product.
- o
RefreshConstraint(CATICst*)
- Refreshes a constraint's status.
- o
RefreshConstraintsInProduct(CATIProduct*)
- Refreshes the status of every constraint in a given product.
- o
RemoveConstraint(CATICst*)
- Removes a constraint.
Methods
o ListConstraints
-
Gets the list of constraints under a given reference product.
- Parameters:
-
- iProduct
- The product identifies the document where the constraint were created.
You can only get the constraints of a reference product.
- oConstraintsList
- The resulting constraints list
- Returns:
-
- S_OK
- if the product contains at least one constraint
- E_POINTER
- if iProduct is NULL
- E_INVALIDARG
- if iProduct is not a reference product
- E_FAIL
- elsewhere.
o RefreshConstraint
-
Refreshes a constraint's status.
This method only works with the PX1 product licence.
- Parameters:
-
- iConstraint
- The constraint to refresh
- Returns:
-
- S_OK
- if the constraint is refreshed
- E_POINTER
- if iConstraint is NULL
- E_NOTIMPL
- if the PX1 licence si not available
- E_FAIL
- elsewhere.
o RefreshConstraintsInProduct
-
Refreshes the status of every constraint in a given product.
This method is not recursive: the constraints of the sub assemblies won't be refreshed.
This method only works with the PX1 product licence.
- Parameters:
-
- iProduct
- The product which constraints must be refreshed
- Returns:
-
- S_OK
- if at least one constraint is refreshed
- E_POINTER
- if iProduct is NULL
- E_NOTIMPL
- if the PX1 licence si not available
- E_FAIL
- elsewhere.
o RemoveConstraint
-
Removes a constraint.
- Parameters:
-
- iCst
- The constraint to remove.
You can only remove a reference constraint i.e. under a reference product.
- Returns:
-
- S_OK
- if the constraint is removed
- E_POINTER
- if iCst is NULL
- E_INVALIDARG
- if iCst is not a reference constraint
- E_FAIL
- elsewhere.
This object is included in the file: CATAsmConstraintServices.h
If needed, your Imakefile.mk should include the module: CATAssemblyInterfaces