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.MillingTrackpointBuilder Class Reference

Represents a Milling Trackpoint Builder More...

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

Public Types

enum  Types { Full, ByDiameter }
 the definition enum More...
 

Public Member Functions

unsafe int Add (int inputIndex, string name, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed, out string newName)
 Add a new trackpoint, name maybe changed if not unique More...
 
unsafe int Add (int inputIndex, string name, int definitionType, double diameter, double distance, double zOffset, int zOffsetUsed, int adjust, int adjustUsed, int cutcom, int cutcomUsed, out string newName)
 Add a new track point, the input name will be changed if it is not unique. More...
 
unsafe double CalculateDistance (int definitionType, out double diameter)
 Calculate distance when defining tracking point only by the diameter More...
 
unsafe void Delete (int index)
 Delete an existing trackpoint More...
 
unsafe void Get (NXOpen.NXObject pointTag, out string name, out double diameter, out double distance, out double zOffset, out int zOffsetUsed, out int adjust, out int adjustUsed, out int cutcom, out int cutcomUsed)
 Get the values of an existing trackpoint More...
 
unsafe NXOpen.NXObject GetTrackPoint (int position)
 Get a specific trackpoint More...
 
unsafe void GetTrackPoint (NXOpen.NXObject pointTag, out string name, out int definitionType, out double diameter, out double distance, out double zOffset, out int zOffsetUsed, out int adjust, out int adjustUsed, out int cutcom, out int cutcomUsed)
 Get the values of an existing track point. More...
 
unsafe string Modify (int index, string 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...
 
unsafe string Modify (int index, string 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...
 
unsafe void MoveDown (int index)
 Move down a trackpoint More...
 
unsafe void MoveUp (int index)
 Move up a trackpoint 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 int NumberOfTrackPoints [get]
 Returns the number of trackpoints 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 Milling Trackpoint Builder

Created in NX6.0.0

Member Enumeration Documentation

the definition enum

Enumerator
Full 

Full

ByDiameter 

By Diameter

Member Function Documentation

unsafe int NXOpen.CAM.MillingTrackpointBuilder.Add ( int  inputIndex,
string  name,
double  diameter,
double  distance,
double  zOffset,
int  zOffsetUsed,
int  adjust,
int  adjustUsed,
int  cutcom,
int  cutcomUsed,
out string  newName 
)
inline

Add a new trackpoint, name maybe changed if not unique

Created in NX6.0.0

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

License requirements: cam_base ("CAM BASE")

Parameters
inputIndexthe input index of new track point
namethe new created object name
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
Returns
output actual index of new track point, if error happens, output will be -1
unsafe int NXOpen.CAM.MillingTrackpointBuilder.Add ( int  inputIndex,
string  name,
int  definitionType,
double  diameter,
double  distance,
double  zOffset,
int  zOffsetUsed,
int  adjust,
int  adjustUsed,
int  cutcom,
int  cutcomUsed,
out string  newName 
)
inline

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

Created in NX10.0.0

License requirements: cam_base ("CAM BASE")

Parameters
inputIndexthe input index of new track point
namethe new created object name
definitionTypethe definition type
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
Returns
the actual index of the new track point, if there is error, output is -1
unsafe double NXOpen.CAM.MillingTrackpointBuilder.CalculateDistance ( int  definitionType,
out double  diameter 
)
inline

Calculate distance when defining tracking point only by the diameter

Created in NX10.0.0

License requirements: cam_base ("CAM BASE")

Parameters
definitionTypethe definition type
diameterthe diameter
Returns
the distance
unsafe void NXOpen.CAM.MillingTrackpointBuilder.Delete ( int  index)
inline

Delete an existing trackpoint

Created in NX6.0.0

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of deleted track point
unsafe void NXOpen.CAM.MillingTrackpointBuilder.Get ( NXOpen.NXObject  pointTag,
out string  name,
out double  diameter,
out double  distance,
out double  zOffset,
out int  zOffsetUsed,
out int  adjust,
out int  adjustUsed,
out int  cutcom,
out int  cutcomUsed 
)
inline

Get the values of an existing trackpoint

Created in NX6.0.0

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

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
unsafe NXOpen.NXObject NXOpen.CAM.MillingTrackpointBuilder.GetTrackPoint ( int  position)
inline

Get a specific trackpoint

Created in NX6.0.0

License requirements: cam_base ("CAM BASE")

Parameters
positionthe position of track point
Returns
the track point
unsafe void NXOpen.CAM.MillingTrackpointBuilder.GetTrackPoint ( NXOpen.NXObject  pointTag,
out string  name,
out int  definitionType,
out double  diameter,
out double  distance,
out double  zOffset,
out int  zOffsetUsed,
out int  adjust,
out int  adjustUsed,
out int  cutcom,
out int  cutcomUsed 
)
inline

Get the values of an existing track point.

Created in NX10.0.0

License requirements: cam_base ("CAM BASE")

Parameters
pointTagthe track point
namethe name
definitionTypethe definition type
diameterthe diameter
distancethe distance
zOffsetthe zoffset
zOffsetUsedthe zoffset toggle
adjustthe adjust
adjustUsedthe adjust toggle
cutcomthe cutcom
cutcomUsedthe cutcom toggle
unsafe string NXOpen.CAM.MillingTrackpointBuilder.Modify ( int  index,
string  name,
double  diameter,
double  distance,
double  zOffset,
int  zOffsetUsed,
int  adjust,
int  adjustUsed,
int  cutcom,
int  cutcomUsed 
)
inline

Modify an existing trackpoint,name maybe changed if not unique

Created in NX6.0.0

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

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of modified track point
namethe object new name
diameterthe diameter
distancethe distance
zOffsetthe zoffset
zOffsetUsedthe zoffset toggle
adjustthe adjust
adjustUsedthe adjust toggle
cutcomthe cutcom
cutcomUsedthe cutcom toggle
Returns
the final object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN
unsafe string NXOpen.CAM.MillingTrackpointBuilder.Modify ( int  index,
string  name,
int  definitionType,
double  diameter,
double  distance,
double  zOffset,
int  zOffsetUsed,
int  adjust,
int  adjustUsed,
int  cutcom,
int  cutcomUsed 
)
inline

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

Created in NX10.0.0

License requirements: cam_base ("CAM BASE")

Parameters
indexthe index of modified track point
namethe object new name
definitionTypethe definition type
diameterthe diameter
distancethe distance
zOffsetthe zoffset
zOffsetUsedthe zoffset toggle
adjustthe adjust
adjustUsedthe adjust toggle
cutcomthe cutcom
cutcomUsedthe cutcom toggle
Returns
the final object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN
unsafe void NXOpen.CAM.MillingTrackpointBuilder.MoveDown ( int  index)
inline

Move down a trackpoint

Created in NX6.0.0

License requirements: None.

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

Move up a trackpoint

Created in NX6.0.0

License requirements: None.

Parameters
indexthe index of item which should be moved up

Property Documentation

unsafe int NXOpen.CAM.MillingTrackpointBuilder.NumberOfTrackPoints
get

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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.