CATAssemblyConstraintUseItf Interface CATIAssemblyConstraint

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

interface CATIAssemblyConstraint

This interface is implemented by the Assembly Constraint.

Role: Contains API to manage the Assembly Constraint.

Method Index


o GetActivity(CATBoolean&)
Gets the activity of the Constraint.
o GetGeometry(int,CATOmbObjectInContext*&)
Gets the geometry pointed by the constraint.
o GetMaxValue(int,double&)
Gets the maximal value of the constraint.
o GetMinValue(int,double&)
Gets the minimal value of the constraint.
o GetMode(CATIAssemblyConstraint::Mode&)
Gets the mode of the constraint.
o GetNbGeometries(int&)
Gets number of elements pointed by the constraint.
o GetNbOptions(int&)
Gets the options number of the constraint.
o GetNbValues(int&)
Gets the values number of the constraint.
o GetOption(int,CATIAssemblyConstraint::Option&)
Gets the options number of the constraint.
o GetType(CATIAssemblyConstraint::Type&)
o GetValue(int,double&)
Gets the value of the constraint.
o SetActivity(CATBoolean)
Sets the activity of the Constraint.
o SetMaxValue(int,double)
Sets the maximal value of the constraint.
o SetMinValue(int,double)
Sets the minimal value of the constraint.
o SetMode(CATIAssemblyConstraint::Mode)
Sets the mode of the constraint.
o SetOption(int,CATIAssemblyConstraint::Option)
Sets the options number of the constraint.
o SetValue(int,double)
Sets the value of the constraint.

Enumerated Type Index


o Mode
Assembly Constraint mode.
o Option
This Enum defines the constraint geometry option.
o Type
Assembly Constraint type.

Methods


o GetActivity
public virtual HRESULT GetActivity(CATBoolean& oActive) = 0
Gets the activity of the Constraint.
Parameters:
oActive
[out] The activity.
Returns:
S_OK
If the operation is successful.
E_FAIL
If the operation is failed.
o GetGeometry
public virtual HRESULT GetGeometry(int inbe,
CATOmbObjectInContext*& oGeometry) = 0
Gets the geometry pointed by the constraint.
Parameters:
inbe
[in] The indice of impacted .
oGeometry
[out] The geometry.
Returns:
S_OK
If the operation is successful.
E_FAIL
If the operation is failed.
o GetMaxValue
public virtual HRESULT GetMaxValue(int inbv,
double& oval) = 0
Gets the maximal value of the constraint.
Parameters:
inumvalue
[in] The value identifier.
oval
[out] The minimun value.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o GetMinValue
public virtual HRESULT GetMinValue(int inbv,
double& oval) = 0
Gets the minimal value of the constraint.
Parameters:
inumvalue
[in] The value identifier.
oval
[out] The minimun value.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o GetMode
public virtual HRESULT GetMode(CATIAssemblyConstraint::Mode& oMode) = 0
Gets the mode of the constraint.
Parameters:
oMode
[out] The constraint mode.
Returns:
S_OK
If the operation is successful.
E_FAIL
If the operation is failed.
o GetNbGeometries
public virtual HRESULT GetNbGeometries(int& onbElem) = 0
Gets number of elements pointed by the constraint.
Parameters:
onbElem
[out] The number of elements.
Returns:
S_OK
If the operation is successful.
E_FAIL
If the operation is failed.
o GetNbOptions
public virtual HRESULT GetNbOptions(int& onboption) = 0
Gets the options number of the constraint.
Parameters:
onboption
[out] The number of the options.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o GetNbValues
public virtual HRESULT GetNbValues(int& onbvalues) = 0
Gets the values number of the constraint.
Parameters:
onbvalues
[out] The values number.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o GetOption
public virtual HRESULT GetOption(int inumOption,
CATIAssemblyConstraint::Option& option) = 0
Gets the options number of the constraint.
Parameters:
inumOption
[in] The value identifier.
oOption
[out] The option.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o GetType
public virtual HRESULT GetType(CATIAssemblyConstraint::Type& oType) = 0
o GetValue
public virtual HRESULT GetValue(int inbv,
double& oval) = 0
Gets the value of the constraint.
Parameters:
inumvalue
[in] The value identifier.
oval
[out] The value.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o SetActivity
public virtual HRESULT SetActivity(CATBoolean iActive) = 0
Sets the activity of the Constraint.
Parameters:
iActive
[in] The activity.
Returns:
S_OK
If the operation is successful.
E_FAIL
If the operation is failed.
o SetMaxValue
public virtual HRESULT SetMaxValue(int inbv,
double ival) = 0
Sets the maximal value of the constraint.
Parameters:
inumvalue
[in] The value identifier.
ival
[in] The minimun value.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o SetMinValue
public virtual HRESULT SetMinValue(int inbv,
double ival) = 0
Sets the minimal value of the constraint.
Parameters:
inumvalue
[in] The value identifier.
ival
[in] The minimun value.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o SetMode
public virtual HRESULT SetMode(CATIAssemblyConstraint::Mode iMode) = 0
Sets the mode of the constraint.
Parameters:
iMode
[in] The constraint mode.
Returns:
S_OK
If the operation is successful.
E_FAIL
If the operation is failed.
E_INVALIDARG
The input value is not compatible with the type of the constraint.
o SetOption
public virtual HRESULT SetOption(int inumOption,
CATIAssemblyConstraint::Option ioption) = 0
Sets the options number of the constraint.
Parameters:
inumOption
[in] The value identifier.
iOption
[in] The option.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.
o SetValue
public virtual HRESULT SetValue(int inbv,
double ival) = 0
Sets the value of the constraint.
Parameters:
inumvalue
[in] The value identifier.
ival
[in] The value.
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation is failed.

Enumerated Types


o Mode 
enum Mode {
  Mode_Error,
  Mode_DrivingMode,
  Mode_MeasuredMode,
  Mode_ControlledMode
}
Assembly Constraint mode.
Parameters:
Mode_Error,
Not used. May be return in case of error.
Mode_DrivingMode,
The constraint definition is applied during the PLM update.
Mode_MeasuredMode,
The constraint value is deducted, from its definition and other constraints of the engineering connection, during the PLM update.
Mode_ControlledMode,
Defines the constraint controlled by the user, in the kinematics relation. The constraint value is defined between bounds.
o Option 
enum Option {
  Option_Error,
  Option_UndefinedOrientation,
  Option_PlaneSameOrientation,
  Option_PlaneOppositeOrientation,
  Option_LineParallelism,
  Option_LineSameOrientation,
  Option_LineOppositeOrientation,
  Option_HingeDirectAngle,
  Option_HingeAnglePlus180,
  Option_HingeSupplementaryAngle,
  Option_HingeComplementaryTO360,
  Option_AxisSystemX,
  Option_AxisSystemY,
  Option_AxisSystemZ
}
This Enum defines the constraint geometry option. The option depends of the Assembly Constraint type.
Parameters:
Option_Error
Not used. May be return in case of error.
Option_Undefined
The plane orientations are undefined and can be modified during the PLM update.
Option_PlaneSameOrientation
The plane orientations are the same.
Option_PlaneOppositeOrientation
The plane orientations are opposite.
Option_PlaneOppositeOrientation
The plane orientations are opposite.
Option_LineParallelism
The lines are parallel but not oriented.
Option_LineSameOrientation
The lines orientations are the same.
Option_LineOppositeOrientation
The lines orientations are opposite.
Option_HingeDirectAngle
The angle is the direct angle.
Option_HingeDirectAnglePlus180
The angle is equal to direct angle + 180deg.
Option_HingeSupplementaryAngle
The angle is the supplementary of the direct angle.
Option_HingeComplementaryTO360
The angle is the complementary angle to 360deg.
Option_AxisSystemX
.
Option_AxisSystemY
.
Option_AxisSystemZ
.
o Type 
enum Type {
  Type_Error,
  Type_FixInstance,
  Type_FixAxisSystem,
  Type_FixInstanceInstance,
  Type_FixInstanceAxisSystem,
  Type_FixAxisSystemAxisSystem,
  Type_FixTransfoInstance,
  Type_FixTransfoAxisSystem,
  Type_FixTransfoInstanceInstance,
  Type_FixTransfoInstanceAxisSystem,
  Type_FixTransfoAxisSystemAxisSystem,
  Type_CoincidencePointPoint,
  Type_CoincidencePointLine,
  Type_CoincidencePointCurve,
  Type_CoincidencePointPlane,
  Type_CoincidencePointSurface,
  Type_CoincidenceLineLine,
  Type_CoincidenceLinePlane,
  Type_CoincidencePlanePlane,
  Type_CoincidenceAxisSystemAxisSystem,
  Type_ContactCircleSphere,
  Type_ContactCircleCone,
  Type_ContactPlanePlane,
  Type_ContactPlaneCylinder,
  Type_ContactPlaneSphere,
  Type_ContactCylinderCylinder,
  Type_ContactSphereSphere,
  Type_ContactSphereCone,
  Type_ContactConeCone,
  Type_DistancePointPoint,
  Type_DistancePointLine,
  Type_DistancePointPlane,
  Type_DistanceLineLine,
  Type_DistanceLinePlane,
  Type_DistancePlanePlane,
  Type_AngleLineLine,
  Type_AngleLinePlane,
  Type_AnglePlanePlane,
  Type_AnglePlanePlaneLine,
  Type_SymmetryPointPointPlane,
  Type_SymmetryLineLinePlane,
  Type_SymmetryPlanePlanePlane,
  Type_SymmetryAxisSystemAxisSystemPlane,
  Type_SymmetryInstanceInstancePlane,
  Type_CouplingLengthLength,
  Type_CouplingAngleAngle,
  Type_CouplingLengthAngle,
  Type_CouplingAngleLength,
  Type_LengthPointCurve,
  Type_ParallelismLineLine,
  Type_ParallelismLinePlane,
  Type_ParallelismPlanePlane,
  Type_PerpendicularityLineLine,
  Type_PerpendicularityLinePlane,
  Type_PerpendicularityPlanePlane,
  Type_RollCurveCurve,
  Type_SlideCurveCurve,
  Type_FixSymmetricallyNewRef,
  Type_FixSymmetricallySameExistingRef
}
Assembly Constraint type.
Parameters:
Type_Error
Not used. May be return in case of error.
Type_FixInstance
FixInstance.
Type_FixAxisSystem
FixAxisSystem.
Type_FixInstanceInstance
FixInstanceInstance.
Type_FixInstanceAxisSystem
FixInstanceAxisSystem.
Type_FixAxisSystemAxisSystem
FixAxisSystemAxisSystem.
Type_FixTransfoInstance
FixTransfoInstance.
Type_FixTransfoAxisSystem
FixTransfoAxisSystem.
Type_FixTransfoInstanceInstance
FixTransfoInstanceInstance.
Type_FixTransfoInstanceAxisSystem
FixTransfoInstanceAxisSystem.
Type_FixTransfoAxisSystemAxisSystem
FixTransfoAxisSystemAxisSystem.
Type_CoincidencePointPoint
CoincidencePointPoint.
Type_CoincidencePointLine
CoincidencePointLine.
Type_CoincidencePointCurve
CoincidencePointCurve.
Type_CoincidencePointPlane
CoincidencePointPlane.
Type_CoincidencePointSurface
CoincidencePointSurface.
Type_CoincidenceLineLine
CoincidenceLineLine.
Type_CoincidenceLinePlane
CoincidenceLinePlane.
Type_CoincidencePlanePlane
CoincidencePlanePlane.
Type_CoincidenceAxisSystemAxisSystem
CoincidenceAxisSystemAxisSystem.
Type_ContactCircleSphere
ContactCircleSphere.
Type_ContactCircleCone
ContactCircleCone.
Type_ContactPlanePlane
ContactPlanePlane.
Type_ContactPlaneCylinder
ContactPlaneCylinder.
Type_ContactPlaneSphere
ContactPlaneSphere.
Type_ContactCylinderCylinder
ContactCylinderCylinder.
Type_ContactSphereSphere
ContactSphereSphere.
Type_ContactSphereCone
ContactSphereCone.
Type_ContactConeCone
ContactConeCone.
Type_DistancePointPoint
DistancePointPoint.
Type_DistancePointLine
DistancePointLine.
Type_DistancePointPlane
DistancePointPlane.
Type_DistanceLineLine
DistanceLineLine.
Type_DistanceLinePlane
DistanceLinePlane.
Type_DistancePlanePlane
DistancePlanePlane.
Type_AngleLineLine
AngleLineLine.
Type_AngleLinePlane
AngleLinePlane.
Type_AnglePlanePlane
AnglePlanePlane.
Type_AnglePlanePlaneLine
AnglePlanePlaneLine.
Type_SymmetryPointPointPlane
SymmetryPointPointPlane.
Type_SymmetryLineLinePlane
SymmetryLineLinePlane.
Type_SymmetryPlanePlanePlane
SymmetryPlanePlanePlane.
Type_SymmetryAxisSystemAxisSystemPlane
SymmetryAxisSystemAxisSystemPlane.
Type_SymmetryInstanceInstancePlane
SymmetryInstanceInstancePlane.
Type_CouplingLengthLength
AssCouplingLengthLength.
Type_CouplingAngleAngle
CouplingAngleAngle.
Type_CouplingLengthAngle
CouplingLengthAngle.
This object is included in the file: CATIAssemblyConstraint.h
If needed, your Imakefile.mk should include the module: CATAssemblyConstraintUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.