NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::TurnAvoidancePathPointsBuilder Class Reference

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

Inheritance diagram for NXOpen::CAM::TurnAvoidancePathPointsBuilder:
NXOpen::TaggedObject

List of all members.

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.

Detailed Description

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



Member Enumeration Documentation

the cs modes
Created in NX6.0.0.


Enumerator:
CsTypesWcs 

WCS.

CsTypesMcs 

MCS.

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.

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.

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.

the point status options
Created in NX6.0.2.


Enumerator:
PointStatusInactive 

Point Status: Inactive.

PointStatusActive 

Point Status: Active.


Member Function Documentation

Returns the cs mode
Created in NX6.0.0.



License requirements : None

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
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:
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

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

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

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

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



License requirements : None

Parameters:
indexthe index of item which should be moved down

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



License requirements : None

Parameters:
indexthe index of item which should be moved up

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



License requirements : None

Sets the cs mode
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
csModethe cs mode value

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

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

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