CATGSMUseItf Interface CATIGSMUseLawDistProj
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseLawDistProj
Interface to law feature.
Role: Allows you to access data of a law feature created by using two curves :
a reference and a definition curve.
- See also:
-
Method Index
- o
GetAppliedUnitSymbol(CATUnicodeString&)
- Gets the symbol of the applied unit of the law.
- o
GetDefinitionElement(CATIMmiMechanicalFeature_var&)
- Gets the definition curve.
- o
GetMeasureUnitSymbol(CATUnicodeString&)
- Gets the symbol of the measure unit of the law.
- o
GetPlaneNormal(CATMathVector&)
- Get the Normal of the plane support of inputs curve.
- o
GetPositiveDirectionOrientation(int&)
- Gets the direction of Law positive values.
- o
GetReferenceElement(CATIMmiMechanicalFeature_var&)
- Gets the reference curve.
- o
GetScalingValue(double&)
- Gets the scaling value of the law.
- o
GetScalingValue(CATICkeParm_var&)
- Gets the scaling value of the law.
- o
IsHeterogeneousLaw(CATBoolean&)
- Returns if law heterogeneous.
- o
IsParameterOnDefinition(CATBoolean&)
- Queries whether evolution parameter is on reference curve (default) or on definition curve.
- o
SetAppliedUnitSymbol(CATUnicodeString&)
- Sets the symbol of the applied unit of the law.
- o
SetDefinitionElement(CATIMmiMechanicalFeature_var)
- Sets the definition curve.
- o
SetMeasureUnitSymbol(CATUnicodeString&)
- Sets the symbol of the measure unit of the law.
- o
SetParameterOnDefinition(CATBoolean)
- Sets evolution parameter on reference curve or on definition curve.
- o
SetPlaneNormal(CATMathVector&)
- Set the Normal of the plane support of inputs curve.
- o
SetPositiveDirectionOrientation(int)
- Sets the direction of Law positive values.
- o
SetReferenceElement(CATIMmiMechanicalFeature_var)
- Sets the reference curve.
- o
SetScalingValue(double)
- Sets the scaling value of the law.
- o
SetScalingValue(CATICkeParm_var&)
- Sets the scaling value of the law.
Methods
o GetAppliedUnitSymbol
| public virtual GetAppliedUnitSymbol( | | oUnitSymbol) |
-
Gets the symbol of the applied unit of the law.
If the returned string is empty there is no applied unit (case of Ratio Law)
- Parameters:
-
- oUnitSymbol
-
NB : If you want to get the CATICkeUnit corresponding to this symbol
you can do it the following way :
CATIParmDictionary_var parmDictionary = CATCkeGlobalFunctions::GetParmDictionary();
CATICkeUnit_var Unit=parmDictionary->FindUnitFromSymbol(oUnitSymbol);
o GetDefinitionElement
| public virtual GetDefinitionElement( | | oElem) |
-
Gets the definition curve.
- Parameters:
-
- oElem
- definition curve.
o GetMeasureUnitSymbol
| public virtual GetMeasureUnitSymbol( | | oUnitSymbol) |
-
Gets the symbol of the measure unit of the law.
If the returned string is empty the law is homogeneous
- Parameters:
-
- oUnitSymbol
-
NB : If you want to get the CATICkeUnit corresponding to this symbol
you can do it the following way :
CATIParmDictionary_var parmDictionary = CATCkeGlobalFunctions::GetParmDictionary();
CATICkeUnit_var Unit=parmDictionary->FindUnitFromSymbol(oUnitSymbol);
o GetPlaneNormal
| public virtual GetPlaneNormal( | | oNormal) |
-
Get the Normal of the plane support of inputs curve.
- Parameters:
-
- oNormal
- CATMathVector
o GetPositiveDirectionOrientation
| public virtual GetPositiveDirectionOrientation( | | Ori) |
-
Gets the direction of Law positive values.
- Parameters:
-
- Ori
- -1 to invert the orientation of the positive direction
O : Unknown Orientation
PositiveLawDirection=Ori * PlaneNormal ^ TangentRefCurve.
o GetReferenceElement
| public virtual GetReferenceElement( | | oElem) |
-
Gets the reference curve.
- Parameters:
-
- oElem
- reference curve.
o GetScalingValue
| public virtual GetScalingValue( | | oScale) |
-
Gets the scaling value of the law.
- Parameters:
-
- oScale
- New scaling value
o GetScalingValue
| public virtual GetScalingValue( | | oScale) |
-
Gets the scaling value of the law.
- Parameters:
-
- oScale
- New scaling value
- See also:
-
o IsHeterogeneousLaw
| public virtual IsHeterogeneousLaw( | | IsHeterogeneousLaw) |
-
Returns if law heterogeneous.
- Parameters:
-
- IsHeterogeneousLaw
- TRUE or FALSE
o IsParameterOnDefinition
| public virtual IsParameterOnDefinition( | | oParameterOnDefinition) |
-
Queries whether evolution parameter is on reference curve (default) or on definition curve.
- Parameters:
-
- oParameterOnDefinition
- Flag for parameter type
TRUE: Parameter on definition curve
FALSE: Parameter on reference curve
o SetAppliedUnitSymbol
| public virtual SetAppliedUnitSymbol( | const | iUnitSymbol) |
-
Sets the symbol of the applied unit of the law.
- Parameters:
-
- iUnitSymbol
o SetDefinitionElement
| public virtual SetDefinitionElement( | const | iElem) |
-
Sets the definition curve.
- Parameters:
-
- iElem
- definition curve.
o SetMeasureUnitSymbol
| public virtual SetMeasureUnitSymbol( | const | iUnitSymbol) |
-
Sets the symbol of the measure unit of the law.
- Parameters:
-
- iUnitSymbol
o SetParameterOnDefinition
| public virtual SetParameterOnDefinition( | | iParameterOnDefinition) |
-
Sets evolution parameter on reference curve or on definition curve.
- Parameters:
-
- iParameterOnDefinition
- Flag for parameter type
TRUE: Parameter on definition curve
FALSE: Parameter on reference curve
o SetPlaneNormal
| public virtual SetPlaneNormal( | const | iNormal) |
-
Set the Normal of the plane support of inputs curve.
- Parameters:
-
- iNormal
- CATMathVector
o SetPositiveDirectionOrientation
| public virtual SetPositiveDirectionOrientation( | | Ori) |
-
Sets the direction of Law positive values.
- Parameters:
-
- Ori
- -1 to invert the orientation of the positive direction
O : Unknown Orientation
PositiveLawDirection=Ori * PlaneNormal ^ TangentRefCurve.
o SetReferenceElement
| public virtual SetReferenceElement( | const | iElem) |
-
Sets the reference curve.
- Parameters:
-
- iElem
- reference curve.
o SetScalingValue
| public virtual SetScalingValue( | const | iScale) |
-
Sets the scaling value of the law.
- Parameters:
-
- iScale
- New scaling value
o SetScalingValue
| public virtual SetScalingValue( | const | iScale) |
-
Sets the scaling value of the law.
- Parameters:
-
- iScale
- New scaling value
- See also:
-
This object is included in the file: CATIGSMUseLawDistProj.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.