All Frameworks  Class Hierarchy  This Framework  Indexes   

ConstraintModelerInterfaces Interface CATICst

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


interface CATICst

Interface to manage a constraint.
Role: This interface is used to manage a constraint. Each constraint is linked to a solving bloc.

See also:
CATIBloc, CATICstFactory, CATMfPossibleCst


Method Index


o ChangeSector(int)
Changes the angular sector.
o GetBloc1()
o GetBloc2()
o GetBloc(int&)
o GetBlocs(CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATBaseUnknown_var)&)
o GetCstAttrRealValue(CATCstAttrType&)
Returns the value of a specification as double.
o GetCstAttrValue(CATCstAttrType&)
Returns the value of a specification.
o GetCstAttr(CATCstAttrType&)
o GetCstMode()
Returns the mode.
o GetCstObjectType()
o GetCstType()
Returns the type as an enumeration.
o GetElement1()
o GetElement2()
o GetElement3()
o GetElement(int)
Returns an element.
o GetElements(CATBaseUnknown_var&,CATBaseUnknown_var&,CATBaseUnknown_var&)
o GetElements()
o GetRealValue()
o GetRealValue(int)
Returns the numerical value as double.
o GetRealValues()
o GetRootBloc()
o GetValue()
o GetValue(int)
o GetValues()
o ListCstAttr()
Returns the list of specifications.
o ReadAngle()
o ReadAngle(int)
o ReadDistance()
o ReadDistance(int)
o ReadSector()
Reads the angular sector.
o ReadStatus()
Reads the status.
o SetBloc1(CATIBloc_var)
o SetBloc2(CATIBloc_var)
o SetCstAttrRealValue(CATCstAttrType&,double,int)
Sets a real specification value.
o SetCstAttrValue(CATCstAttrType&,CATCstAttrVal&,int)
Sets a specification value.
o SetCstMode(CATCstMode)
Sets the mode.
o SetElement(int,CATBaseUnknown_var&)
Sets an element.
o SetRealValue(double)
o SetRealValue(int,double)
Sets a numerical value as double.
o SetValue(CATICkeParm_var&)
o SetValue(int,CATICkeParm_var&)
o UnsetRootBloc()

Methods


o ChangeSector
public virtual ChangeSector( iSector)
Changes the angular sector.
Parameters:
iSector
The angular sector from 1 to 4.
o GetBloc1
public virtual GetBloc1()
Deprecated:
V5R15 do not use Returns first influence bloc.
o GetBloc2
public virtual GetBloc2()
Deprecated:
V5R15 do not use Returns second influence bloc.
o GetBloc
public virtual GetBloc( const inf)
Deprecated:
V5R15 do not use Returns second influence bloc.
o GetBlocs
public virtual GetBlocs( iInfl1,
iInfl2,
iInfl3)
Deprecated:
V5R15 do not use Retrieves influence blocs.
Parameters:
iInfl1
The first influence bloc.
iInfl2
The second influence bloc.
iInfl3
The third influence bloc.
o GetCstAttrRealValue
public virtual GetCstAttrRealValue( const iName)
Returns the value of a specification as double.
Parameters:
iName
The specification type.
Legal values: CATCstAttr_Crv1Param, CATCstAttr_Crv2Param, CATCstAttr_FsPercentage, CATCstAttr_FsGlobalTension, CATCstAttr_FsTension, CATCstAttr_FsCurvatureVariation.
o GetCstAttrValue
public virtual GetCstAttrValue( const iName)
Returns the value of a specification.
Parameters:
iName
The specification type.
Legal values:
Legal values for iName Returns one of the values
CATCstAttr_Reference CATCstVal_Reference_Absolute
CATCstVal_Reference_Relative
CATCstAttr_Side CATCstVal_Side_Positive
CATCstVal_Side_Negative
CATCstVal_Side_Undefined
CATCstVal_Side_Signed_FromValue
CATCstVal_Side_Signed_FromOppositeValue
CATCstAttr_Orient CATCstVal_Orient_Same
CATCstVal_Orient_Opposite
CATCstVal_Orient_Undefined
CATCstAttr_Parallelism CATCstVal_Parallelism_Same
CATCstVal_Parallelism_Opposite
CATCstVal_Parallelism_Parallel
CATCstVal_Parallelism_NoParallel
CATCstAttr_RefAxis CATCstVal_RefAxis_1
CATCstVal_RefAxis_2
CATCstVal_RefAxis_3
CATCstAttr_Dimension CATCstVal_Dimension_x1
CATCstVal_Dimension_x2
CATCstAttr_DimensionAxis CATCstVal_DimensionAxis_1
CATCstVal_DimensionAxis_2
CATCstAttr_Direction CATCstVal_DirectionNone
CATCstVal_Direction_1
CATCstVal_Direction_2
CATCstVal_Direction_3
CATCstAttr_AngSector CATCstVal_AngSector_1
CATCstVal_AngSector_2
CATCstVal_AngSector_3
CATCstVal_AngSector_4
CATCstAttr_FsContinuity CATCstVal_FsContinuity_1,
CATCstVal_FsContinuity_2,
CATCstAttr_FsType CATCstVal_FsType_1
CATCstVal_FsType_2
CATCstAttr_FsModifiedElement CATCstVal_FsModifiedElement_1
CATCstVal_FsModifiedElement_2
o GetCstAttr
public virtual GetCstAttr( const iName)
Deprecated:
V5R15 use GetCstAttrValue( iName ) or GetCstAttrRealValue( iName ) and SetCstAttrValue( iName ) or SetCstAttrRealValue( iName ) Returns a specification as a literal.
Parameters:
iName
The specification type.
o GetCstMode
public virtual GetCstMode()
Returns the mode.
o GetCstObjectType
public virtual GetCstObjectType()
Deprecated:
V5R15 do not use Returns the type as a CATICstData interface.
o GetCstType
public virtual GetCstType()
Returns the type as an enumeration.
o GetElement1
public virtual GetElement1()
Deprecated:
V5R15 use GetElement(1) Returns the first element.
o GetElement2
public virtual GetElement2()
Deprecated:
V5R15 use GetElement(2) Returns the second element, equal to NULL_var if not defined.
o GetElement3
public virtual GetElement3()
Deprecated:
V5R15 use GetElement(3) Returns the third element, equal to NULL_var if not defined.
o GetElement
public virtual GetElement( const iNum)
Returns an element.
Parameters:
iNum
The number of the element, from 1 to 3.
o GetElements
public virtual GetElements( oElem1,
oElem2,
oElem3)
Deprecated:
V5R15 use GetElement(1), GetElement(2), GetElement(3) Retrieves the elements.
Parameters:
oElem1
The first element.
oElem2
The second element.
oElem3
The third element.
o GetElements
public virtual GetElements()
Deprecated:
V5R15 use a loop for i=1 to 3 on GetElement(int i) Returns the list of elements.
o GetRealValue
public virtual GetRealValue()
Deprecated:
V5R15 use GetRealValue( 1 ) Returns the first numerical value as double.
o GetRealValue
public virtual GetRealValue( const num)
Returns the numerical value as double.
Parameters:
iNum
The number of the numerical value.
o GetRealValues
public virtual GetRealValues()
Deprecated:
V5R15 use a loop on GetRealValue( int num ) Returns the list of numerical values as double.
o GetRootBloc
public virtual GetRootBloc()
Deprecated:
V5R15 do not use Returns the solving bloc.
o GetValue
public virtual GetValue()
Deprecated:
V5R15 use GetRealValue( 1 ) Returns the first numerical value as literal.
o GetValue
public virtual GetValue( const num)
Deprecated:
V5R15 use GetRealValue( num ) Returns a numerical value as literal.
Parameters:
iNum
The number of the numerical value.
o GetValues
public virtual GetValues()
Deprecated:
V5R15 use a loop on GetRealValue( int num ) Returns the list of numerical values as literal.
o ListCstAttr
public virtual ListCstAttr()
Returns the list of specifications.
o ReadAngle
public virtual ReadAngle()
Deprecated:
V5R15 do not use Reads the first angle.
o ReadAngle
public virtual ReadAngle( const iNum)
Deprecated:
V5R15 do not use Reads an angle.
Parameters:
iNum
The number of the angle.
o ReadDistance
public virtual ReadDistance()
Deprecated:
V5R15 do not use Reads the first distance.
o ReadDistance
public virtual ReadDistance( const iNum)
Deprecated:
V5R15 do not use Reads a distance.
Parameters:
iNum
The number of the distance.
o ReadSector
public virtual ReadSector()
Reads the angular sector.
o ReadStatus
public virtual ReadStatus()
Reads the status.
o SetBloc1
public virtual SetBloc1( iInfl)
Deprecated:
V5R15 do not use Sets the first influence bloc.
Parameters:
iInfl
The bloc.
o SetBloc2
public virtual SetBloc2( iInfl)
Deprecated:
V5R15 do not use Sets the second influence bloc.
Parameters:
iInfl
The bloc.
o SetCstAttrRealValue
public virtual SetCstAttrRealValue( const iName,
const iValue,
const iDispatch= 1)
Sets a real specification value.
Parameters:
iName
The specification type.
Legal values: CATCstAttr_Crv1Param, CATCstAttr_Crv2Param, CATCstAttr_FsPercentage, CATCstAttr_FsGlobalTension, CATCstAttr_FsTension, CATCstAttr_FsCurvatureVariation.
iValue
The specification value.
iDispatch
Equals to 1, the method dispatchs an event, nothing otherwise.
o SetCstAttrValue
public virtual SetCstAttrValue( const iName,
const iValue,
const iDispatch= 1)
Sets a specification value.
Parameters:
iName
The specification type.
iValue
The specification value.
Legal values for iName Legal values for iValue
CATCstAttr_Reference CATCstVal_Reference_Absolute
CATCstVal_Reference_Relative
CATCstAttr_Side CATCstVal_Side_Positive
CATCstVal_Side_Negative
CATCstVal_Side_Undefined
CATCstVal_Side_Signed_FromValue
CATCstVal_Side_Signed_FromOppositeValue
CATCstAttr_Orient CATCstVal_Orient_Same
CATCstVal_Orient_Opposite
CATCstVal_Orient_Undefined
CATCstAttr_Parallelism CATCstVal_Parallelism_Same
CATCstVal_Parallelism_Opposite
CATCstVal_Parallelism_Parallel
CATCstVal_Parallelism_NoParallel
CATCstAttr_RefAxis CATCstVal_RefAxis_1
CATCstVal_RefAxis_2
CATCstVal_RefAxis_3
CATCstAttr_Dimension CATCstVal_Dimension_x1
CATCstVal_Dimension_x2
CATCstAttr_DimensionAxis CATCstVal_DimensionAxis_1
CATCstVal_DimensionAxis_2
CATCstAttr_Direction CATCstVal_DirectionNone
CATCstVal_Direction_1
CATCstVal_Direction_2
CATCstVal_Direction_3
CATCstAttr_AngSector CATCstVal_AngSector_1
CATCstVal_AngSector_2
CATCstVal_AngSector_3
CATCstVal_AngSector_4
CATCstAttr_FsContinuity CATCstVal_FsContinuity_1,
CATCstVal_FsContinuity_2,
CATCstAttr_FsType CATCstVal_FsType_1
CATCstVal_FsType_2
CATCstAttr_FsModifiedElement CATCstVal_FsModifiedElement_1
CATCstVal_FsModifiedElement_2
iDispatch
Equals to 1, the method dispatchs an event, nothing otherwise.
o SetCstMode
public virtual SetCstMode( const iMode)
Sets the mode.
Parameters:
iMode
The mode.
o SetElement
public virtual SetElement( const iNum,
const iElem)
Sets an element.
Parameters:
iNum
The number of the element, from 1 to 3.
iElem
The element.
Returns:
Error code of function.
o SetRealValue
public virtual SetRealValue( const iValue)
Deprecated:
V5R15 use SetRealValue( 1, value ) Sets the first numerical value as double.
Parameters:
iValue
The value.
o SetRealValue
public virtual SetRealValue( const iNum,
const iValue)
Sets a numerical value as double.
Parameters:
iNum
The number of the numerical value.
iValue
The value.
o SetValue
public virtual SetValue( const iValue)
Deprecated:
V5R15 use SetRealValue( 1, value ) Sets the first numerical value.
Parameters:
iValue
The value.
o SetValue
public virtual SetValue( const iNum,
const iValue)
Deprecated:
V5R15 use SetRealValue( iNum, value ) Sets a numerical value as literal.
Parameters:
iNum
The number of the numerical value.
iValue
The value.
o UnsetRootBloc
public virtual UnsetRootBloc()
Deprecated:
V5R15 do not use Unsets the solving bloc.

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

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