CATGSMUseItf Interface CATIGSMUseIntegratedLaw
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseIntegratedLaw
Interface for GSD Law Management.
Role: Allows you to access data of the integrated law.
Adheres to CATICkeLaw Interface, corresponding CATCompositeLaw can be retrieved by querying CATICkeLaw interface.
- See also:
- ,
Method Index
- o
AppendNewPointAndParam(CATIMmiMechanicalFeature_var&,CATICkeParm_var&)
- Sets 'Point on spine' and associated parameter.
- o
GetAdvancedLaw(CATICkeLaw_var&)
- Gets the external law.
- o
GetEndParam(CATICkeParm_var&)
- Gets end parameter.
- o
GetImplicitLawInterpolationMode(enum CATGSMImplicitLawInterpolationMode&)
- Gets Interpolation mode for implicit law.
- o
GetInvertMappingLaw(CATBoolean&)
- Gets the mapping orientation of the law.
- o
GetListOfPointsAndParams(CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&)
- Gets the list points on spine and associated parameters.
- o
GetPitchLawType(enum CATGSMBasicLawType&)
- Gets pitch law type.
- o
GetSpine(CATIMmiMechanicalFeature_var&)
- Gets Spine for implicit law.
- o
GetStartParam(CATICkeParm_var&)
- Gets start parameter.
- o
RemoveAllPointsAndParams()
- Remove all the points and associated parameters.
- o
RemovePointAndParam(CATIMmiMechanicalFeature_var&)
- Remove a point and his parameter.
- o
SetAdvancedLaw(CATICkeLaw_var&)
- Sets the external law.
- o
SetEndParam(CATICkeParm_var&)
- Gets end parameter.
- o
SetImplicitLawInterpolationMode(enum CATGSMImplicitLawInterpolationMode&)
- Sets Interpolation mode for implicit law.
- o
SetInvertMappingLaw(CATBoolean)
- Sets the mapping orientation of the law.
- o
SetPitchLawType(enum CATGSMBasicLawType)
- Sets pitch law type.
- o
SetSpine(CATIMmiMechanicalFeature_var&)
- Gets Spine for implicit law.
- o
SetStartParam(CATICkeParm_var&)
- Sets start parameter.
Methods
o AppendNewPointAndParam
| public virtual AppendNewPointAndParam( | const | iSpecPoint, |
| const | iParam) |
-
Sets 'Point on spine' and associated parameter.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- iSpecPoint
- Point on spine
- iParam
- Corresponding parameter
- See also:
-
o GetAdvancedLaw
| public virtual GetAdvancedLaw( | | oLaw) |
-
Gets the external law.
Note: Used for law type= CATGSMBasicLawType_Advanced
- Parameters:
-
- oLaw
- GSD distance Law or Knowledge Law
- See also:
- , ,
o GetEndParam
| public virtual GetEndParam( | | oParam) |
-
Gets end parameter.
Note: Used for law type= CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- oParam
- Parameter unit depends on law unit
- See also:
-
o GetImplicitLawInterpolationMode
| public virtual GetImplicitLawInterpolationMode( | | oMode) |
-
Gets Interpolation mode for implicit law.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- oMode
- Implicit law interpolation mode
- See also:
- ,
o GetInvertMappingLaw
| public virtual GetInvertMappingLaw( | | oInvert) |
-
Gets the mapping orientation of the law.
- Parameters:
-
- oInvert
- False : Law is applied from the beginning to the end of the curve (mapping is not inverted).
True : Law is applied from the end to the beginning of the curve (mapping is inverted).
o GetListOfPointsAndParams
| public virtual GetListOfPointsAndParams( | | oSpecPoints, |
| | oSpecParams) |
-
Gets the list points on spine and associated parameters.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- oSpecPoints
- List of points on spine
- oSpecParams
- List of corresponding parameters
- See also:
-
o GetPitchLawType
| public virtual GetPitchLawType( | | oType) |
-
Gets pitch law type.
- Parameters:
-
- oType
- Type of law (from CATGSMBasicLawType enumeration).
- See also:
-
o GetSpine
| public virtual GetSpine( | | oSpine) |
-
Gets Spine for implicit law.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- oSpine
- Spine on which implicit law inputs points are defined
- See also:
-
o GetStartParam
| public virtual GetStartParam( | | oParam) |
-
Gets start parameter.
Note: Used for law type= CATGSMBasicLawType_Constant,
CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- oParam
- Parameter unit depends on law unit
- See also:
-
o RemoveAllPointsAndParams
| public virtual RemoveAllPointsAndParams( | ) |
-
Remove all the points and associated parameters.
Note: Used for law type= CATGSMBasicLawType_Implicit
- See also:
-
o RemovePointAndParam
| public virtual RemovePointAndParam( | const | iSpecPoint) |
-
Remove a point and his parameter.
for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- iSpecPoint
- Point to remove
- See also:
-
o SetAdvancedLaw
| public virtual SetAdvancedLaw( | const | iLaw) |
-
Sets the external law.
Note: Used for law type= CATGSMBasicLawType_Advanced
- Parameters:
-
- iLaw
- GSD distance Law or Knowledge Law
- See also:
- , ,
o SetEndParam
| public virtual SetEndParam( | const | iParam) |
-
Gets end parameter.
Note: Used for law type= CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- oParam
- Parameter unit depends on law unit
- See also:
-
o SetImplicitLawInterpolationMode
| public virtual SetImplicitLawInterpolationMode( | const | iMode) |
-
Sets Interpolation mode for implicit law.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- oMode
- Implicit law interpolation mode
- See also:
- ,
o SetInvertMappingLaw
| public virtual SetInvertMappingLaw( | | iInvert) |
-
Sets the mapping orientation of the law.
- Parameters:
-
- iInvert
- False : Law is applied from the beginning to the end of the curve (mapping is not inverted).
True : Law is applied from the end to the beginning of the curve (mapping is inverted).
o SetPitchLawType
| public virtual SetPitchLawType( | const | iType) |
-
Sets pitch law type.
- Parameters:
-
- iType
- Type of law (from CATGSMBasicLawType enumeration).
- See also:
-
o SetSpine
| public virtual SetSpine( | const | iSpine) |
-
Gets Spine for implicit law.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- iSpine
- Spine on which implicit law inputs points are defined
- See also:
-
o SetStartParam
| public virtual SetStartParam( | const | iParam) |
-
Sets start parameter.
Note: Used for law type= CATGSMBasicLawType_Constant,
CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- iParam
- Parameter unit depends on law unit
- See also:
-
This object is included in the file: CATIGSMUseIntegratedLaw.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.