NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAM.TurnAvoidancePathPointsBuilder Class Reference

Represents a turn avoidance path points builder More...

Inheritance diagram for NXOpen.CAM.TurnAvoidancePathPointsBuilder:
NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  CsTypes { Wcs, Mcs }
 the cs modes More...
 
enum  CustomFeedrateUnitTypes { None, IpmOrMmpm, IprOrMmpr }
 the custom feed rate unit options More...
 
enum  FeedrateModesTypes {
  Rapid, ApproachOrDepature, EngageOrReturn, Cut,
  Custom
}
 the feed rate type options More...
 
enum  MotionTypes { Automatic, Direct, RadialThenAxial, AxialThenRadial }
 the motion to point type options More...
 
enum  PointStatus { Inactive, Active }
 the point status options More...
 

Public Member Functions

unsafe void Delete (int index)
 Delete an existing avoidance path point More...
 
unsafe void GetPointData (int index, out NXOpen.NXObject specifyPoint, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.MotionTypes motionType, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.FeedrateModesTypes feedrateType, out double customFeedrateValue, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.CustomFeedrateUnitTypes customFeedrateUnit, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.PointStatus pointStatus, out int startEventFlag, out NXOpen.NXObject startEventPath, out int endEventFlag, out NXOpen.NXObject endEventPath)
 Get the values of an existing avoidance path point More...
 
unsafe void GetPointData (int index, out NXOpen.Point specifyPoint, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.MotionTypes motionType, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.FeedrateModesTypes feedrateType, out double customFeedrateValue, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.CustomFeedrateUnitTypes customFeedrateUnit, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.PointStatus pointStatus, out int startEventFlag, out NXOpen.NXObject startEventPath, out int endEventFlag, out NXOpen.NXObject endEventPath, out double toolHolderAngle)
 Gets the values of an existing avoidance path point More...
 
unsafe void GetPointListData (int index, out NXOpen.NXObject specifyPoint, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.MotionTypes motionType, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.FeedrateModesTypes feedrateType, out double customFeedrateValue, out NXOpen.CAM.TurnAvoidancePathPointsBuilder.CustomFeedrateUnitTypes customFeedrateUnit)
 Get the values of an existing avoidance path point More...
 
unsafe 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 More...
 
unsafe 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 More...
 
unsafe void ModifyData (int index, NXOpen.Point 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, double toolHolderAngle)
 Modifies an existing avoidance path point,name maybe changed if not unique More...
 
unsafe void MoveDown (int index)
 Move down a avoidance path point More...
 
unsafe void MoveUp (int index)
 Move up a avoidance path point More...
 
unsafe 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. More...
 
unsafe void SetPointData (int index, NXOpen.Point 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, double toolHolderAngle)
 Creates a new avoidance path point, name maybe changed if not unique. More...
 
unsafe 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 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.TurnAvoidancePathPointsBuilder.CsTypes 
CsMode [get, set]
 Returns or sets the cs mode More...
 
unsafe int PointListDataNumberOfTrackPoints [get]
 Returns the number of avoidance path points 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

Represents a turn avoidance path points builder

Created in NX6.0.0

Member Enumeration Documentation

the cs modes

Enumerator
Wcs 

WCS

Mcs 

MCS

the custom feed rate unit options

Enumerator
None 

Feed Rate: Automatic

IpmOrMmpm 

Feed Rate: Direct

IprOrMmpr 

Feed Rate: Radial then Axial

the feed rate type options

Enumerator
Rapid 

Feed Rate: Automatic

ApproachOrDepature 

Feed Rate: Direct

EngageOrReturn 

Feed Rate: Radial then Axial

Cut 

Feed Rate: Axial then Radial

Custom 

Feed Rate: Axial then Radial

the motion to point type options

Enumerator
Automatic 

Motion to Point: Automatic

Direct 

Motion to Point: Direct

RadialThenAxial 

Motion to Point: Radial then Axial

AxialThenRadial 

Motion to Point: Axial then Radial

the point status options

Enumerator
Inactive 

Point Status: Inactive

Active 

Point Status: Active

Member Function Documentation

unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.Delete ( int  index)
inline

Delete an existing avoidance path point

Created in NX6.0.0

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of deleted avoidance path point
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.GetPointData ( int  index,
out NXOpen.NXObject  specifyPoint,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.MotionTypes  motionType,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.FeedrateModesTypes  feedrateType,
out double  customFeedrateValue,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.CustomFeedrateUnitTypes  customFeedrateUnit,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.PointStatus  pointStatus,
out int  startEventFlag,
out NXOpen.NXObject  startEventPath,
out int  endEventFlag,
out NXOpen.NXObject  endEventPath 
)
inline

Get the values of an existing avoidance path point

Created in NX6.0.2

License requirements: None.

Parameters
indexthe index of avoidance path point
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
pointStatusthe point status
startEventFlagthe start event status
startEventPaththe start event path
endEventFlagthe end event status
endEventPaththe end event path
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.GetPointData ( int  index,
out NXOpen.Point  specifyPoint,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.MotionTypes  motionType,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.FeedrateModesTypes  feedrateType,
out double  customFeedrateValue,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.CustomFeedrateUnitTypes  customFeedrateUnit,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.PointStatus  pointStatus,
out int  startEventFlag,
out NXOpen.NXObject  startEventPath,
out int  endEventFlag,
out NXOpen.NXObject  endEventPath,
out double  toolHolderAngle 
)
inline

Gets the values of an existing avoidance path point

Created in NX12.0.1

License requirements: None.

Parameters
indexthe index of avoidance path point
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
pointStatusthe point status
startEventFlagthe start event status
startEventPaththe start event path
endEventFlagthe end event status
endEventPaththe end event path
toolHolderAnglethe tool holder angle
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.GetPointListData ( int  index,
out NXOpen.NXObject  specifyPoint,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.MotionTypes  motionType,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.FeedrateModesTypes  feedrateType,
out double  customFeedrateValue,
out NXOpen.CAM.TurnAvoidancePathPointsBuilder.CustomFeedrateUnitTypes  customFeedrateUnit 
)
inline

Get the values of an existing avoidance path point

Created in NX6.0.0

License requirements: None.

Parameters
indexthe index of avoidance path point
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
unsafe 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 
)
inline

Modify an existing avoidance path point,name maybe changed if not unique

Created in NX6.0.0

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of modified avoidance path point
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
unsafe 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 
)
inline

Modify an existing avoidance path point,name maybe changed if not unique

Created in NX6.0.2

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of modified avoidance path point
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
pointStatusthe point status
startEventFlagthe start event status
startEventPaththe start event path
endEventFlagthe end event status
endEventPaththe end event path
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.ModifyData ( int  index,
NXOpen.Point  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,
double  toolHolderAngle 
)
inline

Modifies an existing avoidance path point,name maybe changed if not unique

Created in NX12.0.1

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of modified avoidance path point
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
pointStatusthe point status
startEventFlagthe start event status
startEventPaththe start event path
endEventFlagthe end event status
endEventPaththe end event path
toolHolderAnglethe tool holder angle
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.MoveDown ( int  index)
inline

Move down a avoidance path point

Created in NX6.0.0

License requirements: None.

Parameters
indexthe index of item which should be moved down
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.MoveUp ( int  index)
inline

Move up a avoidance path point

Created in NX6.0.0

License requirements: None.

Parameters
indexthe index of item which should be moved up
unsafe 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 
)
inline

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

Created in NX6.0.2

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index which new avoidance path point will be added after
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
pointStatusthe point status
startEventFlagthe start event status
startEventPaththe start event path
endEventFlagthe end event status
endEventPaththe end event path
unsafe void NXOpen.CAM.TurnAvoidancePathPointsBuilder.SetPointData ( int  index,
NXOpen.Point  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,
double  toolHolderAngle 
)
inline

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

Created in NX12.0.1

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index which new avoidance path point will be added after
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn
pointStatusthe point status
startEventFlagthe start event status
startEventPaththe start event path
endEventFlagthe end event status
endEventPaththe end event path
toolHolderAnglethe tool holder angle
unsafe 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 
)
inline

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

Created in NX6.0.0

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index which new avoidance path point will be added after
specifyPointselected point
motionTypethe motionTypeColumn
feedrateTypethe feedrate Type
customFeedrateValuethe feedrateColumn
customFeedrateUnitthe feedrateUnitColumn

Property Documentation

unsafe NXOpen.CAM.TurnAvoidancePathPointsBuilder.CsTypes NXOpen.CAM.TurnAvoidancePathPointsBuilder.CsMode
getset

Returns or sets the cs mode

Created in NX6.0.0

License requirements to get this property: None.

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

unsafe int NXOpen.CAM.TurnAvoidancePathPointsBuilder.PointListDataNumberOfTrackPoints
get

Returns the number of avoidance path points

Created in NX6.0.0

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.