NXOpen.CAM.Cycle Class Reference

Represets a User Defined Event More...

Inheritance diagram for NXOpen.CAM.Cycle:

Public Types
enum	CutMode { Off, Value, Percentage }
	Available types for fixed cut More...
enum	DwellType { On, Off, Seconds, Revolutions }
	Available types for dwell More...
enum	MotionOutputTypes { MachineCycle, SingleMoves, InterruptedMoves }
	Available types for motion output More...

Public Member Functions
unsafe bool	GetBooleanValue (string cycleParamName)
	Get the boolean value of the parameter More...
unsafe double	GetDoubleValue (string cycleParamName)
	Get the double value of the parameter More...
unsafe int	GetIntegerValue (string cycleParamName)
	Get the integer value of the parameter More...
unsafe bool	GetParameterActive (string cycleParamName)
	Check if parameter is active More...
unsafe NXOpen.Point3d	GetPointValue (string cycleParamName)
	Get the point of the parameter More...
unsafe string	GetStringValue (string cycleParamName)
	Get the string value of the parameter More...
unsafe NXOpen.Vector3d	GetVectorValue (string cycleParamName)
	Get the vector of the parameter More...
unsafe void	SetBooleanValue (string cycleParamName, bool booleanValue)
	Set the boolean value of the parameter More...
unsafe void	SetDoubleValue (string cycleParamName, double doubleValue)
	Set the double value of the parameter More...
unsafe void	SetIntegerValue (string cycleParamName, int integerValue)
	Set the integer value of the parameter More...
unsafe void	SetParameterActive (string cycleParamName, bool parameterActive)
	To Set if parameter is active More...
unsafe void	SetPointValue (string cycleParamName, NXOpen.Point3d point)
	Set the point of the parameter More...
unsafe void	SetStringValue (string cycleParamName, string stringValue)
	Set the string value of the parameter More...
unsafe void	SetVectorValue (string cycleParamName, NXOpen.Vector3d vector)
	Set the vector of the parameter More...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.CAM.StepoverBuilder	AxialStepover [get]
	Returns the axial stepover More...
unsafe bool	CamStatus [get, set]
	Returns or sets the cam status More...
unsafe int	CamValue [get, set]
	Returns or sets the cam value More...
unsafe NXOpen.CAM.CycleCoolant	CoolantBeforeCut [get]
	Returns the coolant More...
unsafe NXOpen.CAM.CycleCoolant	CoolantBeforeEngage [get]
	Returns the coolant More...
unsafe NXOpen.CAM.CycleCoolant	CoolantBeforeRetract [get]
	Returns the coolant More...
unsafe double	CsinkDiameter [get, set]
	Returns or sets the csink diameter More...
unsafe string	CycleTrackingPoint [get, set]
	Returns or sets the tracking point More...
unsafe string	CycleType [get, set]
	Returns or sets the cycle type More...
unsafe NXOpen.CAM.Cycle.DwellType	Dwell [get, set]
	Returns or sets the dwell type More...
unsafe NXOpen.CAM.CycleDwell	DwellAtDepth [get]
	Returns the dwell at depth More...
unsafe NXOpen.CAM.CycleDwell	DwellAtFinalDepth [get]
	Returns the dwell at final depth More...
unsafe NXOpen.CAM.CycleDwell	DwellAtStartPoint [get]
	Returns the dwell at start point of phase More...
unsafe NXOpen.CAM.CycleDwell	DwellBeforeCut [get]
	Returns the dwell before cut More...
unsafe NXOpen.CAM.CycleDwell	DwellBeforeEngage [get]
	Returns the dwell before engage More...
unsafe NXOpen.CAM.CycleDwell	DwellBeforeRetract [get]
	Returns the dwell before retract More...
unsafe NXOpen.CAM.Cycle.DwellType	DwellFinal [get, set]
	Returns or sets the dwell final type More...
unsafe double	DwellFinalValue [get, set]
	Returns or sets the dwell final value More...
unsafe NXOpen.CAM.Cycle.DwellType	DwellStart [get, set]
	Returns or sets the dwell start type More...
unsafe double	DwellStartValue [get, set]
	Returns or sets the dwell start value More...
unsafe double	DwellValue [get, set]
	Returns or sets the dwell value More...
unsafe double	EntranceDiameter [get, set]
	Returns or sets the entrance diameter More...
unsafe NXOpen.CAM.Cycle.CutMode	FirstCutMode [get, set]
	Returns or sets the first cut mode type More...
unsafe double	FirstCutValue [get, set]
	Returns or sets the the first cut value More...
unsafe NXOpen.CAM.Cycle.CutMode	LastCutMode [get, set]
	Returns or sets the last cut mode type More...
unsafe double	LastCutValue [get, set]
	Returns or sets the the last cut value More...
unsafe NXOpen.CAM.Cycle.MotionOutputTypes	MotionOutput [get, set]
	Returns or sets the motion output More...
unsafe NXOpen.CAM.CycleNodragClearance	NodragClearance [get]
	Returns the nodrag clearance More...
unsafe bool	Option [get, set]
	Returns or sets the option type More...
unsafe double	Orientation [get, set]
	Returns or sets the orientation More...
unsafe bool	OrientationStatus [get, set]
	Returns or sets the orientation status More...
unsafe double	Shift [get, set]
	Returns or sets the shift More...
unsafe bool	ShiftStatus [get, set]
	Returns or sets the shift status More...
unsafe NXOpen.CAM.CycleSpindle	SpindleBeforeEngage [get]
	Returns the spindle before engage More...
unsafe NXOpen.CAM.CycleSpindle	SpindleBeforeRetract [get]
	Returns the spindle before retract More...
unsafe double	StepClearance [get, set]
	Returns or sets the step clearance More...
unsafe bool	StepClearanceStatus [get, set]
	Returns or sets the step clearance status More...
unsafe NXOpen.CAM.CycleStepRetract	StepRetract [get]
	Returns the step retract More...
unsafe string	Text [get, set]
	Returns or sets the text More...
unsafe int	Times [get, set]
	Returns or sets the times More...
unsafe bool	TimesStatus [get, set]
	Returns or sets the times status More...
unsafe NXOpen.CAM.CycleTipRelease	TipRelease [get]
	Returns the (minimal) tip release More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represets a User Defined Event

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.CAM.Cycle.CutMode

Available types for fixed cut

Enumerator
Off	fixed cut distance off
Value	fixed cut distance by value
Percentage	fixed cut distance by percentage of tool diameter

enum NXOpen.CAM.Cycle.DwellType

Available types for dwell

Enumerator
On	dwell on
Off	dwell off
Seconds	dwell seconds
Revolutions	dwell revolutions

enum NXOpen.CAM.Cycle.MotionOutputTypes

Available types for motion output

Enumerator
MachineCycle	Machine Cycle
SingleMoves	single moves
InterruptedMoves	interrupted moves

Member Function Documentation

unsafe bool NXOpen.CAM.Cycle.GetBooleanValue ( string  cycleParamName )

inline

Get the boolean value of the parameter

Created in NX9.0.0

License requirements: None.

Parameters

cycleParamName

the name of the parameter

Returns

boolean value of parameter

unsafe double NXOpen.CAM.Cycle.GetDoubleValue ( string  cycleParamName )

inline

Get the double value of the parameter

Created in NX9.0.0

License requirements: None.

Parameters

cycleParamName

the name of the parameter

Returns

double value of parameter

unsafe int NXOpen.CAM.Cycle.GetIntegerValue ( string  cycleParamName )

inline

Get the integer value of the parameter

Created in NX9.0.0

License requirements: None.

Parameters

cycleParamName

the name of the parameter

Returns

integer value of parameter

unsafe bool NXOpen.CAM.Cycle.GetParameterActive ( string  cycleParamName )

inline

Check if parameter is active

Created in NX9.0.0

License requirements: None.

Parameters

cycleParamName

the name of the parameter

Returns

if the parameter is active

unsafe NXOpen.Point3d NXOpen.CAM.Cycle.GetPointValue ( string  cycleParamName )

inline

Get the point of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName

the name of the parameter

Returns

unsafe string NXOpen.CAM.Cycle.GetStringValue ( string  cycleParamName )

inline

Get the string value of the parameter

Created in NX9.0.0

License requirements: None.

Parameters

cycleParamName

the name of the parameter

Returns

string value of parameter

unsafe NXOpen.Vector3d NXOpen.CAM.Cycle.GetVectorValue ( string  cycleParamName )

inline

Get the vector of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName

the name of the parameter

Returns

unsafe void NXOpen.CAM.Cycle.SetBooleanValue ( string  cycleParamName, bool  booleanValue  )

inline

Set the boolean value of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
booleanValue	boolean value of the parameter

unsafe void NXOpen.CAM.Cycle.SetDoubleValue ( string  cycleParamName, double  doubleValue  )

inline

Set the double value of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
doubleValue	double value of the parameter

unsafe void NXOpen.CAM.Cycle.SetIntegerValue ( string  cycleParamName, int  integerValue  )

inline

Set the integer value of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
integerValue	integer value of the parameter

unsafe void NXOpen.CAM.Cycle.SetParameterActive ( string  cycleParamName, bool  parameterActive  )

inline

To Set if parameter is active

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
parameterActive	if the parameter is active

unsafe void NXOpen.CAM.Cycle.SetPointValue ( string  cycleParamName, NXOpen.Point3d  point  )

inline

Set the point of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
point

unsafe void NXOpen.CAM.Cycle.SetStringValue ( string  cycleParamName, string  stringValue  )

inline

Set the string value of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
stringValue	string value of the parameter

unsafe void NXOpen.CAM.Cycle.SetVectorValue ( string  cycleParamName, NXOpen.Vector3d  vector  )

inline

Set the vector of the parameter

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters

cycleParamName	the name of the parameter
vector

Property Documentation

unsafe NXOpen.CAM.StepoverBuilder NXOpen.CAM.Cycle.AxialStepover

get

Returns the axial stepover

Created in NX9.0.0

License requirements: None.

unsafe bool NXOpen.CAM.Cycle.CamStatus

getset

Returns or sets the cam status

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe int NXOpen.CAM.Cycle.CamValue

getset

Returns or sets the cam value

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CycleCoolant NXOpen.CAM.Cycle.CoolantBeforeCut

get

Returns the coolant

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleCoolant NXOpen.CAM.Cycle.CoolantBeforeEngage

get

Returns the coolant

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleCoolant NXOpen.CAM.Cycle.CoolantBeforeRetract

get

Returns the coolant

Created in NX10.0.2

License requirements: None.

unsafe double NXOpen.CAM.Cycle.CsinkDiameter

getset

Returns or sets the csink diameter

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe string NXOpen.CAM.Cycle.CycleTrackingPoint

getset

Returns or sets the tracking point

Created in NX9.0.2

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe string NXOpen.CAM.Cycle.CycleType

getset

Returns or sets the cycle type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.Cycle.DwellType NXOpen.CAM.Cycle.Dwell

getset

Returns or sets the dwell type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CycleDwell NXOpen.CAM.Cycle.DwellAtDepth

get

Returns the dwell at depth

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleDwell NXOpen.CAM.Cycle.DwellAtFinalDepth

get

Returns the dwell at final depth

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleDwell NXOpen.CAM.Cycle.DwellAtStartPoint

get

Returns the dwell at start point of phase

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleDwell NXOpen.CAM.Cycle.DwellBeforeCut

get

Returns the dwell before cut

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleDwell NXOpen.CAM.Cycle.DwellBeforeEngage

get

Returns the dwell before engage

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleDwell NXOpen.CAM.Cycle.DwellBeforeRetract

get

Returns the dwell before retract

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.Cycle.DwellType NXOpen.CAM.Cycle.DwellFinal

getset

Returns or sets the dwell final type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.DwellFinalValue

getset

Returns or sets the dwell final value

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.Cycle.DwellType NXOpen.CAM.Cycle.DwellStart

getset

Returns or sets the dwell start type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.DwellStartValue

getset

Returns or sets the dwell start value

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.DwellValue

getset

Returns or sets the dwell value

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.EntranceDiameter

getset

Returns or sets the entrance diameter

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.Cycle.CutMode NXOpen.CAM.Cycle.FirstCutMode

getset

Returns or sets the first cut mode type

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.FirstCutValue

getset

Returns or sets the the first cut value

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.Cycle.CutMode NXOpen.CAM.Cycle.LastCutMode

getset

Returns or sets the last cut mode type

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.LastCutValue

getset

Returns or sets the the last cut value

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.Cycle.MotionOutputTypes NXOpen.CAM.Cycle.MotionOutput

getset

Returns or sets the motion output

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CycleNodragClearance NXOpen.CAM.Cycle.NodragClearance

get

Returns the nodrag clearance

Created in NX11.0.0

License requirements: None.

unsafe bool NXOpen.CAM.Cycle.Option

getset

Returns or sets the option type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.Orientation

getset

Returns or sets the orientation

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe bool NXOpen.CAM.Cycle.OrientationStatus

getset

Returns or sets the orientation status

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe double NXOpen.CAM.Cycle.Shift

getset

Returns or sets the shift

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe bool NXOpen.CAM.Cycle.ShiftStatus

getset

Returns or sets the shift status

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CycleSpindle NXOpen.CAM.Cycle.SpindleBeforeEngage

get

Returns the spindle before engage

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.CAM.CycleSpindle NXOpen.CAM.Cycle.SpindleBeforeRetract

get

Returns the spindle before retract

Created in NX10.0.2

License requirements: None.

unsafe double NXOpen.CAM.Cycle.StepClearance

getset

Returns or sets the step clearance

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe bool NXOpen.CAM.Cycle.StepClearanceStatus

getset

Returns or sets the step clearance status

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CycleStepRetract NXOpen.CAM.Cycle.StepRetract

get

Returns the step retract

Created in NX10.0.2

License requirements: None.

unsafe string NXOpen.CAM.Cycle.Text

getset

Returns or sets the text

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe int NXOpen.CAM.Cycle.Times

getset

Returns or sets the times

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe bool NXOpen.CAM.Cycle.TimesStatus

getset

Returns or sets the times status

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CycleTipRelease NXOpen.CAM.Cycle.TipRelease

get

Returns the (minimal) tip release

Created in NX10.0.2

License requirements: None.

---

The documentation for this class was generated from the following file:

• CAM_Cycle.cs