NXOpen::CAM::TurnAvoidancePathPointsBuilder Class Reference

Represents a turn avoidance path points builder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::TurnAvoidancePathPointsBuilder:

Public Types
enum	CsTypes { CsTypesWcs, CsTypesMcs }
	the cs modes Created in NX6.0.0. More...
enum	CustomFeedrateUnitTypes { CustomFeedrateUnitTypesNone, CustomFeedrateUnitTypesIpmOrMmpm, CustomFeedrateUnitTypesIprOrMmpr }
	the custom feed rate unit options Created in NX6.0.0. More...
enum	FeedrateModesTypes {   FeedrateModesTypesRapid, FeedrateModesTypesApproachOrDepature, FeedrateModesTypesEngageOrReturn, FeedrateModesTypesCut,   FeedrateModesTypesCustom }
	the feed rate type options Created in NX6.0.0. More...
enum	MotionTypes { MotionTypesAutomatic, MotionTypesDirect, MotionTypesRadialThenAxial, MotionTypesAxialThenRadial }
	the motion to point type options Created in NX6.0.0. More...
enum	PointStatus { PointStatusInactive, PointStatusActive }
	the point status options Created in NX6.0.2. More...

Public Member Functions
NXOpen::CAM::TurnAvoidancePathPointsBuilder::CsTypes	CsMode ()
	Returns the cs mode Created in NX6.0.0.
void	Delete (int index)
	Delete an existing avoidance path point Created in NX6.0.0.
void	GetPointData (int index, NXOpen::NXObject **specifyPoint, NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes *motionType, NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes *feedrateType, double *customFeedrateValue, NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes *customFeedrateUnit, NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus *pointStatus, int *startEventFlag, NXOpen::NXObject **startEventPath, int *endEventFlag, NXOpen::NXObject **endEventPath)
	Get the values of an existing avoidance path point Created in NX6.0.2.
void	GetPointListData (int index, NXOpen::NXObject **specifyPoint, NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes *motionType, NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes *feedrateType, double *customFeedrateValue, NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes *customFeedrateUnit)
	Get the values of an existing avoidance path point Created in NX6.0.0.
void	Modify (int index, NXOpen::NXObject *specifyPoint, NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes motionType, NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes feedrateType, double customFeedrateValue, NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes customFeedrateUnit)
	Modify an existing avoidance path point,name maybe changed if not unique Created in NX6.0.0.
void	ModifyData (int index, NXOpen::NXObject *specifyPoint, NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes motionType, NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes feedrateType, double customFeedrateValue, NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes customFeedrateUnit, NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus pointStatus, int startEventFlag, NXOpen::NXObject *startEventPath, int endEventFlag, NXOpen::NXObject *endEventPath)
	Modify an existing avoidance path point,name maybe changed if not unique Created in NX6.0.2.
void	MoveDown (int index)
	Move down a avoidance path point Created in NX6.0.0.
void	MoveUp (int index)
	Move up a avoidance path point Created in NX6.0.0.
int	PointListDataNumberOfTrackPoints ()
	Returns the number of avoidance path points Created in NX6.0.0.
void	SetCsMode (NXOpen::CAM::TurnAvoidancePathPointsBuilder::CsTypes csMode)
	Sets the cs mode Created in NX6.0.0.
void	SetPointData (int index, NXOpen::NXObject *specifyPoint, NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes motionType, NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes feedrateType, double customFeedrateValue, NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes customFeedrateUnit, NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus pointStatus, int startEventFlag, NXOpen::NXObject *startEventPath, int endEventFlag, NXOpen::NXObject *endEventPath)
	Create a new avoidance path point, name maybe changed if not unique.
void	SetPointListData (int index, NXOpen::NXObject *specifyPoint, NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes motionType, NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes feedrateType, double customFeedrateValue, NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes customFeedrateUnit)
	Create a new avoidance path point, name maybe changed if not unique Created in NX6.0.0.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a turn avoidance path points builder
Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::TurnAvoidancePathPointsBuilder::CsTypes

the cs modes
Created in NX6.0.0.

Enumerator:

CsTypesWcs	WCS.
CsTypesMcs	MCS.

enum NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes

the custom feed rate unit options
Created in NX6.0.0.

Enumerator:

CustomFeedrateUnitTypesNone	Feed Rate: Automatic.
CustomFeedrateUnitTypesIpmOrMmpm	Feed Rate: Direct.
CustomFeedrateUnitTypesIprOrMmpr	Feed Rate: Radial then Axial.

enum NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes

the feed rate type options
Created in NX6.0.0.

Enumerator:

FeedrateModesTypesRapid	Feed Rate: Automatic.
FeedrateModesTypesApproachOrDepature	Feed Rate: Direct.
FeedrateModesTypesEngageOrReturn	Feed Rate: Radial then Axial.
FeedrateModesTypesCut	Feed Rate: Axial then Radial.
FeedrateModesTypesCustom	Feed Rate: Axial then Radial.

enum NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes

the motion to point type options
Created in NX6.0.0.

Enumerator:

MotionTypesAutomatic	Motion to Point: Automatic.
MotionTypesDirect	Motion to Point: Direct.
MotionTypesRadialThenAxial	Motion to Point: Radial then Axial.
MotionTypesAxialThenRadial	Motion to Point: Axial then Radial.

enum NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus

the point status options
Created in NX6.0.2.

Enumerator:

PointStatusInactive	Point Status: Inactive.
PointStatusActive	Point Status: Active.

Member Function Documentation

NXOpen::CAM::TurnAvoidancePathPointsBuilder::CsTypes NXOpen::CAM::TurnAvoidancePathPointsBuilder::CsMode

(

)

Returns the cs mode
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::Delete

(

int

index

)

Delete an existing avoidance path point
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

index

the index of deleted avoidance path point

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::GetPointData	(	int	index,
		NXOpen::NXObject **	specifyPoint,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes *	motionType,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes *	feedrateType,
		double *	customFeedrateValue,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes *	customFeedrateUnit,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus *	pointStatus,
		int *	startEventFlag,
		NXOpen::NXObject **	startEventPath,
		int *	endEventFlag,
		NXOpen::NXObject **	endEventPath
	)

Get the values of an existing avoidance path point
Created in NX6.0.2.

License requirements : None

Parameters

index	the index of avoidance path point
specifyPoint	selected point
motionType	the motionTypeColumn
feedrateType	the feedrate Type
customFeedrateValue	the feedrateColumn
customFeedrateUnit	the feedrateUnitColumn
pointStatus	the point status
startEventFlag	the start event status
startEventPath	the start event path
endEventFlag	the end event status
endEventPath	the end event path

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::GetPointListData	(	int	index,
		NXOpen::NXObject **	specifyPoint,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes *	motionType,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes *	feedrateType,
		double *	customFeedrateValue,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes *	customFeedrateUnit
	)

Get the values of an existing avoidance path point
Created in NX6.0.0.

License requirements : None

Parameters

index	the index of avoidance path point
specifyPoint	selected point
motionType	the motionTypeColumn
feedrateType	the feedrate Type
customFeedrateValue	the feedrateColumn
customFeedrateUnit	the feedrateUnitColumn

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::Modify	(	int	index,
		NXOpen::NXObject *	specifyPoint,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes	motionType,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes	feedrateType,
		double	customFeedrateValue,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes	customFeedrateUnit
	)

Modify an existing avoidance path point,name maybe changed if not unique
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

index	the index of modified avoidance path point
specifyPoint	selected point
motionType	the motionTypeColumn
feedrateType	the feedrate Type
customFeedrateValue	the feedrateColumn
customFeedrateUnit	the feedrateUnitColumn

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::ModifyData	(	int	index,
		NXOpen::NXObject *	specifyPoint,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes	motionType,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes	feedrateType,
		double	customFeedrateValue,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes	customFeedrateUnit,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus	pointStatus,
		int	startEventFlag,
		NXOpen::NXObject *	startEventPath,
		int	endEventFlag,
		NXOpen::NXObject *	endEventPath
	)

Modify an existing avoidance path point,name maybe changed if not unique
Created in NX6.0.2.

License requirements : cam_base ("CAM BASE")

Parameters

index	the index of modified avoidance path point
specifyPoint	selected point
motionType	the motionTypeColumn
feedrateType	the feedrate Type
customFeedrateValue	the feedrateColumn
customFeedrateUnit	the feedrateUnitColumn
pointStatus	the point status
startEventFlag	the start event status
startEventPath	the start event path
endEventFlag	the end event status
endEventPath	the end event path

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::MoveDown

(

int

index

)

Move down a avoidance path point
Created in NX6.0.0.

License requirements : None

Parameters

index

the index of item which should be moved down

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::MoveUp

(

int

index

)

Move up a avoidance path point
Created in NX6.0.0.

License requirements : None

Parameters

index

the index of item which should be moved up

int NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointListDataNumberOfTrackPoints

(

)

Returns the number of avoidance path points
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::SetCsMode

(

NXOpen::CAM::TurnAvoidancePathPointsBuilder::CsTypes

csMode

)

Sets the cs mode
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

csMode

the cs mode value

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::SetPointData	(	int	index,
		NXOpen::NXObject *	specifyPoint,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes	motionType,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes	feedrateType,
		double	customFeedrateValue,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes	customFeedrateUnit,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::PointStatus	pointStatus,
		int	startEventFlag,
		NXOpen::NXObject *	startEventPath,
		int	endEventFlag,
		NXOpen::NXObject *	endEventPath
	)

Create a new avoidance path point, name maybe changed if not unique.

Created in NX6.0.2.

License requirements : cam_base ("CAM BASE")

Parameters

index	the index which new avoidance path point will be added after
specifyPoint	selected point
motionType	the motionTypeColumn
feedrateType	the feedrate Type
customFeedrateValue	the feedrateColumn
customFeedrateUnit	the feedrateUnitColumn
pointStatus	the point status
startEventFlag	the start event status
startEventPath	the start event path
endEventFlag	the end event status
endEventPath	the end event path

void NXOpen::CAM::TurnAvoidancePathPointsBuilder::SetPointListData	(	int	index,
		NXOpen::NXObject *	specifyPoint,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::MotionTypes	motionType,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::FeedrateModesTypes	feedrateType,
		double	customFeedrateValue,
		NXOpen::CAM::TurnAvoidancePathPointsBuilder::CustomFeedrateUnitTypes	customFeedrateUnit
	)

Create a new avoidance path point, name maybe changed if not unique
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

index	the index which new avoidance path point will be added after
specifyPoint	selected point
motionType	the motionTypeColumn
feedrateType	the feedrate Type
customFeedrateValue	the feedrateColumn
customFeedrateUnit	the feedrateUnitColumn

---

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

• CAM_TurnAvoidancePathPointsBuilder.hxx