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

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

Created in NX7.5.0. More...

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

Public Types

enum  CurveToolPositionTypes { CurveToolPositionTypesTo, CurveToolPositionTypesOn, CurveToolPositionTypesPast }
 the types for positioning to curves More...
 
enum  EndPositionTypes { EndPositionTypesPoint, EndPositionTypesCurves }
 the end position definition types More...
 
enum  InitialRetractTypes { InitialRetractTypesNone, InitialRetractTypesLinearAuto, InitialRetractTypesLinear }
 the initial retract choices More...
 
enum  MoveTypes {
  MoveTypesDirect, MoveTypesRadial, MoveTypesAxial, MoveTypesRadialAxial,
  MoveTypesAxialRadial
}
 the movement types 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

NXOpen::CAM::TeachmodeLinearMoveBuilder::EndPositionTypes EndPositionType ()
 Returns the Type of End Position Definition
Created in NX7.5.0. More...
 
NXOpen::NXObjectFirstCurve ()
 Returns the First Curve
Created in NX7.5.0. More...
 
double FirstCurveStock ()
 Returns the Stock on first Curve
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes FirstCurveToolPosition ()
 Returns the Tool Position to first Curve
Created in NX7.5.0. More...
 
double InitialRetractAngle ()
 Returns the initial retract angle
Created in NX7.5.0. More...
 
double InitialRetractDistance ()
 Returns the initial retract distance
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractTypes InitialRetractType ()
 Returns the Initial Retract Type
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeLinearMoveBuilder::MoveTypes MoveType ()
 Returns the Movement Type
Created in NX7.5.0. More...
 
NXOpen::PointPoint ()
 Returns the Point
Created in NX7.5.0. More...
 
NXOpen::NXObjectSecondCurve ()
 Returns the Second Curve
Created in NX7.5.0. More...
 
double SecondCurveStock ()
 Returns the Stock on second Curve
Created in NX7.5.0. More...
 
NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes SecondCurveToolPosition ()
 Returns the Tool Position to second Curve
Created in NX7.5.0. More...
 
void SetEndPositionType (NXOpen::CAM::TeachmodeLinearMoveBuilder::EndPositionTypes newValue)
 Sets the Type of End Position Definition
Created in NX7.5.0. More...
 
void SetFirstCurve (NXOpen::NXObject *newValue)
 Sets the First Curve
Created in NX7.5.0. More...
 
void SetFirstCurveStock (double newValue)
 Sets the Stock on first Curve
Created in NX7.5.0. More...
 
void SetFirstCurveToolPosition (NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes newValue)
 Sets the Tool Position to first Curve
Created in NX7.5.0. More...
 
void SetInitialRetractAngle (double newValue)
 Sets the initial retract angle
Created in NX7.5.0. More...
 
void SetInitialRetractDistance (double newValue)
 Sets the initial retract distance
Created in NX7.5.0. More...
 
void SetInitialRetractType (NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractTypes newValue)
 Sets the Initial Retract Type
Created in NX7.5.0. More...
 
void SetMoveType (NXOpen::CAM::TeachmodeLinearMoveBuilder::MoveTypes newValue)
 Sets the Movement Type
Created in NX7.5.0. More...
 
void SetPoint (NXOpen::Point *newValue)
 Sets the Point
Created in NX7.5.0. More...
 
void SetSecondCurve (NXOpen::NXObject *newValue)
 Sets the Second Curve
Created in NX7.5.0. More...
 
void SetSecondCurveStock (double newValue)
 Sets the Stock on second Curve
Created in NX7.5.0. More...
 
void SetSecondCurveToolPosition (NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes newValue)
 Sets the Tool Position to second Curve
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 TeachmodeLinearMove
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateTeachmodeTurningBuilder

Created in NX7.5.0.


Member Enumeration Documentation

the types for positioning to curves

Enumerator
CurveToolPositionTypesTo 

To Curve.

CurveToolPositionTypesOn 

On Curve.

CurveToolPositionTypesPast 

Past Curve.

the end position definition types

Enumerator
EndPositionTypesPoint 

Point.

EndPositionTypesCurves 

Curves.

the initial retract choices

Enumerator
InitialRetractTypesNone 

None.

InitialRetractTypesLinearAuto 

Automatic Linear.

InitialRetractTypesLinear 

Linear.

the movement types

Enumerator
MoveTypesDirect 

Direct.

MoveTypesRadial 

Radial only.

MoveTypesAxial 

Axial only.

MoveTypesRadialAxial 

Radial then Axial.

MoveTypesAxialRadial 

Axial then Radial.

Member Function Documentation

NXOpen::CAM::TeachmodeLinearMoveBuilder::EndPositionTypes NXOpen::CAM::TeachmodeLinearMoveBuilder::EndPositionType ( )

Returns the Type of End Position Definition
Created in NX7.5.0.



License requirements : None

NXOpen::NXObject* NXOpen::CAM::TeachmodeLinearMoveBuilder::FirstCurve ( )

Returns the First Curve
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeLinearMoveBuilder::FirstCurveStock ( )

Returns the Stock on first Curve
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes NXOpen::CAM::TeachmodeLinearMoveBuilder::FirstCurveToolPosition ( )

Returns the Tool Position to first Curve
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractAngle ( )

Returns the initial retract angle
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractDistance ( )

Returns the initial retract distance
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractTypes NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractType ( )

Returns the Initial Retract Type
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeLinearMoveBuilder::MoveTypes NXOpen::CAM::TeachmodeLinearMoveBuilder::MoveType ( )

Returns the Movement Type
Created in NX7.5.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::TeachmodeLinearMoveBuilder::Point ( )

Returns the Point
Created in NX7.5.0.



License requirements : None

NXOpen::NXObject* NXOpen::CAM::TeachmodeLinearMoveBuilder::SecondCurve ( )

Returns the Second Curve
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::TeachmodeLinearMoveBuilder::SecondCurveStock ( )

Returns the Stock on second Curve
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes NXOpen::CAM::TeachmodeLinearMoveBuilder::SecondCurveToolPosition ( )

Returns the Tool Position to second Curve
Created in NX7.5.0.



License requirements : None

void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetEndPositionType ( NXOpen::CAM::TeachmodeLinearMoveBuilder::EndPositionTypes  newValue)

Sets the Type of End Position Definition
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe end position type
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetFirstCurve ( NXOpen::NXObject newValue)

Sets the First Curve
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe first curve
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetFirstCurveStock ( double  newValue)

Sets the Stock on first Curve
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe stock on first curve
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetFirstCurveToolPosition ( NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes  newValue)

Sets the Tool Position to first Curve
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe tool position type
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetInitialRetractAngle ( double  newValue)

Sets the initial retract angle
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe initial retract angle
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetInitialRetractDistance ( double  newValue)

Sets the initial retract distance
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe initial retract distance
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetInitialRetractType ( NXOpen::CAM::TeachmodeLinearMoveBuilder::InitialRetractTypes  newValue)

Sets the Initial Retract Type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe initial retract type
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetMoveType ( NXOpen::CAM::TeachmodeLinearMoveBuilder::MoveTypes  newValue)

Sets the Movement Type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe move type
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetPoint ( NXOpen::Point newValue)

Sets the Point
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe point
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetSecondCurve ( NXOpen::NXObject newValue)

Sets the Second Curve
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe second curve
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetSecondCurveStock ( double  newValue)

Sets the Stock on second Curve
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe stock on second curve
void NXOpen::CAM::TeachmodeLinearMoveBuilder::SetSecondCurveToolPosition ( NXOpen::CAM::TeachmodeLinearMoveBuilder::CurveToolPositionTypes  newValue)

Sets the Tool Position to second Curve
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe tool position type

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