NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::CAM::AngularAboutAxisMoveBuilder Class Reference

Represents the angular about axis builder. More...

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

Public Types

enum  MoveIntent { MoveIntentAbsolute, MoveIntentIncremental }
 The angular move intent. 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::ExpressionDoubleAxisValueX ()
 Returns the x builder
Created in NX12.0.2. More...
 
NXOpen::CAM::ExpressionDoubleAxisValueY ()
 Returns the y builder
Created in NX12.0.2. More...
 
NXOpen::CAM::ExpressionDoubleDeltaX ()
 Returns the delta x builder
More...
 
NXOpen::CAM::ExpressionDoubleDeltaY ()
 Returns the delta y builder
More...
 
NXOpen::CAM::ExpressionDoubleHelicalPitch ()
 Returns the helical pitch
Created in NX12.0.1. More...
 
NXOpen::CAM::AngularAboutAxisMoveBuilder::MoveIntent Intent ()
 Returns the move intent
Created in NX12.0.2. More...
 
void SetIntent (NXOpen::CAM::AngularAboutAxisMoveBuilder::MoveIntent intent)
 Sets the move intent
Created in NX12.0.2. More...
 
NXOpen::CAM::ExpressionDoubleSpiralPitch ()
 Returns the spiral pitch
Created in NX12.0.1. More...
 
NXOpen::CAM::ExpressionDoubleSweepAngle ()
 Returns the sweep angle builder
Created in NX12.0.1. 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 angular about axis builder.

The helical pitch property is valid only for helical and conical builder objects. The spiral pitch is valid only for spiral and conical builder objects.
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateAngularConicalMoveBuilder

Created in NX12.0.1.

Member Enumeration Documentation

The angular move intent.

Enumerator
MoveIntentAbsolute 

Absolute coordinates.

MoveIntentIncremental 

Incremental coordinates.

Member Function Documentation

NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::AxisValueX ( )

Returns the x builder
Created in NX12.0.2.



License requirements : None

NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::AxisValueY ( )

Returns the y builder
Created in NX12.0.2.



License requirements : None

NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::DeltaX ( )

Returns the delta x builder

Deprecated:
Deprecated in NX12.0.2.

Please use CAM::AngularAboutAxisMoveBuilder::AxisValueX instead.


Created in NX12.0.1.

License requirements : None

NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::DeltaY ( )

Returns the delta y builder

Deprecated:
Deprecated in NX12.0.2.

Please use CAM::AngularAboutAxisMoveBuilder::AxisValueY instead.


Created in NX12.0.1.

License requirements : None

NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::HelicalPitch ( )

Returns the helical pitch
Created in NX12.0.1.



License requirements : None

NXOpen::CAM::AngularAboutAxisMoveBuilder::MoveIntent NXOpen::CAM::AngularAboutAxisMoveBuilder::Intent ( )

Returns the move intent
Created in NX12.0.2.



License requirements : None

void NXOpen::CAM::AngularAboutAxisMoveBuilder::SetIntent ( NXOpen::CAM::AngularAboutAxisMoveBuilder::MoveIntent  intent)

Sets the move intent
Created in NX12.0.2.



License requirements : None

Parameters
intentintent
NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::SpiralPitch ( )

Returns the spiral pitch
Created in NX12.0.1.



License requirements : None

NXOpen::CAM::ExpressionDouble* NXOpen::CAM::AngularAboutAxisMoveBuilder::SweepAngle ( )

Returns the sweep angle builder
Created in NX12.0.1.



License requirements : None


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