Cycle Class¶
-
class
NXOpen.CAM.Cycle¶ Bases:
NXOpen.TaggedObjectRepresets a User Defined Event
New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| AxialStepover | Returns the axial stepover |
| CamStatus | Returns or sets the cam status |
| CamValue | Returns or sets the cam value |
| CoolantBeforeCut | Returns the coolant |
| CoolantBeforeEngage | Returns the coolant |
| CoolantBeforeRetract | Returns the coolant |
| CsinkDiameter | Returns or sets the csink diameter |
| CycleTrackingPoint | Returns or sets the tracking point |
| CycleType | Returns or sets the cycle type |
| Dwell | Returns or sets the dwell type |
| DwellAtDepth | Returns the dwell at depth |
| DwellAtFinalDepth | Returns the dwell at final depth |
| DwellAtStartPoint | Returns the dwell at start point of phase |
| DwellBeforeCut | Returns the dwell before cut |
| DwellBeforeEngage | Returns the dwell before engage |
| DwellBeforeRetract | Returns the dwell before retract |
| DwellFinal | Returns or sets the dwell final type |
| DwellFinalValue | Returns or sets the dwell final value |
| DwellStart | Returns or sets the dwell start type |
| DwellStartValue | Returns or sets the dwell start value |
| DwellValue | Returns or sets the dwell value |
| EntranceDiameter | Returns or sets the entrance diameter |
| FirstCutMode | Returns or sets the first cut mode type |
| FirstCutValue | Returns or sets the the first cut value |
| LastCutMode | Returns or sets the last cut mode type |
| LastCutValue | Returns or sets the the last cut value |
| MotionOutput | Returns or sets the motion output |
| NodragClearance | Returns the nodrag clearance |
| Option | Returns or sets the option type |
| Orientation | Returns or sets the orientation |
| OrientationStatus | Returns or sets the orientation status |
| Shift | Returns or sets the shift |
| ShiftStatus | Returns or sets the shift status |
| SpindleBeforeEngage | Returns the spindle before engage |
| SpindleBeforeRetract | Returns the spindle before retract |
| StepClearance | Returns or sets the step clearance |
| StepClearanceStatus | Returns or sets the step clearance status |
| StepRetract | Returns the step retract |
| Tag | Returns the Tag for this object. |
| Text | Returns or sets the text |
| Times | Returns or sets the times |
| TimesStatus | Returns or sets the times status |
| TipRelease | Returns the (minimal) tip release |
Methods¶
| Method | Description |
|---|---|
| GetBooleanValue | Get the boolean value of the parameter @return boolean value of parameter |
| GetDoubleValue | Get the double value of the parameter @return double value of parameter |
| GetIntegerValue | Get the integer value of the parameter @return integer value of parameter |
| GetParameterActive | Check if parameter is active @return if the parameter is active |
| GetPointValue | Get the point of the parameter @return |
| GetStringValue | Get the string value of the parameter @return string value of parameter |
| GetVectorValue | Get the vector of the parameter @return |
| SetBooleanValue | Set the boolean value of the parameter |
| SetDoubleValue | Set the double value of the parameter |
| SetIntegerValue | Set the integer value of the parameter |
| SetParameterActive | To Set if parameter is active |
| SetPointValue | Set the point of the parameter |
| SetStringValue | Set the string value of the parameter |
| SetVectorValue | Set the vector of the parameter |
Enumerations¶
| CycleCutMode Enumeration | Available types for fixed cut |
| CycleDwellType Enumeration | Available types for dwell |
| CycleMotionOutputTypes Enumeration | Available types for motion output |
Property Detail¶
AxialStepover¶
-
Cycle.AxialStepover¶ Returns the axial stepover
-------------------------------------Getter Method
Signature
AxialStepover()Returns: Return type: NXOpen.CAM.StepoverBuilderNew in version NX9.0.0.
License requirements: None.
CamStatus¶
-
Cycle.CamStatus¶ Returns or sets the cam status
-------------------------------------Getter Method
Signature
CamStatus()Returns: the cam status type Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CamStatus(camStatus)Parameters: camStatus (bool) – the cam status type New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
CamValue¶
-
Cycle.CamValue¶ Returns or sets the cam value
-------------------------------------Getter Method
Signature
CamValue()Returns: the cam Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CamValue(doubleValue)Parameters: doubleValue (int) – the cam New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
CoolantBeforeCut¶
-
Cycle.CoolantBeforeCut¶ Returns the coolant
-------------------------------------Getter Method
Signature
CoolantBeforeCut()Returns: Return type: NXOpen.CAM.CycleCoolantNew in version NX10.0.2.
License requirements: None.
CoolantBeforeEngage¶
-
Cycle.CoolantBeforeEngage¶ Returns the coolant
-------------------------------------Getter Method
Signature
CoolantBeforeEngage()Returns: Return type: NXOpen.CAM.CycleCoolantNew in version NX10.0.2.
License requirements: None.
CoolantBeforeRetract¶
-
Cycle.CoolantBeforeRetract¶ Returns the coolant
-------------------------------------Getter Method
Signature
CoolantBeforeRetract()Returns: Return type: NXOpen.CAM.CycleCoolantNew in version NX10.0.2.
License requirements: None.
CsinkDiameter¶
-
Cycle.CsinkDiameter¶ Returns or sets the csink diameter
-------------------------------------Getter Method
Signature
CsinkDiameter()Returns: the csink diameter Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CsinkDiameter(doubleValue)Parameters: doubleValue (float) – the csink diameter New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
CycleTrackingPoint¶
-
Cycle.CycleTrackingPoint¶ Returns or sets the tracking point
-------------------------------------Getter Method
Signature
CycleTrackingPoint()Returns: the text Return type: str New in version NX9.0.2.
License requirements: None.
-------------------------------------Setter Method
Signature
CycleTrackingPoint(cText)Parameters: cText (str) – the text New in version NX9.0.2.
License requirements: cam_base (“CAM BASE”)
CycleType¶
-
Cycle.CycleType¶ Returns or sets the cycle type
-------------------------------------Getter Method
Signature
CycleType()Returns: the cycle type Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CycleType(cycleName)Parameters: cycleName (str) – the cycle type New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
Dwell¶
-
Cycle.Dwell¶ Returns or sets the dwell type
-------------------------------------Getter Method
Signature
Dwell()Returns: the dwell type Return type: NXOpen.CAM.CycleDwellTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Dwell(dwell)Parameters: dwell ( NXOpen.CAM.CycleDwellType) – the dwell typeNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
DwellAtDepth¶
-
Cycle.DwellAtDepth¶ Returns the dwell at depth
-------------------------------------Getter Method
Signature
DwellAtDepth()Returns: Return type: NXOpen.CAM.CycleDwellNew in version NX10.0.2.
License requirements: None.
DwellAtFinalDepth¶
-
Cycle.DwellAtFinalDepth¶ Returns the dwell at final depth
-------------------------------------Getter Method
Signature
DwellAtFinalDepth()Returns: Return type: NXOpen.CAM.CycleDwellNew in version NX10.0.2.
License requirements: None.
DwellAtStartPoint¶
-
Cycle.DwellAtStartPoint¶ Returns the dwell at start point of phase
-------------------------------------Getter Method
Signature
DwellAtStartPoint()Returns: Return type: NXOpen.CAM.CycleDwellNew in version NX10.0.2.
License requirements: None.
DwellBeforeCut¶
-
Cycle.DwellBeforeCut¶ Returns the dwell before cut
-------------------------------------Getter Method
Signature
DwellBeforeCut()Returns: Return type: NXOpen.CAM.CycleDwellNew in version NX10.0.2.
License requirements: None.
DwellBeforeEngage¶
-
Cycle.DwellBeforeEngage¶ Returns the dwell before engage
-------------------------------------Getter Method
Signature
DwellBeforeEngage()Returns: Return type: NXOpen.CAM.CycleDwellNew in version NX10.0.2.
License requirements: None.
DwellBeforeRetract¶
-
Cycle.DwellBeforeRetract¶ Returns the dwell before retract
-------------------------------------Getter Method
Signature
DwellBeforeRetract()Returns: Return type: NXOpen.CAM.CycleDwellNew in version NX10.0.2.
License requirements: None.
DwellFinal¶
-
Cycle.DwellFinal¶ Returns or sets the dwell final type
-------------------------------------Getter Method
Signature
DwellFinal()Returns: the dwell final type Return type: NXOpen.CAM.CycleDwellTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DwellFinal(dwell)Parameters: dwell ( NXOpen.CAM.CycleDwellType) – the dwell final typeNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
DwellFinalValue¶
-
Cycle.DwellFinalValue¶ Returns or sets the dwell final value
-------------------------------------Getter Method
Signature
DwellFinalValue()Returns: the dwell final Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DwellFinalValue(doubleValue)Parameters: doubleValue (float) – the dwell final New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
DwellStart¶
-
Cycle.DwellStart¶ Returns or sets the dwell start type
-------------------------------------Getter Method
Signature
DwellStart()Returns: the dwell strat type Return type: NXOpen.CAM.CycleDwellTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DwellStart(dwell)Parameters: dwell ( NXOpen.CAM.CycleDwellType) – the dwell start typeNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
DwellStartValue¶
-
Cycle.DwellStartValue¶ Returns or sets the dwell start value
-------------------------------------Getter Method
Signature
DwellStartValue()Returns: the dwell start Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DwellStartValue(doubleValue)Parameters: doubleValue (float) – the dwell start New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
DwellValue¶
-
Cycle.DwellValue¶ Returns or sets the dwell value
-------------------------------------Getter Method
Signature
DwellValue()Returns: the dwell value Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DwellValue(doubleValue)Parameters: doubleValue (float) – the dwell value New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
EntranceDiameter¶
-
Cycle.EntranceDiameter¶ Returns or sets the entrance diameter
-------------------------------------Getter Method
Signature
EntranceDiameter()Returns: the entrance diameter Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EntranceDiameter(doubleValue)Parameters: doubleValue (float) – the entrance diameter New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
FirstCutMode¶
-
Cycle.FirstCutMode¶ Returns or sets the first cut mode type
-------------------------------------Getter Method
Signature
FirstCutMode()Returns: the first cut mode Return type: NXOpen.CAM.CycleCutModeNew in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
FirstCutMode(firstCutMode)Parameters: firstCutMode ( NXOpen.CAM.CycleCutMode) – the first cut modeNew in version NX9.0.3.
License requirements: cam_base (“CAM BASE”)
FirstCutValue¶
-
Cycle.FirstCutValue¶ Returns or sets the the first cut value
-------------------------------------Getter Method
Signature
FirstCutValue()Returns: the first cut value Return type: float New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
FirstCutValue(doubleValue)Parameters: doubleValue (float) – the first cut New in version NX9.0.3.
License requirements: cam_base (“CAM BASE”)
LastCutMode¶
-
Cycle.LastCutMode¶ Returns or sets the last cut mode type
-------------------------------------Getter Method
Signature
LastCutMode()Returns: the last cut mode Return type: NXOpen.CAM.CycleCutModeNew in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
LastCutMode(lastCutMode)Parameters: lastCutMode ( NXOpen.CAM.CycleCutMode) – the last cut modeNew in version NX9.0.3.
License requirements: cam_base (“CAM BASE”)
LastCutValue¶
-
Cycle.LastCutValue¶ Returns or sets the the last cut value
-------------------------------------Getter Method
Signature
LastCutValue()Returns: the last cut value Return type: float New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
LastCutValue(doubleValue)Parameters: doubleValue (float) – the last cut New in version NX9.0.3.
License requirements: cam_base (“CAM BASE”)
MotionOutput¶
-
Cycle.MotionOutput¶ Returns or sets the motion output
-------------------------------------Getter Method
Signature
MotionOutput()Returns: the motion output Return type: NXOpen.CAM.CycleMotionOutputTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MotionOutput(newValue)Parameters: newValue ( NXOpen.CAM.CycleMotionOutputTypes) – the motion outputNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
NodragClearance¶
-
Cycle.NodragClearance¶ Returns the nodrag clearance
-------------------------------------Getter Method
Signature
NodragClearance()Returns: Return type: NXOpen.CAM.CycleNodragClearanceNew in version NX11.0.0.
License requirements: None.
Option¶
-
Cycle.Option¶ Returns or sets the option type
-------------------------------------Getter Method
Signature
Option()Returns: the option type Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Option(optionType)Parameters: optionType (bool) – the option type New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
Orientation¶
-
Cycle.Orientation¶ Returns or sets the orientation
-------------------------------------Getter Method
Signature
Orientation()Returns: the orientation Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Orientation(orientation)Parameters: orientation (float) – the orientation New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
OrientationStatus¶
-
Cycle.OrientationStatus¶ Returns or sets the orientation status
-------------------------------------Getter Method
Signature
OrientationStatus()Returns: the orientation status Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OrientationStatus(oStatus)Parameters: oStatus (bool) – the orientation status New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
Shift¶
-
Cycle.Shift¶ Returns or sets the shift
-------------------------------------Getter Method
Signature
Shift()Returns: the shift Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Shift(doubleValue)Parameters: doubleValue (float) – the shift New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
ShiftStatus¶
-
Cycle.ShiftStatus¶ Returns or sets the shift status
-------------------------------------Getter Method
Signature
ShiftStatus()Returns: the shift status type Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShiftStatus(camStatus)Parameters: camStatus (bool) – the shift status type New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SpindleBeforeEngage¶
-
Cycle.SpindleBeforeEngage¶ Returns the spindle before engage
-------------------------------------Getter Method
Signature
SpindleBeforeEngage()Returns: Return type: NXOpen.CAM.CycleSpindleNew in version NX10.0.2.
License requirements: None.
SpindleBeforeRetract¶
-
Cycle.SpindleBeforeRetract¶ Returns the spindle before retract
-------------------------------------Getter Method
Signature
SpindleBeforeRetract()Returns: Return type: NXOpen.CAM.CycleSpindleNew in version NX10.0.2.
License requirements: None.
StepClearance¶
-
Cycle.StepClearance¶ Returns or sets the step clearance
-------------------------------------Getter Method
Signature
StepClearance()Returns: the step clearance Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StepClearance(doubleValue)Parameters: doubleValue (float) – the step clearance New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
StepClearanceStatus¶
-
Cycle.StepClearanceStatus¶ Returns or sets the step clearance status
-------------------------------------Getter Method
Signature
StepClearanceStatus()Returns: the step clearance status type Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StepClearanceStatus(camStatus)Parameters: camStatus (bool) – the step clearance status type New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
StepRetract¶
-
Cycle.StepRetract¶ Returns the step retract
-------------------------------------Getter Method
Signature
StepRetract()Returns: Return type: NXOpen.CAM.CycleStepRetractNew in version NX10.0.2.
License requirements: None.
Text¶
-
Cycle.Text¶ Returns or sets the text
-------------------------------------Getter Method
Signature
Text()Returns: the text Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Text(cText)Parameters: cText (str) – the text New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
Times¶
-
Cycle.Times¶ Returns or sets the times
-------------------------------------Getter Method
Signature
Times()Returns: the times Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Times(times)Parameters: times (int) – the times New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
TimesStatus¶
-
Cycle.TimesStatus¶ Returns or sets the times status
-------------------------------------Getter Method
Signature
TimesStatus()Returns: the times status type Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TimesStatus(camStatus)Parameters: camStatus (bool) – the times status type New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
TipRelease¶
-
Cycle.TipRelease¶ Returns the (minimal) tip release
-------------------------------------Getter Method
Signature
TipRelease()Returns: Return type: NXOpen.CAM.CycleTipReleaseNew in version NX10.0.2.
License requirements: None.
Method Detail¶
GetBooleanValue¶
-
Cycle.GetBooleanValue¶ Get the boolean value of the parameter
Signature
GetBooleanValue(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: boolean value of parameter Return type: bool New in version NX9.0.0.
License requirements: None.
GetDoubleValue¶
-
Cycle.GetDoubleValue¶ Get the double value of the parameter
Signature
GetDoubleValue(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: double value of parameter Return type: float New in version NX9.0.0.
License requirements: None.
GetIntegerValue¶
-
Cycle.GetIntegerValue¶ Get the integer value of the parameter
Signature
GetIntegerValue(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: integer value of parameter Return type: int New in version NX9.0.0.
License requirements: None.
GetParameterActive¶
-
Cycle.GetParameterActive¶ Check if parameter is active
Signature
GetParameterActive(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: if the parameter is active Return type: bool New in version NX9.0.0.
License requirements: None.
GetPointValue¶
-
Cycle.GetPointValue¶ Get the point of the parameter
Signature
GetPointValue(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: Return type: NXOpen.Point3dNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
GetStringValue¶
-
Cycle.GetStringValue¶ Get the string value of the parameter
Signature
GetStringValue(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: string value of parameter Return type: str New in version NX9.0.0.
License requirements: None.
GetVectorValue¶
-
Cycle.GetVectorValue¶ Get the vector of the parameter
Signature
GetVectorValue(cycleParamName)Parameters: cycleParamName (str) – the name of the parameter Returns: Return type: NXOpen.Vector3dNew in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetBooleanValue¶
-
Cycle.SetBooleanValue¶ Set the boolean value of the parameter
Signature
SetBooleanValue(cycleParamName, booleanValue)Parameters: - cycleParamName (str) – the name of the parameter
- booleanValue (bool) – boolean value of the parameter
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetDoubleValue¶
-
Cycle.SetDoubleValue¶ Set the double value of the parameter
Signature
SetDoubleValue(cycleParamName, doubleValue)Parameters: - cycleParamName (str) – the name of the parameter
- doubleValue (float) – double value of the parameter
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetIntegerValue¶
-
Cycle.SetIntegerValue¶ Set the integer value of the parameter
Signature
SetIntegerValue(cycleParamName, integerValue)Parameters: - cycleParamName (str) – the name of the parameter
- integerValue (int) – integer value of the parameter
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetParameterActive¶
-
Cycle.SetParameterActive¶ To Set if parameter is active
Signature
SetParameterActive(cycleParamName, parameterActive)Parameters: - cycleParamName (str) – the name of the parameter
- parameterActive (bool) – if the parameter is active
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetPointValue¶
-
Cycle.SetPointValue¶ Set the point of the parameter
Signature
SetPointValue(cycleParamName, point)Parameters: - cycleParamName (str) – the name of the parameter
- point (
NXOpen.Point3d) –
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetStringValue¶
-
Cycle.SetStringValue¶ Set the string value of the parameter
Signature
SetStringValue(cycleParamName, stringValue)Parameters: - cycleParamName (str) – the name of the parameter
- stringValue (str) – string value of the parameter
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetVectorValue¶
-
Cycle.SetVectorValue¶ Set the vector of the parameter
Signature
SetVectorValue(cycleParamName, vector)Parameters: - cycleParamName (str) – the name of the parameter
- vector (
NXOpen.Vector3d) –
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)