All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMIntegratedLaw
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMIntegratedLaw
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMIntegratedLaw
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:
- CATICkeLaw.ComputeCompositeLaw, CATIGSMFactoryInternal.CreateIntegratedLaw
Method Index
- o
AppendNewPointAndParam(CATISpecObject_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(CATISpecObject_var)&,CATLISTV(CATISpecObject_var)&)
- Gets the list points on spine and associated parameters.
- o
GetPitchLawType(enum CATGSMBasicLawType&)
- Gets pitch law type.
- o
GetSpine(CATISpecObject_var&)
- Gets Spine for implicit law.
- o
GetStartParam(CATICkeParm_var&)
- Gets start parameter.
- o
RemoveAllPointsAndParams()
- Remove all the points and associated parameters.
- o
RemovePointAndParam(CATISpecObject_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(CATISpecObject_var&)
- Gets Spine for implicit law.
- o
SetStartParam(CATICkeParm_var&)
- Sets start parameter.
Methods
o AppendNewPointAndParam
public virtual HRESULT AppendNewPointAndParam( | const CATISpecObject_var& | iSpecPoint, |
| const CATICkeParm_var& | iParam) = 0 |
-
Sets 'Point on spine' and associated parameter.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- iSpecPoint
- Point on spine
- iParam
- Corresponding parameter
- See also:
- CATGSMBasicLawType
o GetAdvancedLaw
public virtual HRESULT GetAdvancedLaw( | CATICkeLaw_var& | oLaw) = 0 |
-
Gets the external law.
Note: Used for law type= CATGSMBasicLawType_Advanced
- Parameters:
-
- oLaw
- GSD distance Law or Knowledge Law
- See also:
- CATICkeParmFactory.CreateLaw, CATGSMBasicLawType, CATIGSMLawDistProj
o GetEndParam
public virtual HRESULT GetEndParam( | CATICkeParm_var& | oParam) = 0 |
-
Gets end parameter.
Note: Used for law type= CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- oParam
- Parameter unit depends on law unit
- See also:
- CATGSMBasicLawType
o GetImplicitLawInterpolationMode
public virtual HRESULT GetImplicitLawInterpolationMode( | enum CATGSMImplicitLawInterpolationMode& | oMode) = 0 |
-
Gets Interpolation mode for implicit law.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- oMode
- Implicit law interpolation mode
- See also:
- CATGSMImplicitLawInterpolationMode, CATGSMBasicLawType
o GetInvertMappingLaw
-
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
-
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:
- CATGSMBasicLawType
o GetPitchLawType
public virtual HRESULT GetPitchLawType( | enum CATGSMBasicLawType& | oType) = 0 |
-
Gets pitch law type.
- Parameters:
-
- oType
- Type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATGSMBasicLawType
o GetSpine
public virtual HRESULT GetSpine( | CATISpecObject_var& | oSpine) = 0 |
-
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:
- CATGSMBasicLawType
o GetStartParam
public virtual HRESULT GetStartParam( | CATICkeParm_var& | oParam) = 0 |
-
Gets start parameter.
Note: Used for law type= CATGSMBasicLawType_Constant,
CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- oParam
- Parameter unit depends on law unit
- See also:
- CATGSMBasicLawType
o RemoveAllPointsAndParams
public virtual HRESULT RemoveAllPointsAndParams( | )= 0 |
-
Remove all the points and associated parameters.
Note: Used for law type= CATGSMBasicLawType_Implicit
- See also:
- CATGSMBasicLawType
o RemovePointAndParam
public virtual HRESULT RemovePointAndParam( | const CATISpecObject_var& | iSpecPoint) = 0 |
-
Remove a point and his parameter.
for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- iSpecPoint
- Point to remove
- See also:
- CATGSMBasicLawType
o SetAdvancedLaw
public virtual HRESULT SetAdvancedLaw( | const CATICkeLaw_var& | iLaw) = 0 |
-
Sets the external law.
Note: Used for law type= CATGSMBasicLawType_Advanced
- Parameters:
-
- iLaw
- GSD distance Law or Knowledge Law
- See also:
- CATICkeParmFactory.CreateLaw, CATGSMBasicLawType, CATIGSMLawDistProj
o SetEndParam
public virtual HRESULT SetEndParam( | const CATICkeParm_var& | iParam) = 0 |
-
Gets end parameter.
Note: Used for law type= CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- oParam
- Parameter unit depends on law unit
- See also:
- CATGSMBasicLawType
o SetImplicitLawInterpolationMode
public virtual HRESULT SetImplicitLawInterpolationMode( | const enum CATGSMImplicitLawInterpolationMode& | iMode) = 0 |
-
Sets Interpolation mode for implicit law.
Note: Used for law type= CATGSMBasicLawType_Implicit
- Parameters:
-
- oMode
- Implicit law interpolation mode
- See also:
- CATGSMImplicitLawInterpolationMode, CATGSMBasicLawType
o SetInvertMappingLaw
-
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 HRESULT SetPitchLawType( | const enum CATGSMBasicLawType | iType) = 0 |
-
Sets pitch law type.
- Parameters:
-
- iType
- Type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATGSMBasicLawType
o SetSpine
public virtual HRESULT SetSpine( | const CATISpecObject_var& | iSpine) = 0 |
-
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:
- CATGSMBasicLawType
o SetStartParam
public virtual HRESULT SetStartParam( | const CATICkeParm_var& | iParam) = 0 |
-
Sets start parameter.
Note: Used for law type= CATGSMBasicLawType_Constant,
CATGSMBasicLawType_Linear,
CATGSMBasicLawType_SType
- Parameters:
-
- iParam
- Parameter unit depends on law unit
- See also:
- CATGSMBasicLawType
This object is included in the file: CATIGSMIntegratedLaw.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces