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

Represents the Circular Move To Point Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateCircularAboutAxisMoveBuilder

Created in NX5.0.0. More...

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

Public Types

enum  AxisType { AxisTypeTool, AxisTypeVector }
 the axis type More...
 
enum  EndType { EndTypeAngle, EndTypePoint }
 the motion end type More...
 
enum  ExtensionType { ExtensionTypeAngle, ExtensionTypeDistance }
 the extension 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::DirectionArcAxis ()
 Returns the arc axis
Created in NX5.0.0. More...
 
NXOpen::CAM::CircularAboutAxisMoveBuilder::AxisType ArcAxisType ()
 Returns the axis type
Created in NX5.0.0. More...
 
NXOpen::CAM::CircularAboutAxisMoveBuilder::ExtensionType ArcExtendMethod ()
 Returns the arc extension type
Created in NX5.0.0. More...
 
NXOpen::PointCenterPoint ()
 Returns the center
Created in NX5.0.0. More...
 
NXOpen::PointEndPoint ()
 Returns the arc end point
Created in NX5.0.0. More...
 
double ExtendAngle ()
 Returns the extend angle
Created in NX5.0.0. More...
 
double ExtendDistance ()
 Returns the extend distance
Created in NX5.0.0. More...
 
NXOpen::CAM::CircularAboutAxisMoveBuilder::EndType MotionEndType ()
 Returns the arc end type
Created in NX5.0.0. More...
 
void SetArcAxis (NXOpen::Direction *vec)
 Sets the arc axis
Created in NX5.0.0. More...
 
void SetArcAxisType (NXOpen::CAM::CircularAboutAxisMoveBuilder::AxisType axisType)
 Sets the axis type
Created in NX5.0.0. More...
 
void SetArcExtendMethod (NXOpen::CAM::CircularAboutAxisMoveBuilder::ExtensionType arcExtendMethod)
 Sets the arc extension type
Created in NX5.0.0. More...
 
void SetCenterPoint (NXOpen::Point *location)
 Sets the center
Created in NX5.0.0. More...
 
void SetEndPoint (NXOpen::Point *location)
 Sets the arc end point
Created in NX5.0.0. More...
 
void SetExtendAngle (double extendAngle)
 Sets the extend angle
Created in NX5.0.0. More...
 
void SetExtendDistance (double extendDistance)
 Sets the extend distance
Created in NX5.0.0. More...
 
void SetMotionEndType (NXOpen::CAM::CircularAboutAxisMoveBuilder::EndType arcEndType)
 Sets the arc end type
Created in NX5.0.0. More...
 
void SetSweepAngle (double sweepAngle)
 Sets the sweep angle
Created in NX5.0.0. More...
 
double SweepAngle ()
 Returns the sweep angle
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 Circular Move To Point Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateCircularAboutAxisMoveBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the axis type

Enumerator
AxisTypeTool 

Tool Axis.

AxisTypeVector 

Vector.

the motion end type

Enumerator
EndTypeAngle 

Angle.

EndTypePoint 

Point.

the extension type

Enumerator
ExtensionTypeAngle 

Angle.

ExtensionTypeDistance 

Distance.

Member Function Documentation

NXOpen::Direction* NXOpen::CAM::CircularAboutAxisMoveBuilder::ArcAxis ( )

Returns the arc axis
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::CircularAboutAxisMoveBuilder::AxisType NXOpen::CAM::CircularAboutAxisMoveBuilder::ArcAxisType ( )

Returns the axis type
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::CircularAboutAxisMoveBuilder::ExtensionType NXOpen::CAM::CircularAboutAxisMoveBuilder::ArcExtendMethod ( )

Returns the arc extension type
Created in NX5.0.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::CircularAboutAxisMoveBuilder::CenterPoint ( )

Returns the center
Created in NX5.0.0.



License requirements : None

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

Returns the arc end point
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::CircularAboutAxisMoveBuilder::ExtendAngle ( )

Returns the extend angle
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::CircularAboutAxisMoveBuilder::ExtendDistance ( )

Returns the extend distance
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::CircularAboutAxisMoveBuilder::EndType NXOpen::CAM::CircularAboutAxisMoveBuilder::MotionEndType ( )

Returns the arc end type
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetArcAxis ( NXOpen::Direction vec)

Sets the arc axis
Created in NX5.0.0.



License requirements : None

Parameters
vecvec
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetArcAxisType ( NXOpen::CAM::CircularAboutAxisMoveBuilder::AxisType  axisType)

Sets the axis type
Created in NX5.0.0.



License requirements : None

Parameters
axisTypeaxistype
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetArcExtendMethod ( NXOpen::CAM::CircularAboutAxisMoveBuilder::ExtensionType  arcExtendMethod)

Sets the arc extension type
Created in NX5.0.0.



License requirements : None

Parameters
arcExtendMethodarcextendmethod
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetCenterPoint ( NXOpen::Point location)

Sets the center
Created in NX5.0.0.



License requirements : None

Parameters
locationlocation
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetEndPoint ( NXOpen::Point location)

Sets the arc end point
Created in NX5.0.0.



License requirements : None

Parameters
locationlocation
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetExtendAngle ( double  extendAngle)

Sets the extend angle
Created in NX5.0.0.



License requirements : None

Parameters
extendAngleextendangle
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetExtendDistance ( double  extendDistance)

Sets the extend distance
Created in NX5.0.0.



License requirements : None

Parameters
extendDistanceextenddistance
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetMotionEndType ( NXOpen::CAM::CircularAboutAxisMoveBuilder::EndType  arcEndType)

Sets the arc end type
Created in NX5.0.0.



License requirements : None

Parameters
arcEndTypearcendtype
void NXOpen::CAM::CircularAboutAxisMoveBuilder::SetSweepAngle ( double  sweepAngle)

Sets the sweep angle
Created in NX5.0.0.



License requirements : None

Parameters
sweepAnglesweepangle
double NXOpen::CAM::CircularAboutAxisMoveBuilder::SweepAngle ( )

Returns the sweep angle
Created in NX5.0.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.