NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAM::ToolTrackingPointBuilder Class Reference

Represents the Tool Tracking Point Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateToolTrackingPointBuilder

Created in NX8.5.1. More...

Inheritance diagram for NXOpen::CAM::ToolTrackingPointBuilder:
NXOpen::CAM::MoveBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

int GetAdjustRegister ()
 Get the Adjust register. More...
 
bool GetAdjustRegisterToggle ()
 Get the Adjust register Toggle Status. More...
 
int GetTrackingPoint ()
 Get the Tracking point index. More...
 
double GetXoffset ()
 Get the X offset. More...
 
bool GetXoffsetToggle ()
 Get the X offset Toggle Status. More...
 
double GetYoffset ()
 Get the Y offset. More...
 
bool GetYoffsetToggle ()
 Get the Y offset Toggle Status. More...
 
double GetZoffset ()
 Get the Z offset. More...
 
bool GetZoffsetToggle ()
 Get the Z offset Toggle Status. More...
 
void SetAdjustRegister (int index, int adjreg)
 Set the Adjust register
Created in NX9.0.2. More...
 
void SetAdjustRegisterToggle (int index, bool adjregstat)
 Set the Adjust register Toggle Status
Created in NX9.0.2. More...
 
void SetTrackingPoint (int index)
 Set the Tracking point index
Created in NX9.0.2. More...
 
void SetXoffset (int index, double xoff)
 Set the X offset
Created in NX9.0.2. More...
 
void SetXoffsetToggle (int index, bool xoffstat)
 Set the X offset Toggle Status
Created in NX9.0.2. More...
 
void SetYoffset (int index, double yoff)
 Set the Y offset
Created in NX9.0.2. More...
 
void SetYoffsetToggle (int index, bool yoffstat)
 Set the Y offset Toggle Status
Created in NX9.0.2. More...
 
void SetZoffset (int index, double zoff)
 Set the Z offset
Created in NX9.0.2. More...
 
void SetZoffsetToggle (int index, bool zoffstat)
 Set the Z offset Toggle Status
Created in NX9.0.2. More...
 
- Public Member Functions inherited from NXOpen::CAM::MoveBuilder
double FeedRate ()
 Returns the feed rate
Created in NX5.0.0. More...
 
NXOpen::CAM::MoveBuilder::Feed FeedType ()
 Returns the feed type
Created in NX5.0.0. More...
 
NXOpen::CAM::FeedRateUnit FeedUnit ()
 Returns the feed unit
Created in NX7.5.0. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (const NXString &parameterName)
 Returns the custom parameter with the given name. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (const char *parameterName)
 Returns the custom parameter with the given name. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (int index)
 Returns the parameter at the input index. More...
 
NXOpen::CAM::MoveBuilder::Motion MotionType ()
 Returns the motion type
Created in NX5.0.0. More...
 
int NumberOfUserParameters ()
 Returns the number of user parameters
Created in NX8.0.0. More...
 
bool ProtectedMove ()
 Returns the protected move status
Created in NX5.0.0. More...
 
void SetFeedRate (double feedRate)
 Sets the feed rate
Created in NX5.0.0. More...
 
void SetFeedType (NXOpen::CAM::MoveBuilder::Feed feedType)
 Sets the feed type
Created in NX5.0.0. More...
 
void SetFeedUnit (NXOpen::CAM::FeedRateUnit unit)
 Sets the feed unit
Created in NX7.5.0. More...
 
void SetMotionType (NXOpen::CAM::MoveBuilder::Motion motionType)
 Sets the motion type
Created in NX5.0.0. More...
 
void SetParent (NXOpen::CAM::CAMObject *parent)
 Set parent
Created in NX5.0.0. More...
 
void SetProtectedMove (bool protectedMove)
 Sets the protected move status
Created in NX5.0.0. More...
 
void SetSibling (NXOpen::CAM::CAMObject *sibling)
 Set sibling
Created in NX5.0.0. More...
 
void SetSubopLabel (const NXString &subopLabel)
 Sets the subop label
Created in NX8.5.1. More...
 
void SetSubopLabel (const char *subopLabel)
 Sets the subop label
Created in NX8.5.1. More...
 
NXString SubopLabel ()
 Returns the subop label
Created in NX8.5.1. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::CAM::MoveBuilder
enum  Feed { FeedMotion, FeedCustom }
 the feed Type More...
 
enum  Motion {
  MotionRapid = 1, MotionEngage, MotionCut, MotionStepover,
  MotionRetract, MotionApproach, MotionTraversal, MotionDeparture,
  MotionReturn, MotionFirstCut, MotionLastCut, MotionCrossover
}
 the motion Type More...
 

Detailed Description

Represents the Tool Tracking Point Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateToolTrackingPointBuilder

Created in NX8.5.1.


Member Function Documentation

int NXOpen::CAM::ToolTrackingPointBuilder::GetAdjustRegister ( )

Get the Adjust register.

Returns

Created in NX9.0.2.

License requirements : None
bool NXOpen::CAM::ToolTrackingPointBuilder::GetAdjustRegisterToggle ( )

Get the Adjust register Toggle Status.

Returns

Created in NX9.0.2.

License requirements : None
int NXOpen::CAM::ToolTrackingPointBuilder::GetTrackingPoint ( )

Get the Tracking point index.

Returns

Created in NX9.0.2.

License requirements : None
double NXOpen::CAM::ToolTrackingPointBuilder::GetXoffset ( )

Get the X offset.

Returns

Created in NX9.0.2.

License requirements : None
bool NXOpen::CAM::ToolTrackingPointBuilder::GetXoffsetToggle ( )

Get the X offset Toggle Status.

Returns

Created in NX9.0.2.

License requirements : None
double NXOpen::CAM::ToolTrackingPointBuilder::GetYoffset ( )

Get the Y offset.

Returns

Created in NX9.0.2.

License requirements : None
bool NXOpen::CAM::ToolTrackingPointBuilder::GetYoffsetToggle ( )

Get the Y offset Toggle Status.

Returns

Created in NX9.0.2.

License requirements : None
double NXOpen::CAM::ToolTrackingPointBuilder::GetZoffset ( )

Get the Z offset.

Returns

Created in NX9.0.2.

License requirements : None
bool NXOpen::CAM::ToolTrackingPointBuilder::GetZoffsetToggle ( )

Get the Z offset Toggle Status.

Returns

Created in NX9.0.2.

License requirements : None
void NXOpen::CAM::ToolTrackingPointBuilder::SetAdjustRegister ( int  index,
int  adjreg 
)

Set the Adjust register
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
adjregadjreg
void NXOpen::CAM::ToolTrackingPointBuilder::SetAdjustRegisterToggle ( int  index,
bool  adjregstat 
)

Set the Adjust register Toggle Status
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
adjregstatadjregstat
void NXOpen::CAM::ToolTrackingPointBuilder::SetTrackingPoint ( int  index)

Set the Tracking point index
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
void NXOpen::CAM::ToolTrackingPointBuilder::SetXoffset ( int  index,
double  xoff 
)

Set the X offset
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
xoffxoff
void NXOpen::CAM::ToolTrackingPointBuilder::SetXoffsetToggle ( int  index,
bool  xoffstat 
)

Set the X offset Toggle Status
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
xoffstatxoffstat
void NXOpen::CAM::ToolTrackingPointBuilder::SetYoffset ( int  index,
double  yoff 
)

Set the Y offset
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
yoffyoff
void NXOpen::CAM::ToolTrackingPointBuilder::SetYoffsetToggle ( int  index,
bool  yoffstat 
)

Set the Y offset Toggle Status
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
yoffstatyoffstat
void NXOpen::CAM::ToolTrackingPointBuilder::SetZoffset ( int  index,
double  zoff 
)

Set the Z offset
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
zoffzoff
void NXOpen::CAM::ToolTrackingPointBuilder::SetZoffsetToggle ( int  index,
bool  zoffstat 
)

Set the Z offset Toggle Status
Created in NX9.0.2.



License requirements : None

Parameters
indexindex
zoffstatzoffstat

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