CATGSMUseItf Interface CATIGSMUseHelix
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseHelix
Interface to helix feature.
Role: Allows you to access data of the Helix feature created by using
an axis, a starting point, a pitch, a height and 2 angle values.
- See also:
-
Method Index
- o
GetAxis()
- Gets the helix axis.
- o
GetClockwiseRevolution(CATBoolean&)
- Gets the sense of revolutions.
- o
GetHeight(double&)
- Gets the height of the helix.
- o
GetHeight(CATICkeParm_var&)
- Gets the height of the helix.
- o
GetHelixType(int&)
- Gets the helix Panel Type.
- o
GetInvertAxis(CATBoolean&)
- Gets the orientation.
- o
GetPitch(double&)
- Gets the pitch of the helix.
- o
GetPitch(CATICkeParm_var&)
- Gets the pitch of the helix.
- o
GetPitch2(double&)
- Gets the second pitch of the helix.
- o
GetPitch2(CATICkeParm_var&)
- Gets the second pitch of the helix.
- o
GetPitchLawType(enum CATGSMBasicLawType&)
- Gets pitch law type.
- o
GetProfile()
- Gets the profile of the helix.
- o
GetRevolutions(double&)
- Gets the revolution number of the helix.
- o
GetRevolutions(CATICkeParm_var&)
- Gets the revolution number of the helix.
- o
GetStartingAngle(double&)
- Gets the helix starting angle.
- o
GetStartingAngle(CATICkeParm_var&)
- Gets the helix starting angle.
- o
GetStartingPoint()
- Gets the starting point of the helix.
- o
GetTaperAngle(double&)
- Gets the helix taper angle.
- o
GetTaperAngle(CATICkeParm_var&)
- Gets the helix taper angle.
- o
GetTaperOutward(CATBoolean&)
- Gets the taper angle sense of variation.
- o
InvertAxis()
- Inverts the orientation of the axis.
- o
SetAxis(CATIMmiMechanicalFeature_var)
- Sets the helix axis.
- o
SetClockwiseRevolution(CATBoolean)
- Sets the sense of revolutions.
- o
SetHeight(double)
- Sets the helix height.
- o
SetHeight(CATICkeParm_var)
- Sets the helix height.
- o
SetHelixType(int)
- Sets the helix Panel Type.
- o
SetInvertAxis(CATBoolean)
- Sets the orientation.
- o
SetPitch(double)
- Sets the helix pitch.
- o
SetPitch(CATICkeParm_var)
- Sets the helix pitch.
- o
SetPitch2(double)
- Sets the helix second pitch.
- o
SetPitch2(CATICkeParm_var)
- Sets the helix second pitch.
- o
SetPitchLawType(enum CATGSMBasicLawType)
- Sets pitch law type.
- o
SetProfile(CATIMmiMechanicalFeature_var)
- Sets the profile.
- o
SetRevolutions(double)
- Sets the revolution number.
- o
SetRevolutions(CATICkeParm_var)
- Sets the revolution number.
- o
SetStartingAngle(double)
- Sets the starting angle.
- o
SetStartingAngle(CATICkeParm_var)
- Sets the starting angle.
- o
SetStartingPoint(CATIMmiMechanicalFeature_var)
- Sets the starting point.
- o
SetTaperAngle(double)
- Sets the taper angle.
- o
SetTaperAngle(CATICkeParm_var)
- Sets the taper angle.
- o
SetTaperOutward(CATBoolean)
- Sets the taper angle sense of variation.
Methods
o GetAxis
-
Gets the helix axis.
T
Note: he starting point must not be on the helix axis
- Returns:
- The helix axis
o GetClockwiseRevolution
| public virtual GetClockwiseRevolution( | | oClockwise) |
-
Gets the sense of revolutions.
- Parameters:
-
- oClockwise
-
: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o GetHeight
| public virtual GetHeight( | | oHeight) |
-
Gets the height of the helix.
- Parameters:
-
- oHeight
- The helix height.
o GetHeight
| public virtual GetHeight( | | oHeight) |
-
Gets the height of the helix.
- Parameters:
-
- oHeight
- The helix height.
o GetHelixType
| public virtual GetHelixType( | | oPanelType) |
-
Gets the helix Panel Type.
- Parameters:
-
- oPanelType
- The new helix Type.
o GetInvertAxis
| public virtual GetInvertAxis( | | oInvert) |
-
Gets the orientation.
- Parameters:
-
- oInvert
-
: FALSE means that there is no invertion (natural orientation)
: TRUE to invert this orientation
o GetPitch
| public virtual GetPitch( | | oPitch) |
-
Gets the pitch of the helix.
- Parameters:
-
- oPitch
- The helix pitch.
o GetPitch
| public virtual GetPitch( | | oPitch) |
-
Gets the pitch of the helix.
- Parameters:
-
- oPitch
- The helix pitch.
o GetPitch2
| public virtual GetPitch2( | | oPitch) |
-
Gets the second pitch of the helix.
- Parameters:
-
- oPitch
- The helix second pitch.
o GetPitch2
| public virtual GetPitch2( | | oPitch) |
-
Gets the second pitch of the helix.
- Parameters:
-
- oPitch
- The helix second pitch.
o GetPitchLawType
| public virtual GetPitchLawType( | | oType) |
-
Gets pitch law type.
- Parameters:
-
- oType
- Type of law (from CATGSMBasicLawType enumeration).
- See also:
-
o GetProfile
| public virtual GetProfile( | ) |
-
Gets the profile of the helix.
- Returns:
- The profile
o GetRevolutions
| public virtual GetRevolutions( | | oRevolutions) |
-
Gets the revolution number of the helix.
- Parameters:
-
- oRevolutions
- Revolutions.
o GetRevolutions
| public virtual GetRevolutions( | | oRevolutions) |
-
Gets the revolution number of the helix.
- Parameters:
-
- oRevolutions
- Revolutions.
o GetStartingAngle
| public virtual GetStartingAngle( | | oStartingAngle) |
-
Gets the helix starting angle.
- Parameters:
-
- oStartingAngle
- The starting angle.
o GetStartingAngle
| public virtual GetStartingAngle( | | oStartingAngle) |
-
Gets the helix starting angle.
- Parameters:
-
- oStartingAngle
- The starting angle.
o GetStartingPoint
| public virtual GetStartingPoint( | ) |
-
Gets the starting point of the helix.
Note: The starting point must not be on the helix axis
- Returns:
- The starting point
o GetTaperAngle
| public virtual GetTaperAngle( | | oTaperAngle) |
-
Gets the helix taper angle.
- Parameters:
-
- oTaperAngle
- The taper angle.
o GetTaperAngle
| public virtual GetTaperAngle( | | oTaperAngle) |
-
Gets the helix taper angle.
- Parameters:
-
- oTaperAngle
- The taper angle.
o GetTaperOutward
| public virtual GetTaperOutward( | | oTaperOutward) |
-
Gets the taper angle sense of variation.
- Parameters:
-
- oTaperOutward
-
: FALSE means that helix radius decreases
: TRUE means that helix radius increases
o InvertAxis
| public virtual InvertAxis( | ) |
-
Inverts the orientation of the axis.
o SetAxis
| public virtual SetAxis( | const | iElem1) |
-
Sets the helix axis.
- Parameters:
-
- iElem1
- The new helix axis.
o SetClockwiseRevolution
| public virtual SetClockwiseRevolution( | | iClockwise) |
-
Sets the sense of revolutions.
- Parameters:
-
- iClockwise
-
: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o SetHeight
| public virtual SetHeight( | | iHeight) |
-
Sets the helix height.
- Parameters:
-
- iHeight
- The new height value.
o SetHeight
| public virtual SetHeight( | const | iHeight) |
-
Sets the helix height.
- Parameters:
-
- iHeight
- The new height value.
o SetHelixType
| public virtual SetHelixType( | | iPanelType) |
-
Sets the helix Panel Type.
- Parameters:
-
- iPanelType
- The new helix Type.
o SetInvertAxis
| public virtual SetInvertAxis( | | iInvert) |
-
Sets the orientation.
- Parameters:
-
- iInvert
-
: FALSE means that there is no invertion of the natural orientation
: TRUE to invert this orientation
o SetPitch
| public virtual SetPitch( | | iPitch) |
-
Sets the helix pitch.
- Parameters:
-
- iPitch
- The new pitch value.
o SetPitch
| public virtual SetPitch( | const | iPitch) |
-
Sets the helix pitch.
- Parameters:
-
- iPitch
- The new second pitch value.
o SetPitch2
| public virtual SetPitch2( | | iPitch) |
-
Sets the helix second pitch.
- Parameters:
-
- iPitch
- The new second pitch value.
o SetPitch2
| public virtual SetPitch2( | const | iPitch) |
-
Sets the helix second pitch.
- Parameters:
-
- iPitch
- The new second pitch value.
o SetPitchLawType
| public virtual SetPitchLawType( | const | iType) |
-
Sets pitch law type.
- Parameters:
-
- iType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_SType.
- See also:
-
o SetProfile
| public virtual SetProfile( | const | iElem1) |
-
Sets the profile.
- Parameters:
-
- iElem1
- New profile.
Note: iElem1 = NULL_var unsets the profile.
o SetRevolutions
| public virtual SetRevolutions( | | iRevolutions) |
-
Sets the revolution number.
- Parameters:
-
- iRevolutions
- The new revolutions value.
o SetRevolutions
| public virtual SetRevolutions( | const | iRevolutions) |
-
Sets the revolution number.
- Parameters:
-
- iRevolutions
- The new revolutions value.
o SetStartingAngle
| public virtual SetStartingAngle( | | iStartingAngle) |
-
Sets the starting angle.
- Parameters:
-
- iStartingAngle
- The new starting angle value.
o SetStartingAngle
| public virtual SetStartingAngle( | const | iStartingAngle) |
-
Sets the starting angle.
- Parameters:
-
- iStartingAngle
- The new starting angle value.
o SetStartingPoint
| public virtual SetStartingPoint( | const | iElem1) |
-
Sets the starting point.
- Parameters:
-
- iElem1
- New starting point.
o SetTaperAngle
| public virtual SetTaperAngle( | | iTaperAngle) |
-
Sets the taper angle.
- Parameters:
-
- iTaperAngle
- The new taper angle value.
o SetTaperAngle
| public virtual SetTaperAngle( | const | iTaperAngle) |
-
Sets the taper angle.
- Parameters:
-
- iTaperAngle
- The new taper angle value.
o SetTaperOutward
| public virtual SetTaperOutward( | | iTaperOutward) |
-
Sets the taper angle sense of variation.
- Parameters:
-
- iTaperOutward
-
: FALSE means that helix radius decreases
: TRUE means that helix radius increases
This object is included in the file: CATIGSMUseHelix.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.