NXOpen::CAM::MillingTrackpointBuilder Class Reference

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

Inheritance diagram for NXOpen::CAM::MillingTrackpointBuilder:

Public Types
enum	Types { TypesFull, TypesByDiameter }
	the definition enum Created in NX10.0.0. More...

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. More...
int	Add (int inputIndex, const char *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. More...
int	Add (int inputIndex, const NXString &name, int definitionType, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed, NXString *newName)
	Add a new track point, the input name will be changed if it is not unique. More...
int	Add (int inputIndex, const char *name, int definitionType, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed, NXString *newName)
	Add a new track point, the input name will be changed if it is not unique. More...
double	CalculateDistance (int definitionType, double *diameter)
	Calculate distance when defining tracking point only by the diameter. More...
void	Delete (int index)
	Delete an existing trackpoint Created in NX6.0.0. More...
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 More...
NXOpen::NXObject *	GetTrackPoint (int position)
	Get a specific trackpoint. More...
void	GetTrackPoint (NXOpen::NXObject *pointTag, NXString *name, int *definitionType, double *diameter, double *distance, double *zOffset, int *zOffsetUsed, int *adjust, int *adjustUsed, int *cutcom, int *cutcomUsed)
	Get the values of an existing track point. More...
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. More...
NXString	Modify (int index, const char *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. More...
NXString	Modify (int index, const NXString &name, int definitionType, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed)
	Modify an existing track point, the input name will be changed if it is not unique. More...
NXString	Modify (int index, const char *name, int definitionType, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed)
	Modify an existing track point, the input name will be changed if it is not unique. More...
void	MoveDown (int index)
	Move down a trackpoint Created in NX6.0.0. More...
void	MoveUp (int index)
	Move up a trackpoint Created in NX6.0.0. More...
int	NumberOfTrackPoints ()
	Returns the number of trackpoints Created in NX6.0.0. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a Milling Trackpoint Builder
Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::MillingTrackpointBuilder::Types

the definition enum
Created in NX10.0.0.

Enumerator
TypesFull	Full.
TypesByDiameter	By Diameter.

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

Deprecated:

Deprecated in NX10.0.0. Use new version with additional arguments instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

inputIndex	the input index of new track point
name	the new created object name
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle
newName	the final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN

int NXOpen::CAM::MillingTrackpointBuilder::Add	(	int	inputIndex,
		const char *	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

Deprecated:

Deprecated in NX10.0.0. Use new version with additional arguments instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

inputIndex	the input index of new track point
name	the new created object name
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle
newName	the final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN

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

Add a new track point, the input name will be changed if it is not unique.

Returns

the actual index of the new track point, if there is error, output is -1
Created in NX10.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

inputIndex	the input index of new track point
name	the new created object name
definitionType	the definition type
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle
newName	the final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN

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

Add a new track point, the input name will be changed if it is not unique.

Returns

the actual index of the new track point, if there is error, output is -1
Created in NX10.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

inputIndex	the input index of new track point
name	the new created object name
definitionType	the definition type
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle
newName	the final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN

double NXOpen::CAM::MillingTrackpointBuilder::CalculateDistance	(	int	definitionType,
		double *	diameter
	)

Calculate distance when defining tracking point only by the diameter.

Returns

the distance
Created in NX10.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

definitionType	the definition type
diameter	the diameter

void NXOpen::CAM::MillingTrackpointBuilder::Delete

(

int

index

)

Delete an existing trackpoint
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

index

the 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

Deprecated:

Deprecated in NX10.0.0.

Use new version _tp with additional arguments instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

pointTag	the track point
name	the name
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle

NXOpen::NXObject* NXOpen::CAM::MillingTrackpointBuilder::GetTrackPoint

(

int

position

)

Get a specific trackpoint.

Returns

the track point
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

position

the position of track point

void NXOpen::CAM::MillingTrackpointBuilder::GetTrackPoint	(	NXOpen::NXObject *	pointTag,
		NXString *	name,
		int *	definitionType,
		double *	diameter,
		double *	distance,
		double *	zOffset,
		int *	zOffsetUsed,
		int *	adjust,
		int *	adjustUsed,
		int *	cutcom,
		int *	cutcomUsed
	)

Get the values of an existing track point.

Created in NX10.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

pointTag	the track point
name	the name
definitionType	the definition type
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle

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

Deprecated:

Deprecated in NX10.0.0. Use new version with additional arguments instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

index	the index of modified track point
name	the object new name
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle

NXString NXOpen::CAM::MillingTrackpointBuilder::Modify	(	int	index,
		const char *	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

Deprecated:

Deprecated in NX10.0.0. Use new version with additional arguments instead.

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

index	the index of modified track point
name	the object new name
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle

NXString NXOpen::CAM::MillingTrackpointBuilder::Modify	(	int	index,
		const NXString &	name,
		int	definitionType,
		double	diameter,
		double	distance,
		double	zOffset,
		int	zOffsetUsed,
		int	adjust,
		int	adjustUsed,
		int	cutcom,
		int	cutcomUsed
	)

Modify an existing track point, the input name will be changed if it is not unique.

Returns

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

License requirements : cam_base ("CAM BASE")

Parameters

index	the index of modified track point
name	the object new name
definitionType	the definition type
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle

NXString NXOpen::CAM::MillingTrackpointBuilder::Modify	(	int	index,
		const char *	name,
		int	definitionType,
		double	diameter,
		double	distance,
		double	zOffset,
		int	zOffsetUsed,
		int	adjust,
		int	adjustUsed,
		int	cutcom,
		int	cutcomUsed
	)

Modify an existing track point, the input name will be changed if it is not unique.

Returns

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

License requirements : cam_base ("CAM BASE")

Parameters

index	the index of modified track point
name	the object new name
definitionType	the definition type
diameter	the diameter
distance	the distance
zOffset	the zoffset
zOffsetUsed	the zoffset toggle
adjust	the adjust
adjustUsed	the adjust toggle
cutcom	the cutcom
cutcomUsed	the cutcom toggle

void NXOpen::CAM::MillingTrackpointBuilder::MoveDown

(

int

index

)

Move down a trackpoint
Created in NX6.0.0.

License requirements : None

Parameters

index

the index of item which should be moved down

void NXOpen::CAM::MillingTrackpointBuilder::MoveUp

(

int

index

)

Move up a trackpoint
Created in NX6.0.0.

License requirements : None

Parameters

index

the index of item which should be moved up

int NXOpen::CAM::MillingTrackpointBuilder::NumberOfTrackPoints

(

)

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:

• CAM_MillingTrackpointBuilder.hxx