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

Represents a TeachmodeProfileMoveBuilder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateTeachmodeTurningBuilder

Created in NX7.5.0. More...

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

Public Types

enum  DriveGeometryTypes { DriveGeometryTypesPreviousCheck, DriveGeometryTypesPreviousDrive, DriveGeometryTypesNewDrive }
 the drive geometry types More...
 
enum  StartStopPositionMethods { StartStopPositionMethodsDrive, StartStopPositionMethodsPoint, StartStopPositionMethodsCheck, StartStopPositionMethodsContourPosition }
 the start and stop positioning methods More...
 
- 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...
 

Public Member Functions

bool ApplyEngageSettings ()
 Returns the apply engage settings status
Created in NX7.5.0. More...
 
bool ApplyRetractSettings ()
 Returns the apply retract settings status
Created in NX7.5.0. More...
 
double AxialSafeClearance ()
 Returns the axial safe clearance value
Created in NX7.5.0. More...
 
NXOpen::CAM::TurnCornerControlCornerControlNormal ()
 Returns the corner control builder for normal corners
Created in NX7.5.0. More...
 
NXOpen::CAM::TurnCornerControlCornerControlShallow ()
 Returns the corner control builder for shallow corners
Created in NX7.5.0. More...
 
NXOpen::CAM::BoundaryCustomDriveCurve ()
 Returns the custom drive curve builder
Created in NX9.0.2. More...
 
NXOpen::CAM::TurnCutterClearanceCutterClearance ()
 Returns the cutter clearance angles builder
Created in NX7.5.0. More...
 
NXOpen::CAM::TurnDirectionDirection ()
 Returns the direction builder
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeProfileMoveBuilder::DriveGeometryTypes DriveGeometryType ()
 Returns the drive geometry type
Created in NX7.5.0. More...
 
NXOpen::CAM::BoundaryEndCheckBoundary ()
 Returns the end check boundary builder
Created in NX9.0.2. More...
 
NXOpen::CAM::FeedsTurnBuilderFeeds ()
 Returns the feeds builder
Created in NX7.5.0. More...
 
NXOpen::CAM::TurnStockFinishStock ()
 Returns the finish stock builder
Created in NX7.5.0. More...
 
NXOpen::CAM::BoundaryNewDriveCurve ()
 Returns the new drive curve builder
Created in NX9.0.2. More...
 
double RadialSafeClearance ()
 Returns the radial safe clearance value
Created in NX7.5.0. More...
 
void SetApplyEngageSettings (bool newValue)
 Sets the apply engage settings status
Created in NX7.5.0. More...
 
void SetApplyRetractSettings (bool newValue)
 Sets the apply retract settings status
Created in NX7.5.0. More...
 
void SetAxialSafeClearance (double newValue)
 Sets the axial safe clearance value
Created in NX7.5.0. More...
 
void SetDriveGeometryType (NXOpen::CAM::TeachmodeProfileMoveBuilder::DriveGeometryTypes newValue)
 Sets the drive geometry type
Created in NX7.5.0. More...
 
void SetRadialSafeClearance (double newValue)
 Sets the radial safe clearance value
Created in NX7.5.0. More...
 
void SetStartCheckConstantStock (double newValue)
 Sets the constant stock for start check geometry
Created in NX7.5.0. More...
 
void SetStartCheckFaceStock (double newValue)
 Sets the face stock for start check geometry
Created in NX7.5.0. More...
 
void SetStartCheckRadialStock (double newValue)
 Sets the radial stock for start check geometry
Created in NX7.5.0. More...
 
void SetStartPoint (NXOpen::Point *newValue)
 Sets the start point
Created in NX7.5.0. More...
 
void SetStartPositionMethod (NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods newValue)
 Sets the start position method
Created in NX7.5.0. More...
 
void SetStartStopBeforeBoundaryOffset (bool newValue)
 Sets the start and stop before boundary offset status
Created in NX7.5.0. More...
 
void SetStopCheckConstantStock (double newValue)
 Sets the constant stock for stop check geometry
Created in NX7.5.0. More...
 
void SetStopCheckFaceStock (double newValue)
 Sets the face stop for start check geometry
Created in NX7.5.0. More...
 
void SetStopCheckRadialStock (double newValue)
 Sets the radial stock for stop check geometry
Created in NX7.5.0. More...
 
void SetStopPoint (NXOpen::Point *newValue)
 Sets the stop point
Created in NX7.5.0. More...
 
void SetStopPositionMethod (NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods newValue)
 Sets the stop position method
Created in NX7.5.0. More...
 
NXOpen::CAM::BoundaryStartCheckBoundary ()
 Returns the start check boundary builder
Created in NX9.0.2. More...
 
double StartCheckConstantStock ()
 Returns the constant stock for start check geometry
Created in NX7.5.0. More...
 
double StartCheckFaceStock ()
 Returns the face stock for start check geometry
Created in NX7.5.0. More...
 
double StartCheckRadialStock ()
 Returns the radial stock for start check geometry
Created in NX7.5.0. More...
 
NXOpen::PointStartPoint ()
 Returns the start point
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods StartPositionMethod ()
 Returns the start position method
Created in NX7.5.0. More...
 
bool StartStopBeforeBoundaryOffset ()
 Returns the start and stop before boundary offset status
Created in NX7.5.0. More...
 
double StopCheckConstantStock ()
 Returns the constant stock for stop check geometry
Created in NX7.5.0. More...
 
double StopCheckFaceStock ()
 Returns the face stop for start check geometry
Created in NX7.5.0. More...
 
double StopCheckRadialStock ()
 Returns the radial stock for stop check geometry
Created in NX7.5.0. More...
 
NXOpen::PointStopPoint ()
 Returns the stop point
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods StopPositionMethod ()
 Returns the stop position method
Created in NX7.5.0. More...
 
NXOpen::CAM::Inheritable2dLengthTolerances ()
 Returns the Tolerances
Created in NX7.5.0. 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...
 

Detailed Description

Represents a TeachmodeProfileMoveBuilder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateTeachmodeTurningBuilder

Created in NX7.5.0.


Member Enumeration Documentation

the drive geometry types

Enumerator
DriveGeometryTypesPreviousCheck 

Use Previous Drive Geometry.

DriveGeometryTypesPreviousDrive 

Use Previous Stop Check Geometry.

DriveGeometryTypesNewDrive 

Use New Drive Geometry.

the start and stop positioning methods

Enumerator
StartStopPositionMethodsDrive 

Use drive geometry start or stop point.

StartStopPositionMethodsPoint 

Use selected point.

StartStopPositionMethodsCheck 

Use selected check geometry.

StartStopPositionMethodsContourPosition 

Use end point of last contouring.

Member Function Documentation

bool NXOpen::CAM::TeachmodeProfileMoveBuilder::ApplyEngageSettings ( )

Returns the apply engage settings status
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::TeachmodeProfileMoveBuilder::ApplyRetractSettings ( )

Returns the apply retract settings status
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::AxialSafeClearance ( )

Returns the axial safe clearance value
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TurnCornerControl* NXOpen::CAM::TeachmodeProfileMoveBuilder::CornerControlNormal ( )

Returns the corner control builder for normal corners
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TurnCornerControl* NXOpen::CAM::TeachmodeProfileMoveBuilder::CornerControlShallow ( )

Returns the corner control builder for shallow corners
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::Boundary* NXOpen::CAM::TeachmodeProfileMoveBuilder::CustomDriveCurve ( )

Returns the custom drive curve builder
Created in NX9.0.2.



License requirements : None

NXOpen::CAM::TurnCutterClearance* NXOpen::CAM::TeachmodeProfileMoveBuilder::CutterClearance ( )

Returns the cutter clearance angles builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TurnDirection* NXOpen::CAM::TeachmodeProfileMoveBuilder::Direction ( )

Returns the direction builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeProfileMoveBuilder::DriveGeometryTypes NXOpen::CAM::TeachmodeProfileMoveBuilder::DriveGeometryType ( )

Returns the drive geometry type
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::Boundary* NXOpen::CAM::TeachmodeProfileMoveBuilder::EndCheckBoundary ( )

Returns the end check boundary builder
Created in NX9.0.2.



License requirements : None

NXOpen::CAM::FeedsTurnBuilder* NXOpen::CAM::TeachmodeProfileMoveBuilder::Feeds ( )

Returns the feeds builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TurnStock* NXOpen::CAM::TeachmodeProfileMoveBuilder::FinishStock ( )

Returns the finish stock builder
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::Boundary* NXOpen::CAM::TeachmodeProfileMoveBuilder::NewDriveCurve ( )

Returns the new drive curve builder
Created in NX9.0.2.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::RadialSafeClearance ( )

Returns the radial safe clearance value
Created in NX7.5.0.



License requirements : None

void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetApplyEngageSettings ( bool  newValue)

Sets the apply engage settings status
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe status value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetApplyRetractSettings ( bool  newValue)

Sets the apply retract settings status
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe status value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetAxialSafeClearance ( double  newValue)

Sets the axial safe clearance value
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe axial safe clearance value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetDriveGeometryType ( NXOpen::CAM::TeachmodeProfileMoveBuilder::DriveGeometryTypes  newValue)

Sets the drive geometry type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe drive geometry type
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetRadialSafeClearance ( double  newValue)

Sets the radial safe clearance value
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe radial safe clearance value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStartCheckConstantStock ( double  newValue)

Sets the constant stock for start check geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe constant stock value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStartCheckFaceStock ( double  newValue)

Sets the face stock for start check geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe face stock value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStartCheckRadialStock ( double  newValue)

Sets the radial stock for start check geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe radial stock value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStartPoint ( NXOpen::Point newValue)

Sets the start point
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe start point
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStartPositionMethod ( NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods  newValue)

Sets the start position method
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe start position method
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStartStopBeforeBoundaryOffset ( bool  newValue)

Sets the start and stop before boundary offset status
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe status value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStopCheckConstantStock ( double  newValue)

Sets the constant stock for stop check geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe constant stock value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStopCheckFaceStock ( double  newValue)

Sets the face stop for start check geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe face stock value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStopCheckRadialStock ( double  newValue)

Sets the radial stock for stop check geometry
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe radial stock value
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStopPoint ( NXOpen::Point newValue)

Sets the stop point
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe stop point
void NXOpen::CAM::TeachmodeProfileMoveBuilder::SetStopPositionMethod ( NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods  newValue)

Sets the stop position method
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe stop position method
NXOpen::CAM::Boundary* NXOpen::CAM::TeachmodeProfileMoveBuilder::StartCheckBoundary ( )

Returns the start check boundary builder
Created in NX9.0.2.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::StartCheckConstantStock ( )

Returns the constant stock for start check geometry
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::StartCheckFaceStock ( )

Returns the face stock for start check geometry
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::StartCheckRadialStock ( )

Returns the radial stock for start check geometry
Created in NX7.5.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::TeachmodeProfileMoveBuilder::StartPoint ( )

Returns the start point
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods NXOpen::CAM::TeachmodeProfileMoveBuilder::StartPositionMethod ( )

Returns the start position method
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopBeforeBoundaryOffset ( )

Returns the start and stop before boundary offset status
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::StopCheckConstantStock ( )

Returns the constant stock for stop check geometry
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::StopCheckFaceStock ( )

Returns the face stop for start check geometry
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeProfileMoveBuilder::StopCheckRadialStock ( )

Returns the radial stock for stop check geometry
Created in NX7.5.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::TeachmodeProfileMoveBuilder::StopPoint ( )

Returns the stop point
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeProfileMoveBuilder::StartStopPositionMethods NXOpen::CAM::TeachmodeProfileMoveBuilder::StopPositionMethod ( )

Returns the stop position method
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::Inheritable2dLength* NXOpen::CAM::TeachmodeProfileMoveBuilder::Tolerances ( )

Returns the Tolerances
Created in NX7.5.0.



License requirements : None


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