All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMLawDistProj

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMLawDistProj
 

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


interface CATIGSMLawDistProj

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:
CATIGSMFactory


Method Index


o GetAppliedUnitSymbol(CATUnicodeString&)
Gets the symbol of the applied unit of the law.
o GetDefinitionElement(CATISpecObject_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(CATISpecObject_var&)
Gets the reference curve.
o GetScalingValue(CATICkeParm_var&)
Gets the scaling value of the law.
o GetScalingValue(double&)
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(CATISpecObject_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(CATISpecObject_var)
Sets the reference curve.
o SetScalingValue(CATICkeParm_var&)
Sets the scaling value of the law.
o SetScalingValue(double)
Sets the scaling value of the law.

Methods


o GetAppliedUnitSymbol
public virtual HRESULT GetAppliedUnitSymbol(CATUnicodeString& oUnitSymbol) = 0
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 HRESULT GetDefinitionElement(CATISpecObject_var& oElem) = 0
Gets the definition curve.
Parameters:
oElem
definition curve.
o GetMeasureUnitSymbol
public virtual HRESULT GetMeasureUnitSymbol(CATUnicodeString& oUnitSymbol) = 0
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 HRESULT GetPlaneNormal(CATMathVector& oNormal) = 0
Get the Normal of the plane support of inputs curve.
Parameters:
oNormal
CATMathVector
o GetPositiveDirectionOrientation
public virtual HRESULT GetPositiveDirectionOrientation(int& Ori) = 0
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 HRESULT GetReferenceElement(CATISpecObject_var& oElem) = 0
Gets the reference curve.
Parameters:
oElem
reference curve.
o GetScalingValue
public virtual HRESULT GetScalingValue(CATICkeParm_var& oScale) = 0
Gets the scaling value of the law.
Parameters:
oScale
New scaling value
See also:
CATICkeParm
o GetScalingValue
public virtual HRESULT GetScalingValue(double& oScale) = 0
Gets the scaling value of the law.
Parameters:
oScale
New scaling value
o IsHeterogeneousLaw
public virtual HRESULT IsHeterogeneousLaw(CATBoolean& IsHeterogeneousLaw) = 0
Returns if law heterogeneous.
Parameters:
IsHeterogeneousLaw
TRUE or FALSE
o IsParameterOnDefinition
public virtual HRESULT IsParameterOnDefinition(CATBoolean& oParameterOnDefinition)= 0
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 HRESULT SetAppliedUnitSymbol( const CATUnicodeString& iUnitSymbol) = 0
Sets the symbol of the applied unit of the law.
Parameters:
iUnitSymbol
o SetDefinitionElement
public virtual HRESULT SetDefinitionElement( const CATISpecObject_var iElem) = 0
Sets the definition curve.
Parameters:
iElem
definition curve.
o SetMeasureUnitSymbol
public virtual HRESULT SetMeasureUnitSymbol( const CATUnicodeString& iUnitSymbol) = 0
Sets the symbol of the measure unit of the law.
Parameters:
iUnitSymbol
o SetParameterOnDefinition
public virtual HRESULT SetParameterOnDefinition(CATBoolean iParameterOnDefinition) = 0
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 HRESULT SetPlaneNormal( const CATMathVector& iNormal) = 0
Set the Normal of the plane support of inputs curve.
Parameters:
iNormal
CATMathVector
o SetPositiveDirectionOrientation
public virtual HRESULT SetPositiveDirectionOrientation(int Ori) = 0
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 HRESULT SetReferenceElement( const CATISpecObject_var iElem) = 0
Sets the reference curve.
Parameters:
iElem
reference curve.
o SetScalingValue
public virtual HRESULT SetScalingValue( const CATICkeParm_var& iScale) = 0
Sets the scaling value of the law.
Parameters:
iScale
New scaling value
See also:
CATICkeParm
o SetScalingValue
public virtual HRESULT SetScalingValue( const double iScale) = 0
Sets the scaling value of the law.
Parameters:
iScale
New scaling value

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

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