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

Represents the Rotary Polar Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateRotaryPolarMoveBuilder

Created in NX5.0.0. More...

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

Public Types

enum  LockAxisDirection { LockAxisDirectionX, LockAxisDirectionY, LockAxisDirectionZ }
 the lock axis type More...
 
enum  LockPlaneType { LockPlaneTypeXy, LockPlaneTypeYz, LockPlaneTypeZx }
 the lock plane type 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::RotaryPolarMoveBuilder::LockAxisDirection LockAxis ()
 Returns the lock axis
Created in NX5.0.0. More...
 
NXOpen::CAM::RotaryPolarMoveBuilder::LockPlaneType LockPlane ()
 Returns the lock plane
Created in NX5.0.0. More...
 
double LockPos ()
 Returns the lock position
Created in NX5.0.0. More...
 
NXOpen::CAM::OffsetDataBuilderOffsetData ()
 Returns the offset point builder
Created in NX5.0.0. More...
 
NXOpen::PointPoint ()
 Returns the location
Created in NX5.0.0. More...
 
NXOpen::CAM::RoundPointBuilderRoundPoint ()
 Returns the round point builder
Created in NX5.0.0. More...
 
void SetLockAxis (NXOpen::CAM::RotaryPolarMoveBuilder::LockAxisDirection lockAxis)
 Sets the lock axis
Created in NX5.0.0. More...
 
void SetLockPlane (NXOpen::CAM::RotaryPolarMoveBuilder::LockPlaneType lockPlane)
 Sets the lock plane
Created in NX5.0.0. More...
 
void SetLockPos (double lockPosition)
 Sets the lock position
Created in NX5.0.0. More...
 
void SetPoint (NXOpen::Point *location)
 Sets the location
Created in NX5.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 Rotary Polar Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateRotaryPolarMoveBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the lock axis type

Enumerator
LockAxisDirectionX 

X-Axis.

LockAxisDirectionY 

Y-Axis.

LockAxisDirectionZ 

Z-Axis.

the lock plane type

Enumerator
LockPlaneTypeXy 

XY-Plane.

LockPlaneTypeYz 

YZ-Plane.

LockPlaneTypeZx 

ZX-Plane.

Member Function Documentation

NXOpen::CAM::RotaryPolarMoveBuilder::LockAxisDirection NXOpen::CAM::RotaryPolarMoveBuilder::LockAxis ( )

Returns the lock axis
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::RotaryPolarMoveBuilder::LockPlaneType NXOpen::CAM::RotaryPolarMoveBuilder::LockPlane ( )

Returns the lock plane
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::RotaryPolarMoveBuilder::LockPos ( )

Returns the lock position
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::OffsetDataBuilder* NXOpen::CAM::RotaryPolarMoveBuilder::OffsetData ( )

Returns the offset point builder
Created in NX5.0.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::RotaryPolarMoveBuilder::Point ( )

Returns the location
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::RoundPointBuilder* NXOpen::CAM::RotaryPolarMoveBuilder::RoundPoint ( )

Returns the round point builder
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::RotaryPolarMoveBuilder::SetLockAxis ( NXOpen::CAM::RotaryPolarMoveBuilder::LockAxisDirection  lockAxis)

Sets the lock axis
Created in NX5.0.0.



License requirements : None

Parameters
lockAxislockaxis
void NXOpen::CAM::RotaryPolarMoveBuilder::SetLockPlane ( NXOpen::CAM::RotaryPolarMoveBuilder::LockPlaneType  lockPlane)

Sets the lock plane
Created in NX5.0.0.



License requirements : None

Parameters
lockPlanelockplane
void NXOpen::CAM::RotaryPolarMoveBuilder::SetLockPos ( double  lockPosition)

Sets the lock position
Created in NX5.0.0.



License requirements : None

Parameters
lockPositionlockposition
void NXOpen::CAM::RotaryPolarMoveBuilder::SetPoint ( NXOpen::Point location)

Sets the location
Created in NX5.0.0.



License requirements : None

Parameters
locationlocation

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