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

Represents the Follow Part Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateFollowPartMoveBuilder
Default values. More...

Inheritance diagram for NXOpen::CAM::FollowPartMoveBuilder:
NXOpen::CAM::FollowGeometryMoveBuilder NXOpen::CAM::MoveBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MoveDirectionTypes { MoveDirectionTypesUndefined, MoveDirectionTypesForward, MoveDirectionTypesReverse }
 Available types for manual move path direction in GMC operation. More...
 

Public Member Functions

NXOpen::PointEndPoint ()
 Returns the end location
Created in NX8.0.0. More...
 
NXOpen::CAM::FollowPartMoveBuilder::MoveDirectionTypes MoveDirection ()
 Returns the move direction
Created in NX8.0.0. More...
 
void SetEndPoint (NXOpen::Point *location)
 Sets the end location
Created in NX8.0.0. More...
 
void SetMoveDirection (NXOpen::CAM::FollowPartMoveBuilder::MoveDirectionTypes direction)
 Sets the move direction
Created in NX8.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::FollowGeometryMoveBuilder
NXOpen::CAM::InheritableToolDepBuilderEndExtension ()
 Returns the end extension
Created in NX8.0.0. More...
 
void SetEndExtension (NXOpen::CAM::InheritableToolDepBuilder *builderTag)
 Sets the end extension
Created in NX8.0.0. More...
 
void SetStartExtension (NXOpen::CAM::InheritableToolDepBuilder *builderTag)
 Sets the start extension
Created in NX8.0.0. More...
 
void SetStartPoint (NXOpen::Point *location)
 Sets the start location
Created in NX8.0.0. More...
 
void SetStartToolAxis (NXOpen::Direction *vec)
 Sets the start tool axis
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderStartExtension ()
 Returns the start extension
Created in NX8.0.0. More...
 
NXOpen::PointStartPoint ()
 Returns the start location
Created in NX8.0.0. More...
 
NXOpen::DirectionStartToolAxis ()
 Returns the start tool axis
Created in NX8.0.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 the Follow Part Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateFollowPartMoveBuilder
Default values.

Property Value

FeedRate

0.0

FeedType

Motion

FeedUnit

None

MotionType

Cut

MoveDirection

Forward

ProtectedMove

true


Created in NX8.0.0.

Member Enumeration Documentation

Available types for manual move path direction in GMC operation.

Enumerator
MoveDirectionTypesUndefined 

undefined

MoveDirectionTypesForward 

forward

MoveDirectionTypesReverse 

reverse

Member Function Documentation

NXOpen::Point* NXOpen::CAM::FollowPartMoveBuilder::EndPoint ( )

Returns the end location
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::FollowPartMoveBuilder::MoveDirectionTypes NXOpen::CAM::FollowPartMoveBuilder::MoveDirection ( )

Returns the move direction
Created in NX8.0.0.



License requirements : None

void NXOpen::CAM::FollowPartMoveBuilder::SetEndPoint ( NXOpen::Point location)

Sets the end location
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
locationlocation
void NXOpen::CAM::FollowPartMoveBuilder::SetMoveDirection ( NXOpen::CAM::FollowPartMoveBuilder::MoveDirectionTypes  direction)

Sets the move direction
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
directiondirection

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