Represets a User Defined Event
Created in NX9.0.0. More...

Inheritance diagram for NXOpen::CAM::Cycle:

Public Types
enum	CutMode { CutModeOff, CutModeValue, CutModePercentage }
	Available types for fixed cut. More...

enum	DwellType { DwellTypeOn, DwellTypeOff, DwellTypeSeconds, DwellTypeRevolutions }
	Available types for dwell. More...

enum	MotionOutputTypes { MotionOutputTypesMachineCycle, MotionOutputTypesSingleMoves, MotionOutputTypesInterruptedMoves }
	Available types for motion output. More...

Public Member Functions
NXOpen::CAM::StepoverBuilder *	AxialStepover ()
	Returns the axial stepover Created in NX9.0.0. More...

bool	CamStatus ()
	Returns the cam status Created in NX9.0.0. More...

int	CamValue ()
	Returns the cam value Created in NX9.0.0. More...

NXOpen::CAM::CycleCoolant *	CoolantBeforeCut ()
	Returns the coolant Created in NX10.0.2. More...

NXOpen::CAM::CycleCoolant *	CoolantBeforeEngage ()
	Returns the coolant Created in NX10.0.2. More...

NXOpen::CAM::CycleCoolant *	CoolantBeforeRetract ()
	Returns the coolant Created in NX10.0.2. More...

double	CsinkDiameter ()
	Returns the csink diameter Created in NX9.0.0. More...

NXString	CycleTrackingPoint ()
	Returns the tracking point Created in NX9.0.2. More...

NXString	CycleType ()
	Returns the cycle type Created in NX9.0.0. More...

NXOpen::CAM::Cycle::DwellType	Dwell ()
	Returns the dwell type Created in NX9.0.0. More...

NXOpen::CAM::CycleDwell *	DwellAtDepth ()
	Returns the dwell at depth Created in NX10.0.2. More...

NXOpen::CAM::CycleDwell *	DwellAtFinalDepth ()
	Returns the dwell at final depth Created in NX10.0.2. More...

NXOpen::CAM::CycleDwell *	DwellAtStartPoint ()
	Returns the dwell at start point of phase Created in NX10.0.2. More...

NXOpen::CAM::CycleDwell *	DwellBeforeCut ()
	Returns the dwell before cut Created in NX10.0.2. More...

NXOpen::CAM::CycleDwell *	DwellBeforeEngage ()
	Returns the dwell before engage Created in NX10.0.2. More...

NXOpen::CAM::CycleDwell *	DwellBeforeRetract ()
	Returns the dwell before retract Created in NX10.0.2. More...

NXOpen::CAM::Cycle::DwellType	DwellFinal ()
	Returns the dwell final type Created in NX9.0.0. More...

double	DwellFinalValue ()
	Returns the dwell final value Created in NX9.0.0. More...

NXOpen::CAM::Cycle::DwellType	DwellStart ()
	Returns the dwell start type Created in NX9.0.0. More...

double	DwellStartValue ()
	Returns the dwell start value Created in NX9.0.0. More...

double	DwellValue ()
	Returns the dwell value Created in NX9.0.0. More...

double	EntranceDiameter ()
	Returns the entrance diameter Created in NX9.0.0. More...

NXOpen::CAM::Cycle::CutMode	FirstCutMode ()
	Returns the first cut mode type Created in NX9.0.3. More...

double	FirstCutValue ()
	Returns the the first cut value Created in NX9.0.3. More...

bool	GetBooleanValue (const NXString &cycleParamName)
	Get the boolean value of the parameter. More...

bool	GetBooleanValue (const char *cycleParamName)
	Get the boolean value of the parameter. More...

double	GetDoubleValue (const NXString &cycleParamName)
	Get the double value of the parameter. More...

double	GetDoubleValue (const char *cycleParamName)
	Get the double value of the parameter. More...

int	GetIntegerValue (const NXString &cycleParamName)
	Get the integer value of the parameter. More...

int	GetIntegerValue (const char *cycleParamName)
	Get the integer value of the parameter. More...

bool	GetParameterActive (const NXString &cycleParamName)
	Check if parameter is active. More...

bool	GetParameterActive (const char *cycleParamName)
	Check if parameter is active. More...

NXOpen::Point3d	GetPointValue (const NXString &cycleParamName)
	Get the point of the parameter. More...

NXOpen::Point3d	GetPointValue (const char *cycleParamName)
	Get the point of the parameter. More...

NXString	GetStringValue (const NXString &cycleParamName)
	Get the string value of the parameter. More...

NXString	GetStringValue (const char *cycleParamName)
	Get the string value of the parameter. More...

NXOpen::Vector3d	GetVectorValue (const NXString &cycleParamName)
	Get the vector of the parameter. More...

NXOpen::Vector3d	GetVectorValue (const char *cycleParamName)
	Get the vector of the parameter. More...

NXOpen::CAM::Cycle::CutMode	LastCutMode ()
	Returns the last cut mode type Created in NX9.0.3. More...

double	LastCutValue ()
	Returns the the last cut value Created in NX9.0.3. More...

NXOpen::CAM::Cycle::MotionOutputTypes	MotionOutput ()
	Returns the motion output Created in NX9.0.0. More...

NXOpen::CAM::CycleNodragClearance *	NodragClearance ()
	Returns the nodrag clearance Created in NX11.0.0. More...

bool	Option ()
	Returns the option type Created in NX9.0.0. More...

double	Orientation ()
	Returns the orientation Created in NX9.0.0. More...

bool	OrientationStatus ()
	Returns the orientation status Created in NX9.0.0. More...

void	SetBooleanValue (const NXString &cycleParamName, bool booleanValue)
	Set the boolean value of the parameter Created in NX9.0.0. More...

void	SetBooleanValue (const char *cycleParamName, bool booleanValue)
	Set the boolean value of the parameter Created in NX9.0.0. More...

void	SetCamStatus (bool camStatus)
	Sets the cam status Created in NX9.0.0. More...

void	SetCamValue (int doubleValue)
	Sets the cam value Created in NX9.0.0. More...

void	SetCsinkDiameter (double doubleValue)
	Sets the csink diameter Created in NX9.0.0. More...

void	SetCycleTrackingPoint (const NXString &cText)
	Sets the tracking point Created in NX9.0.2. More...

void	SetCycleTrackingPoint (const char *cText)
	Sets the tracking point Created in NX9.0.2. More...

void	SetCycleType (const NXString &cycleName)
	Sets the cycle type Created in NX9.0.0. More...

void	SetCycleType (const char *cycleName)
	Sets the cycle type Created in NX9.0.0. More...

void	SetDoubleValue (const NXString &cycleParamName, double doubleValue)
	Set the double value of the parameter Created in NX9.0.0. More...

void	SetDoubleValue (const char *cycleParamName, double doubleValue)
	Set the double value of the parameter Created in NX9.0.0. More...

void	SetDwell (NXOpen::CAM::Cycle::DwellType dwell)
	Sets the dwell type Created in NX9.0.0. More...

void	SetDwellFinal (NXOpen::CAM::Cycle::DwellType dwell)
	Sets the dwell final type Created in NX9.0.0. More...

void	SetDwellFinalValue (double doubleValue)
	Sets the dwell final value Created in NX9.0.0. More...

void	SetDwellStart (NXOpen::CAM::Cycle::DwellType dwell)
	Sets the dwell start type Created in NX9.0.0. More...

void	SetDwellStartValue (double doubleValue)
	Sets the dwell start value Created in NX9.0.0. More...

void	SetDwellValue (double doubleValue)
	Sets the dwell value Created in NX9.0.0. More...

void	SetEntranceDiameter (double doubleValue)
	Sets the entrance diameter Created in NX9.0.0. More...

void	SetFirstCutMode (NXOpen::CAM::Cycle::CutMode firstCutMode)
	Sets the first cut mode type Created in NX9.0.3. More...

void	SetFirstCutValue (double doubleValue)
	Sets the the first cut value Created in NX9.0.3. More...

void	SetIntegerValue (const NXString &cycleParamName, int integerValue)
	Set the integer value of the parameter Created in NX9.0.0. More...

void	SetIntegerValue (const char *cycleParamName, int integerValue)
	Set the integer value of the parameter Created in NX9.0.0. More...

void	SetLastCutMode (NXOpen::CAM::Cycle::CutMode lastCutMode)
	Sets the last cut mode type Created in NX9.0.3. More...

void	SetLastCutValue (double doubleValue)
	Sets the the last cut value Created in NX9.0.3. More...

void	SetMotionOutput (NXOpen::CAM::Cycle::MotionOutputTypes newValue)
	Sets the motion output Created in NX9.0.0. More...

void	SetOption (bool optionType)
	Sets the option type Created in NX9.0.0. More...

void	SetOrientation (double orientation)
	Sets the orientation Created in NX9.0.0. More...

void	SetOrientationStatus (bool oStatus)
	Sets the orientation status Created in NX9.0.0. More...

void	SetParameterActive (const NXString &cycleParamName, bool parameterActive)
	To Set if parameter is active Created in NX9.0.0. More...

void	SetParameterActive (const char *cycleParamName, bool parameterActive)
	To Set if parameter is active Created in NX9.0.0. More...

void	SetPointValue (const NXString &cycleParamName, const NXOpen::Point3d &point)
	Set the point of the parameter Created in NX9.0.0. More...

void	SetPointValue (const char *cycleParamName, const NXOpen::Point3d &point)
	Set the point of the parameter Created in NX9.0.0. More...

void	SetShift (double doubleValue)
	Sets the shift Created in NX9.0.0. More...

void	SetShiftStatus (bool camStatus)
	Sets the shift status Created in NX9.0.0. More...

void	SetStepClearance (double doubleValue)
	Sets the step clearance Created in NX9.0.0. More...

void	SetStepClearanceStatus (bool camStatus)
	Sets the step clearance status Created in NX9.0.0. More...

void	SetStringValue (const NXString &cycleParamName, const NXString &stringValue)
	Set the string value of the parameter Created in NX9.0.0. More...

void	SetStringValue (const char cycleParamName, const char stringValue)
	Set the string value of the parameter Created in NX9.0.0. More...

void	SetText (const NXString &cText)
	Sets the text Created in NX9.0.0. More...

void	SetText (const char *cText)
	Sets the text Created in NX9.0.0. More...

void	SetTimes (int times)
	Sets the times Created in NX9.0.0. More...

void	SetTimesStatus (bool camStatus)
	Sets the times status Created in NX9.0.0. More...

void	SetVectorValue (const NXString &cycleParamName, const NXOpen::Vector3d &vector)
	Set the vector of the parameter Created in NX9.0.0. More...

void	SetVectorValue (const char *cycleParamName, const NXOpen::Vector3d &vector)
	Set the vector of the parameter Created in NX9.0.0. More...

double	Shift ()
	Returns the shift Created in NX9.0.0. More...

bool	ShiftStatus ()
	Returns the shift status Created in NX9.0.0. More...

NXOpen::CAM::CycleSpindle *	SpindleBeforeEngage ()
	Returns the spindle before engage Created in NX10.0.2. More...

NXOpen::CAM::CycleSpindle *	SpindleBeforeRetract ()
	Returns the spindle before retract Created in NX10.0.2. More...

double	StepClearance ()
	Returns the step clearance Created in NX9.0.0. More...

bool	StepClearanceStatus ()
	Returns the step clearance status Created in NX9.0.0. More...

NXOpen::CAM::CycleStepRetract *	StepRetract ()
	Returns the step retract Created in NX10.0.2. More...

NXString	Text ()
	Returns the text Created in NX9.0.0. More...

int	Times ()
	Returns the times Created in NX9.0.0. More...

bool	TimesStatus ()
	Returns the times status Created in NX9.0.0. More...

NXOpen::CAM::CycleTipRelease *	TipRelease ()
	Returns the (minimal) tip release Created in NX10.0.2. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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
CutModeOff	fixed cut distance off
CutModeValue	fixed cut distance by value
CutModePercentage	fixed cut distance by percentage of tool diameter

enum NXOpen::CAM::Cycle::DwellType

Available types for dwell.

Enumerator
DwellTypeOn	dwell on
DwellTypeOff	dwell off
DwellTypeSeconds	dwell seconds
DwellTypeRevolutions	dwell revolutions

enum NXOpen::CAM::Cycle::MotionOutputTypes

Available types for motion output.

Enumerator
MotionOutputTypesMachineCycle	Machine Cycle.
MotionOutputTypesSingleMoves	single moves
MotionOutputTypesInterruptedMoves	interrupted moves

Member Function Documentation

NXOpen::CAM::StepoverBuilder* NXOpen::CAM::Cycle::AxialStepover ( )

Returns the axial stepover
Created in NX9.0.0.

License requirements : None

bool NXOpen::CAM::Cycle::CamStatus ( )

Returns the cam status
Created in NX9.0.0.

License requirements : None

int NXOpen::CAM::Cycle::CamValue ( )

Returns the cam value
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::CycleCoolant* NXOpen::CAM::Cycle::CoolantBeforeCut ( )

Returns the coolant
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleCoolant* NXOpen::CAM::Cycle::CoolantBeforeEngage ( )

Returns the coolant
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleCoolant* NXOpen::CAM::Cycle::CoolantBeforeRetract ( )

Returns the coolant
Created in NX10.0.2.

License requirements : None

double NXOpen::CAM::Cycle::CsinkDiameter ( )

Returns the csink diameter
Created in NX9.0.0.

License requirements : None

NXString NXOpen::CAM::Cycle::CycleTrackingPoint ( )

Returns the tracking point
Created in NX9.0.2.

License requirements : None

NXString NXOpen::CAM::Cycle::CycleType ( )

Returns the cycle type
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::Cycle::DwellType NXOpen::CAM::Cycle::Dwell ( )

Returns the dwell type
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::CycleDwell* NXOpen::CAM::Cycle::DwellAtDepth ( )

Returns the dwell at depth
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleDwell* NXOpen::CAM::Cycle::DwellAtFinalDepth ( )

Returns the dwell at final depth
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleDwell* NXOpen::CAM::Cycle::DwellAtStartPoint ( )

Returns the dwell at start point of phase
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleDwell* NXOpen::CAM::Cycle::DwellBeforeCut ( )

Returns the dwell before cut
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleDwell* NXOpen::CAM::Cycle::DwellBeforeEngage ( )

Returns the dwell before engage
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::CycleDwell* NXOpen::CAM::Cycle::DwellBeforeRetract ( )

Returns the dwell before retract
Created in NX10.0.2.

License requirements : None

NXOpen::CAM::Cycle::DwellType NXOpen::CAM::Cycle::DwellFinal ( )

Returns the dwell final type
Created in NX9.0.0.

License requirements : None

double NXOpen::CAM::Cycle::DwellFinalValue ( )

Returns the dwell final value
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::Cycle::DwellType NXOpen::CAM::Cycle::DwellStart ( )

Returns the dwell start type
Created in NX9.0.0.

License requirements : None

double NXOpen::CAM::Cycle::DwellStartValue ( )

Returns the dwell start value
Created in NX9.0.0.

License requirements : None

double NXOpen::CAM::Cycle::DwellValue ( )

Returns the dwell value
Created in NX9.0.0.

License requirements : None

double NXOpen::CAM::Cycle::EntranceDiameter ( )

Returns the entrance diameter
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::Cycle::CutMode NXOpen::CAM::Cycle::FirstCutMode ( )

Returns the first cut mode type
Created in NX9.0.3.

License requirements : None

double NXOpen::CAM::Cycle::FirstCutValue ( )

Returns the the first cut value
Created in NX9.0.3.

License requirements : None

bool NXOpen::CAM::Cycle::GetBooleanValue ( const NXString & cycleParamName )

Get the boolean value of the parameter.

Returns: boolean value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

bool NXOpen::CAM::Cycle::GetBooleanValue ( const char * cycleParamName )

Get the boolean value of the parameter.

Returns: boolean value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

double NXOpen::CAM::Cycle::GetDoubleValue ( const NXString & cycleParamName )

Get the double value of the parameter.

Returns: double value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

double NXOpen::CAM::Cycle::GetDoubleValue ( const char * cycleParamName )

Get the double value of the parameter.

Returns: double value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

int NXOpen::CAM::Cycle::GetIntegerValue ( const NXString & cycleParamName )

Get the integer value of the parameter.

Returns: integer value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

int NXOpen::CAM::Cycle::GetIntegerValue ( const char * cycleParamName )

Get the integer value of the parameter.

Returns: integer value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

bool NXOpen::CAM::Cycle::GetParameterActive ( const NXString & cycleParamName )

Check if parameter is active.

Returns: if the parameter is active
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

bool NXOpen::CAM::Cycle::GetParameterActive ( const char * cycleParamName )

Check if parameter is active.

Returns: if the parameter is active
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

NXOpen::Point3d NXOpen::CAM::Cycle::GetPointValue ( const NXString & cycleParamName )

Get the point of the parameter.

Returns: Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

cycleParamName the name of the parameter

NXOpen::Point3d NXOpen::CAM::Cycle::GetPointValue ( const char * cycleParamName )

Get the point of the parameter.

Returns: Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

cycleParamName the name of the parameter

NXString NXOpen::CAM::Cycle::GetStringValue ( const NXString & cycleParamName )

Get the string value of the parameter.

Returns: string value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

NXString NXOpen::CAM::Cycle::GetStringValue ( const char * cycleParamName )

Get the string value of the parameter.

Returns: string value of parameter
Created in NX9.0.0.

License requirements : None

Parameters

cycleParamName the name of the parameter

NXOpen::Vector3d NXOpen::CAM::Cycle::GetVectorValue ( const NXString & cycleParamName )

Get the vector of the parameter.

Returns: Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

cycleParamName the name of the parameter

NXOpen::Vector3d NXOpen::CAM::Cycle::GetVectorValue ( const char * cycleParamName )

Get the vector of the parameter.

Returns: Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

cycleParamName the name of the parameter

NXOpen::CAM::Cycle::CutMode NXOpen::CAM::Cycle::LastCutMode ( )

Returns the last cut mode type
Created in NX9.0.3.

License requirements : None

double NXOpen::CAM::Cycle::LastCutValue ( )

Returns the the last cut value
Created in NX9.0.3.

License requirements : None

NXOpen::CAM::Cycle::MotionOutputTypes NXOpen::CAM::Cycle::MotionOutput ( )

Returns the motion output
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::CycleNodragClearance* NXOpen::CAM::Cycle::NodragClearance ( )

Returns the nodrag clearance
Created in NX11.0.0.

License requirements : None

bool NXOpen::CAM::Cycle::Option ( )

Returns the option type
Created in NX9.0.0.

License requirements : None

double NXOpen::CAM::Cycle::Orientation ( )

Returns the orientation
Created in NX9.0.0.

License requirements : None

bool NXOpen::CAM::Cycle::OrientationStatus ( )

Returns the orientation status
Created in NX9.0.0.

License requirements : None

void NXOpen::CAM::Cycle::SetBooleanValue	(	const NXString &	cycleParamName,
		bool	booleanValue
	)

Set the boolean value of the parameter
Created in NX9.0.0.