Properties¶
Property | Description |
---|---|
CsMode | Returns or sets the cs mode |
PointListDataNumberOfTrackPoints | Returns the number of avoidance path points |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Delete | Delete an existing avoidance path point |
GetPointData | Get the values of an existing avoidance path point |
GetPointListData | Get the values of an existing avoidance path point |
Modify | Modify an existing avoidance path point,name maybe changed if not unique |
ModifyData | Modify an existing avoidance path point,name maybe changed if not unique |
MoveDown | Move down a avoidance path point |
MoveUp | Move up a avoidance path point |
SetPointData | Create a new avoidance path point, name maybe changed if not unique. |
SetPointListData | Create a new avoidance path point, name maybe changed if not unique |
Enumerations¶
TurnAvoidancePathPointsBuilderCsTypes Enumeration | the cs modes |
TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes Enumeration | the custom feed rate unit options |
TurnAvoidancePathPointsBuilderFeedrateModesTypes Enumeration | the feed rate type options |
TurnAvoidancePathPointsBuilderMotionTypes Enumeration | the motion to point type options |
TurnAvoidancePathPointsBuilderPointStatus Enumeration | the point status options |
Property Detail¶
CsMode¶
-
TurnAvoidancePathPointsBuilder.
CsMode
¶ Returns or sets the cs mode
-------------------------------------
Getter Method
Signature
CsMode()
Returns: the cs mode value Return type: NXOpen.CAM.TurnAvoidancePathPointsBuilderCsTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CsMode(csMode)
Parameters: csMode ( NXOpen.CAM.TurnAvoidancePathPointsBuilderCsTypes
) – the cs mode valueNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
PointListDataNumberOfTrackPoints¶
-
TurnAvoidancePathPointsBuilder.
PointListDataNumberOfTrackPoints
¶ Returns the number of avoidance path points
-------------------------------------
Getter Method
Signature
PointListDataNumberOfTrackPoints()
Returns: the number of points Return type: int New in version NX6.0.0.
License requirements: None.
Method Detail¶
Delete¶
-
TurnAvoidancePathPointsBuilder.
Delete
¶ Delete an existing avoidance path point
Signature
Delete(index)
Parameters: index (int) – the index of deleted avoidance path point New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
GetPointData¶
-
TurnAvoidancePathPointsBuilder.
GetPointData
¶ Get the values of an existing avoidance path point
Signature
GetPointData(index)
Parameters: index (int) – the index of avoidance path point Returns: a tuple Return type: A tuple consisting of (specifyPoint, motionType, feedrateType, customFeedrateValue, customFeedrateUnit, pointStatus, startEventFlag, startEventPath, endEventFlag, endEventPath). specifyPoint is a NXOpen.NXObject
. selected point motionType is aNXOpen.CAM.TurnAvoidancePathPointsBuilderMotionTypes
. the motionTypeColumn feedrateType is aNXOpen.CAM.TurnAvoidancePathPointsBuilderFeedrateModesTypes
. the feedrate Type customFeedrateValue is a float. the feedrateColumn customFeedrateUnit is aNXOpen.CAM.TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes
. the feedrateUnitColumn pointStatus is aNXOpen.CAM.TurnAvoidancePathPointsBuilderPointStatus
. the point status startEventFlag is a int. the start event status startEventPath is aNXOpen.NXObject
. the start event path endEventFlag is a int. the end event status endEventPath is aNXOpen.NXObject
. the end event pathNew in version NX6.0.2.
License requirements: None.
GetPointListData¶
-
TurnAvoidancePathPointsBuilder.
GetPointListData
¶ Get the values of an existing avoidance path point
Signature
GetPointListData(index)
Parameters: index (int) – the index of avoidance path point Returns: a tuple Return type: A tuple consisting of (specifyPoint, motionType, feedrateType, customFeedrateValue, customFeedrateUnit). specifyPoint is a NXOpen.NXObject
. selected point motionType is aNXOpen.CAM.TurnAvoidancePathPointsBuilderMotionTypes
. the motionTypeColumn feedrateType is aNXOpen.CAM.TurnAvoidancePathPointsBuilderFeedrateModesTypes
. the feedrate Type customFeedrateValue is a float. the feedrateColumn customFeedrateUnit is aNXOpen.CAM.TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes
. the feedrateUnitColumnNew in version NX6.0.0.
License requirements: None.
Modify¶
-
TurnAvoidancePathPointsBuilder.
Modify
¶ Modify an existing avoidance path point,name maybe changed if not unique
Signature
Modify(index, specifyPoint, motionType, feedrateType, customFeedrateValue, customFeedrateUnit)
Parameters: - index (int) – the index of modified avoidance path point
- specifyPoint (
NXOpen.NXObject
) – selected point - motionType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderMotionTypes
) – the motionTypeColumn - feedrateType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderFeedrateModesTypes
) – the feedrate Type - customFeedrateValue (float) – the feedrateColumn
- customFeedrateUnit (
NXOpen.CAM.TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes
) – the feedrateUnitColumn
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
ModifyData¶
-
TurnAvoidancePathPointsBuilder.
ModifyData
¶ Modify an existing avoidance path point,name maybe changed if not unique
Signature
ModifyData(index, specifyPoint, motionType, feedrateType, customFeedrateValue, customFeedrateUnit, pointStatus, startEventFlag, startEventPath, endEventFlag, endEventPath)
Parameters: - index (int) – the index of modified avoidance path point
- specifyPoint (
NXOpen.NXObject
) – selected point - motionType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderMotionTypes
) – the motionTypeColumn - feedrateType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderFeedrateModesTypes
) – the feedrate Type - customFeedrateValue (float) – the feedrateColumn
- customFeedrateUnit (
NXOpen.CAM.TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes
) – the feedrateUnitColumn - pointStatus (
NXOpen.CAM.TurnAvoidancePathPointsBuilderPointStatus
) – the point status - startEventFlag (int) – the start event status
- startEventPath (
NXOpen.NXObject
) – the start event path - endEventFlag (int) – the end event status
- endEventPath (
NXOpen.NXObject
) – the end event path
New in version NX6.0.2.
License requirements: cam_base (“CAM BASE”)
MoveDown¶
-
TurnAvoidancePathPointsBuilder.
MoveDown
¶ Move down a avoidance path point
Signature
MoveDown(index)
Parameters: index (int) – the index of item which should be moved down New in version NX6.0.0.
License requirements: None.
MoveUp¶
-
TurnAvoidancePathPointsBuilder.
MoveUp
¶ Move up a avoidance path point
Signature
MoveUp(index)
Parameters: index (int) – the index of item which should be moved up New in version NX6.0.0.
License requirements: None.
SetPointData¶
-
TurnAvoidancePathPointsBuilder.
SetPointData
¶ Create a new avoidance path point, name maybe changed if not unique.
Signature
SetPointData(index, specifyPoint, motionType, feedrateType, customFeedrateValue, customFeedrateUnit, pointStatus, startEventFlag, startEventPath, endEventFlag, endEventPath)
Parameters: - index (int) – the index which new avoidance path point will be added after
- specifyPoint (
NXOpen.NXObject
) – selected point - motionType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderMotionTypes
) – the motionTypeColumn - feedrateType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderFeedrateModesTypes
) – the feedrate Type - customFeedrateValue (float) – the feedrateColumn
- customFeedrateUnit (
NXOpen.CAM.TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes
) – the feedrateUnitColumn - pointStatus (
NXOpen.CAM.TurnAvoidancePathPointsBuilderPointStatus
) – the point status - startEventFlag (int) – the start event status
- startEventPath (
NXOpen.NXObject
) – the start event path - endEventFlag (int) – the end event status
- endEventPath (
NXOpen.NXObject
) – the end event path
New in version NX6.0.2.
License requirements: cam_base (“CAM BASE”)
SetPointListData¶
-
TurnAvoidancePathPointsBuilder.
SetPointListData
¶ Create a new avoidance path point, name maybe changed if not unique
Signature
SetPointListData(index, specifyPoint, motionType, feedrateType, customFeedrateValue, customFeedrateUnit)
Parameters: - index (int) – the index which new avoidance path point will be added after
- specifyPoint (
NXOpen.NXObject
) – selected point - motionType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderMotionTypes
) – the motionTypeColumn - feedrateType (
NXOpen.CAM.TurnAvoidancePathPointsBuilderFeedrateModesTypes
) – the feedrate Type - customFeedrateValue (float) – the feedrateColumn
- customFeedrateUnit (
NXOpen.CAM.TurnAvoidancePathPointsBuilderCustomFeedrateUnitTypes
) – the feedrateUnitColumn
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)