Cycle Class¶

class NXOpen.CAM.Cycle¶

Bases: NXOpen.TaggedObject

Represets 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
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
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
MotionOutput	Returns or sets the motion output
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
StepClearance	Returns or sets the step clearance
StepClearanceStatus	Returns or sets the step clearance status
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

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¶

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.StepoverBuilder`

New 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”)

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.CycleDwellType`

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Dwell(dwell)

Parameters:	dwell (`NXOpen.CAM.CycleDwellType`) – the dwell type

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

DwellFinal¶

Cycle.DwellFinal¶

Returns or sets the dwell final type

-------------------------------------

Getter Method

Signature DwellFinal()

Returns:	the dwell final type
Return type:	`NXOpen.CAM.CycleDwellType`

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DwellFinal(dwell)

Parameters:	dwell (`NXOpen.CAM.CycleDwellType`) – the dwell final type

New 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.CycleDwellType`

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DwellStart(dwell)

Parameters:	dwell (`NXOpen.CAM.CycleDwellType`) – the dwell start type

New 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”)

MotionOutput¶

Cycle.MotionOutput¶

Returns or sets the motion output

-------------------------------------

Getter Method

Signature MotionOutput()

Returns:	the motion output
Return type:	`NXOpen.CAM.CycleMotionOutputTypes`

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MotionOutput(newValue)

Parameters:	newValue (`NXOpen.CAM.CycleMotionOutputTypes`) – the motion output

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

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”)

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”)

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”)

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.Point3d`

New 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.Vector3d`

New 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”)