CircularAboutAxisMoveBuilder Class¶
-
class
NXOpen.CAM.CircularAboutAxisMoveBuilder¶ Bases:
NXOpen.CAM.MoveBuilderRepresents the Circular Move To Point Builder
To create a new instance of this class, use
NXOpen.CAM.MoveCollection.CreateCircularAboutAxisMoveBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| ArcAxis | Returns or sets the arc axis |
| ArcAxisType | Returns or sets the axis type |
| ArcExtendMethod | Returns or sets the arc extension type |
| CenterPoint | Returns or sets the center |
| EndPoint | Returns or sets the arc end point |
| ExtendAngle | Returns or sets the extend angle |
| ExtendDistance | Returns or sets the extend distance |
| FeedRate | Returns or sets the feed rate |
| FeedType | Returns or sets the feed type |
| FeedUnit | Returns or sets the feed unit |
| MotionEndType | Returns or sets the arc end type |
| MotionType | Returns or sets the motion type |
| NumberOfUserParameters | Returns the number of user parameters |
| ProtectedMove | Returns or sets the protected move status |
| SubopLabel | Returns or sets the subop label |
| SweepAngle | Returns or sets the sweep angle |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| GetUserParameter | Returns the custom parameter with the given name. |
| SetParent | Set parent |
| SetSibling | Set sibling |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| CircularAboutAxisMoveBuilderAxisType Enumeration | the axis type |
| CircularAboutAxisMoveBuilderEndType Enumeration | the motion end type |
| CircularAboutAxisMoveBuilderExtensionType Enumeration | the extension type |
Property Detail¶
ArcAxis¶
-
CircularAboutAxisMoveBuilder.ArcAxis¶ Returns or sets the arc axis
-------------------------------------Getter Method
Signature
ArcAxis()Returns: Return type: NXOpen.DirectionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ArcAxis(vec)Parameters: vec ( NXOpen.Direction) –New in version NX5.0.0.
License requirements: None.
ArcAxisType¶
-
CircularAboutAxisMoveBuilder.ArcAxisType¶ Returns or sets the axis type
-------------------------------------Getter Method
Signature
ArcAxisType()Returns: Return type: NXOpen.CAM.CircularAboutAxisMoveBuilderAxisTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ArcAxisType(axisType)Parameters: axisType ( NXOpen.CAM.CircularAboutAxisMoveBuilderAxisType) –New in version NX5.0.0.
License requirements: None.
ArcExtendMethod¶
-
CircularAboutAxisMoveBuilder.ArcExtendMethod¶ Returns or sets the arc extension type
-------------------------------------Getter Method
Signature
ArcExtendMethod()Returns: Return type: NXOpen.CAM.CircularAboutAxisMoveBuilderExtensionTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ArcExtendMethod(arcExtendMethod)Parameters: arcExtendMethod ( NXOpen.CAM.CircularAboutAxisMoveBuilderExtensionType) –New in version NX5.0.0.
License requirements: None.
CenterPoint¶
-
CircularAboutAxisMoveBuilder.CenterPoint¶ Returns or sets the center
-------------------------------------Getter Method
Signature
CenterPoint()Returns: Return type: NXOpen.PointNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CenterPoint(location)Parameters: location ( NXOpen.Point) –New in version NX5.0.0.
License requirements: None.
EndPoint¶
-
CircularAboutAxisMoveBuilder.EndPoint¶ Returns or sets the arc end point
-------------------------------------Getter Method
Signature
EndPoint()Returns: Return type: NXOpen.PointNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EndPoint(location)Parameters: location ( NXOpen.Point) –New in version NX5.0.0.
License requirements: None.
ExtendAngle¶
-
CircularAboutAxisMoveBuilder.ExtendAngle¶ Returns or sets the extend angle
-------------------------------------Getter Method
Signature
ExtendAngle()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExtendAngle(extendAngle)Parameters: extendAngle (float) – New in version NX5.0.0.
License requirements: None.
ExtendDistance¶
-
CircularAboutAxisMoveBuilder.ExtendDistance¶ Returns or sets the extend distance
-------------------------------------Getter Method
Signature
ExtendDistance()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExtendDistance(extendDistance)Parameters: extendDistance (float) – New in version NX5.0.0.
License requirements: None.
MotionEndType¶
-
CircularAboutAxisMoveBuilder.MotionEndType¶ Returns or sets the arc end type
-------------------------------------Getter Method
Signature
MotionEndType()Returns: Return type: NXOpen.CAM.CircularAboutAxisMoveBuilderEndTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MotionEndType(arcEndType)Parameters: arcEndType ( NXOpen.CAM.CircularAboutAxisMoveBuilderEndType) –New in version NX5.0.0.
License requirements: None.
SweepAngle¶
-
CircularAboutAxisMoveBuilder.SweepAngle¶ Returns or sets the sweep angle
-------------------------------------Getter Method
Signature
SweepAngle()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SweepAngle(sweepAngle)Parameters: sweepAngle (float) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
CircularAboutAxisMoveBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.