NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAM::MillingTrackpointBuilder Class Reference

Represents a Milling Trackpoint Builder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::MillingTrackpointBuilder:
NXOpen::TaggedObject

List of all members.

Public Member Functions

int Add (int inputIndex, const NXString &name, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed, NXString *newName)
 Add a new trackpoint, name maybe changed if not unique.
void Delete (int index)
 Delete an existing trackpoint
Created in NX6.0.0.
void Get (NXOpen::NXObject *pointTag, NXString *name, double *diameter, double *distance, double *zOffset, int *zOffsetUsed, int *adjust, int *adjustUsed, int *cutcom, int *cutcomUsed)
 Get the values of an existing trackpoint
Created in NX6.0.0.
NXOpen::NXObjectGetTrackPoint (int position)
 Get a specific trackpoint.
NXString Modify (int index, const NXString &name, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed)
 Modify an existing trackpoint,name maybe changed if not unique.
void MoveDown (int index)
 Move down a trackpoint
Created in NX6.0.0.
void MoveUp (int index)
 Move up a trackpoint
Created in NX6.0.0.
int NumberOfTrackPoints ()
 Returns the number of trackpoints
Created in NX6.0.0.

Detailed Description

Represents a Milling Trackpoint Builder
Created in NX6.0.0.



Member Function Documentation

int NXOpen::CAM::MillingTrackpointBuilder::Add ( int  inputIndex,
const NXString name,
double  diameter,
double  distance,
double  zOffset,
int  zOffsetUsed,
int  adjust,
int  adjustUsed,
int  cutcom,
int  cutcomUsed,
NXString newName 
)

Add a new trackpoint, name maybe changed if not unique.

Returns:
output actual index of new track point, if error happens, output will be -1
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
inputIndexthe input index of new track point
namethe new created object name
NOTE: The full Unicode character set is not supported for this parameter.
diameterthe diameter
distancethe distance
zOffsetthe zoffset
zOffsetUsedthe zoffset toggle
adjustthe adjust
adjustUsedthe adjust toggle
cutcomthe cutcom
cutcomUsedthe cutcom toggle
newNamethe final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN

Delete an existing trackpoint
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe index of deleted track point
void NXOpen::CAM::MillingTrackpointBuilder::Get ( NXOpen::NXObject pointTag,
NXString name,
double *  diameter,
double *  distance,
double *  zOffset,
int *  zOffsetUsed,
int *  adjust,
int *  adjustUsed,
int *  cutcom,
int *  cutcomUsed 
)

Get the values of an existing trackpoint
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pointTagthe track point
namethe name
diameterthe diameter
distancethe distance
zOffsetthe zoffset
zOffsetUsedthe zoffset toggle
adjustthe adjust
adjustUsedthe adjust toggle
cutcomthe cutcom
cutcomUsedthe cutcom toggle

Get a specific trackpoint.

Returns:
the track point
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
positionthe position of track point
NXString NXOpen::CAM::MillingTrackpointBuilder::Modify ( int  index,
const NXString name,
double  diameter,
double  distance,
double  zOffset,
int  zOffsetUsed,
int  adjust,
int  adjustUsed,
int  cutcom,
int  cutcomUsed 
)

Modify an existing trackpoint,name maybe changed if not unique.

Returns:
the final object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
indexthe index of modified track point
namethe object new name
NOTE: The full Unicode character set is not supported for this parameter.
diameterthe diameter
distancethe distance
zOffsetthe zoffset
zOffsetUsedthe zoffset toggle
adjustthe adjust
adjustUsedthe adjust toggle
cutcomthe cutcom
cutcomUsedthe cutcom toggle

Move down a trackpoint
Created in NX6.0.0.



License requirements : None

Parameters:
indexthe index of item which should be moved down

Move up a trackpoint
Created in NX6.0.0.



License requirements : None

Parameters:
indexthe index of item which should be moved up

Returns the number of trackpoints
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")


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