All Frameworks  Class Hierarchy  This Framework  Next  Indexes

ConstraintModeler Class CATConstraintServices

CATConstraintServices
 

Usage: you must use this class as is. You should never derive it.


public class CATConstraintServices

Class dedicated to Constraints services.


Method Index


o CreateConstraintIn(CATBaseUnknown_var&,CATCstType,CATLISTV(CATBaseUnknown_var)&,double,CATCstMode,CATICst_var&)
Creates a constraint.
o ListConstraints(CATBaseUnknown_var&,CATLISTV(CATICst_var)&)
Gets the list of constraints under a given Part or Sketch.
o RemoveConstraint(CATICst_var&)
Removes a constraint.

Methods


o CreateConstraintIn
public static HRESULT CreateConstraintIn( const CATBaseUnknown_var& iOwner,
const CATCstType iType,
const CATLISTV(CATBaseUnknown_var)& iElemList,
double iValue,
const CATCstMode iMode,
CATICst_var& oCreatedConstraint)
Creates a constraint.
Parameters:
iOwner
The owner of the created constraint, can be a Part or a Sketch.
iType
The constraint type as enumeration.
iElemList
The list of geometry involvded in the constraint, can contain from 1 to 3 elements.
iValue
The numerical value as double.
iMode
The creation mode.
oCreatedConstraint
The created constraint.
Returns:
S_OK
if the constraint is successfully created
E_INVALIDARG
if iElemList has more than 3 or less than 1 elements
E_FAIL
elsewhere.
o ListConstraints
public static HRESULT ListConstraints( const CATBaseUnknown_var& iOwner,
CATLISTV(CATICst_var)& oConstraintsList)
Gets the list of constraints under a given Part or Sketch.
Parameters:
iOwner
The Part or Sketch where the constraints are created.
oConstraintsList
The resulting constraints list
Returns:
S_OK
if at least one constraint is found
E_FAIL
elsewhere.
o RemoveConstraint
public static HRESULT RemoveConstraint( const CATICst_var& iCst)
Removes a constraint.
Parameters:
iCst
The constraint to remove. The constraint has to be defined in a Part or a Sketch.
Returns:
S_OK
if the constraint is removed
E_FAIL
elsewhere.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.