All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseOffset

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

interface CATIGSMUseOffset

Interface to offset surface feature.
Role: Allows you to gets or/and sets the definition elements of a surface offset: a surface, an orientation and an offset value.
Note: Methodolpgy of remove of "tricky" face at offset update : Use of the suppress mode has to be handle carefully in Offset
- If Supppress mode is active: Each time the offset is updated, the operator will identify automatically the "tricky" faces and removes them Example: This mode is the standard behaviour in Part Design (Offset is used in "Thick" operator)
- If Supppress mode is in-active: Each time the offset is update, if a face has to be removed and this face is not declared in the "tricky" faces the update failed Example: This mode is the standard behaviour in Gsd in Offset : Each time some face has to be removed, the offset failed if it is not declared as tricky face In the Gsd interactive offset command, a pop-up window is proposed in order to validate the insertion of "tricky" identified faces in the list The list of all tricky face are then kept in the offset data , and are reused at update

See also:

Method Index

o AddTrickyFace(CATIMmiMechanicalFeature_var): Adds a tricky face object on the object.
o GetCkeOffsetDeviation(CATICkeParm_var&): Gets the offset deviation value.
o GetCkeOffsetValue(CATICkeParm_var&): Gets the offset value.
o GetInvertDirection(CATBoolean&): Gets the orientation.
o GetOffsetDeviation(double&): Gets the offset deviation value.
o GetOffsetType(CATGSMOffsetType&): Gets Offset type.
o GetOffsetValue(double&): Gets the offset value.
o GetProfil(CATIMmiMechanicalFeature_var&): Gets the reference surface.
o GetRegularizationType(CATGSMOffsetRegularisationType&): Gets the regularization type
o GetSuppressMode(CATBoolean&): Gets 'suppress mode'.
o GetTrickyFaces(CATLISTV(CATIMmiMechanicalFeature_var)&): Returns the tricky faces object on the object.
o RemoveTrickyFaces(int): Remove the tricky face object on the object.
o SetInvertDirection(CATBoolean): Sets the orientation.
o SetOffsetDeviation(double): Sets the offset deviation value.
o SetOffsetDeviation(CATICkeParm_var): Sets the offset deviation value.
o SetOffsetType(CATGSMOffsetType): Sets the type of Offset.
o SetOffsetValue(double): Sets the offset value.
o SetOffsetValue(CATICkeParm_var): Sets the offset value.
o SetProfil(CATIMmiMechanicalFeature_var): Sets the reference surface.
o SetRegularizationType(CATGSMOffsetRegularisationType&): Sets the regularization type
o SetSuppressMode(CATBoolean): Sets the suppress mode.

Methods

o AddTrickyFace

public virtual AddTrickyFace( const iTrickyFace)

Adds a tricky face object on the object.

Parameters:

iTrickyFace: Offset invalid face

o GetCkeOffsetDeviation

public virtual GetCkeOffsetDeviation( oOffDeviation)

Gets the offset deviation value.

Parameters:

oOffDeviation: Offset deviation value (Cke Parameter)

o GetCkeOffsetValue

public virtual GetCkeOffsetValue( oOffValue)

Gets the offset value.

Parameters:

oOffValue: Offset value

o GetInvertDirection

public virtual GetInvertDirection( oInvert)

Gets the orientation.

Parameters:

oInvert: : False means that there is no invertion of the surface orientation (orientation is the normal on the surface) : True to invert this orientation

o GetOffsetDeviation

public virtual GetOffsetDeviation( oOffDeviation)

Gets the offset deviation value.

Parameters:

oOffDeviation: Offset deviation value

o GetOffsetType

public virtual GetOffsetType( oType)

Gets Offset type.
Normal or smooth tyoe.

Parameters:

oType: Offset type : CATGSMOffset_Constant (=0) -> Normal : CATGSMOffset_Rough (=1) -> Rough : CATGSMOffset_Smooth (=2) -> Smooth

See also:

o GetOffsetValue

public virtual GetOffsetValue( oOffValue)

Gets the offset value.

Parameters:

oOffValue: Offset value

o GetProfil

public virtual GetProfil( oElem)

Gets the reference surface.

Parameters:

oElem: Offset Surface

o GetRegularizationType

public virtual GetRegularizationType( oRegul)

Gets the regularization type

Parameters:

oRegul: CATGSMRegularization_Undefined if the regularization is not defined CATGSMRegularization_Local if the regularization is local CATGSMRegularization_Global if the regularization is global

o GetSuppressMode

public virtual GetSuppressMode( oSuppressMode)

Gets 'suppress mode'.

Parameters:

oSuppressMode: CATTrue = erroneous elements are removed from the result autonmatically at update CATFalse = error if erroneous elements, (not declared tricky faces)

See also:

o GetTrickyFaces

public virtual GetTrickyFaces( oTrickyFaces)

Returns the tricky faces object on the object.

Parameters:

oTrickyFaces: Offset invalid faces

o RemoveTrickyFaces

public virtual RemoveTrickyFaces( iRank)

Remove the tricky face object on the object.

Parameters:

iRank: position of the face in the list of TrickyFaces

o SetInvertDirection

public virtual SetInvertDirection( iInvert)

Sets the orientation.

Parameters:

iInvert: : False means that there is no invertion of the curve orientation (orientation is the product of the tangent of the curve by the normal on the support) : True to invert this orientation

o SetOffsetDeviation

public virtual SetOffsetDeviation( const iOffDeviation)

Sets the offset deviation value.

Parameters:

iOffDeviation: Offset deviation value

o SetOffsetDeviation

public virtual SetOffsetDeviation( const iOffDeviation)

Sets the offset deviation value.

Parameters:

iOffDeviation: Offset deviation value (Cke Parameter)

o SetOffsetType

public virtual SetOffsetType( iType)

Sets the type of Offset.
It modifies the Offset type either "Normal" or "Rough" or "Smooth"

Parameters:

iType: Offset type : CATGSMOffset_Constant (=0) -> Normal : CATGSMOffset_Rough (=1) -> Rough : CATGSMOffset_Smooth (=2) -> Smooth

See also:

o SetOffsetValue

public virtual SetOffsetValue( iOffValue)

Sets the offset value.

Parameters:

iOffValue: Offset value

o SetOffsetValue

public virtual SetOffsetValue( const iOffValue)

Sets the offset value.

Parameters:

iOffValue: Offset value

o SetProfil

public virtual SetProfil( const iElem)

Sets the reference surface.

Parameters:

iElem: new reference surface

o SetRegularizationType

public virtual SetRegularizationType( const iRegul)

Sets the regularization type

Parameters:

oRegul: CATGSMRegularization_Undefined if the regularization is not defined CATGSMRegularization_Local if the regularization is local CATGSMRegularization_Global if the regularization is global

o SetSuppressMode

public virtual SetSuppressMode( iSuppressMode)

Sets the suppress mode.

Parameters:

iSuppressMode: CATTrue = erroneous elements are removed from the result autonmatically at update CATFalse = error if erroneous elements, (not declared tricky faces)
Note:
- If Supppress mode is active: Each time the offset is updated, the operator will identify automatically the "tricky" faces and removes them Example: This mode is the standard behaviour in Part Design (Offset is used in "Thick" operator)
- If Supppress mode is in-active: Each time the offset is update, if a face has to be removed and this face is not declared in the "tricky" faces the update failed Example: This mode is the standard behaviour in Gsd in Offset : Each time some face has to be removed, the offset failed if it is not declared as tricky face In the Gsd interactive offset command, a pop-up window is proposed in order to validate the insertion of "tricky" identified faces in the list The list of all tricky face are then kept in the offset data , and are reused at update

See also:

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