BoundarySetPlanarMill Class — NXOpen Python API Reference 12.0.0 documentation

# BoundarySetPlanarMill Class

class `NXOpen.CAM.``BoundarySetPlanarMill`

  Bases: `NXOpen.CAM.BoundarySet`

  Represents a boundary set for the planar mill/surface contour operation

  To create a new instance of this class, use `NXOpen.CAM.Boundary.CreateBoundarySetPlanarMill()`

  New in version NX11.0.1.

# Properties

Property | Description
--- | ---
BlankDistance | Returns or sets the blank_distance
BoundaryMemberList | Returns the boundary member list
BoundaryType | Returns or sets the boundary type
CustomBlankDistance | Returns or sets the blank distance
CustomFeed | Returns or sets the feed rate toggle
CustomOffset | Returns or sets the flag whether this boundary has custom offset activated
CustomStock | Returns or sets the flag whether this boundary has custom stock activated
CustomTolerance | Returns or sets the tolerance toggle
FeedUnit | Returns or sets the feed rate unit
FeedValue | Returns or sets the feed rate value
InTolerance | Returns or sets the in tolerance
Offset | Returns or sets the offset value
OffsetIntent | Returns or sets the offset intent
OutTolerance | Returns or sets the out tolerance
Plane | Returns or sets the boundary plane
PlaneType | Returns or sets the boundary plane type
PointList | Returns the points list
SelectObject | Returns the select object
Stock | Returns or sets the stock value
Tag | Returns the Tag for this object.
ToolPosition | Returns or sets the tool position
ToolSide | Returns or sets the tool side

# Methods

Method | Description
--- | ---
AppendCurves | Add curves to the boundary
CreateBoundaryMemberSet | Create an empty boundary member set
CreateBoundaryMemberSetPlanarMill | Create an empty custom member data set for a planar mill/surface contour boundary
CreateCurveBoundaryFromPermanent | Create curve boundary from permanent one
ExtendOrTrimEndPoint | Trim or extend the end point of a closed boundary
ExtendOrTrimStartPoint | Trim or extend the start point of an open boundary
MoveStartPoint | Move the start point of a closed boundary
RemoveCurves | Remove curves from the boundary

# Enumerations

BoundarySetPlanarMillFeedUnitTypes Enumeration | the types available for the feed rate unit
BoundarySetPlanarMillTrimExtendPosition Enumeration | the boundary position where to trim or to extend

# Property Detail

## BlankDistance

`BoundarySetPlanarMill.``BlankDistance`

  Returns or sets the blank_distance

  `-------------------------------------`

  Getter Method

  Signature `BlankDistance`

  Returns: |
  Return type: | float

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BlankDistance`

  Parameters: | newValue (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## CustomBlankDistance

`BoundarySetPlanarMill.``CustomBlankDistance`

  Returns or sets the blank distance

  `-------------------------------------`

  Getter Method

  Signature `CustomBlankDistance`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CustomBlankDistance`

  Parameters: | newValue (bool) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## CustomFeed

`BoundarySetPlanarMill.``CustomFeed`

  Returns or sets the feed rate toggle

  `-------------------------------------`

  Getter Method

  Signature `CustomFeed`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CustomFeed`

  Parameters: | newValue (bool) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## CustomStock

`BoundarySetPlanarMill.``CustomStock`

  Returns or sets the flag whether this boundary has custom stock activated

  `-------------------------------------`

  Getter Method

  Signature `CustomStock`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CustomStock`

  Parameters: | newValue (bool) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## CustomTolerance

`BoundarySetPlanarMill.``CustomTolerance`

  Returns or sets the tolerance toggle

  `-------------------------------------`

  Getter Method

  Signature `CustomTolerance`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CustomTolerance`

  Parameters: | newValue (bool) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## FeedUnit

`BoundarySetPlanarMill.``FeedUnit`

  Returns or sets the feed rate unit

  `-------------------------------------`

  Getter Method

  Signature `FeedUnit`

  Returns: |
  Return type: | `NXOpen.CAM.BoundarySetPlanarMillFeedUnitTypes`

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FeedUnit`

  Parameters: | newUnit (`NXOpen.CAM.BoundarySetPlanarMillFeedUnitTypes`) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## FeedValue

`BoundarySetPlanarMill.``FeedValue`

  Returns or sets the feed rate value

  `-------------------------------------`

  Getter Method

  Signature `FeedValue`

  Returns: |
  Return type: | float

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FeedValue`

  Parameters: | newValue (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## InTolerance

`BoundarySetPlanarMill.``InTolerance`

  Returns or sets the in tolerance

  `-------------------------------------`

  Getter Method

  Signature `InTolerance`

  Returns: |
  Return type: | float

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InTolerance`

  Parameters: | newValue (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## OutTolerance

`BoundarySetPlanarMill.``OutTolerance`

  Returns or sets the out tolerance

  `-------------------------------------`

  Getter Method

  Signature `OutTolerance`

  Returns: |
  Return type: | float

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OutTolerance`

  Parameters: | newValue (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## Stock

`BoundarySetPlanarMill.``Stock`

  Returns or sets the stock value

  `-------------------------------------`

  Getter Method

  Signature `Stock`

  Returns: |
  Return type: | float

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Stock`

  Parameters: | newValue (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## CreateBoundaryMemberSetPlanarMill

`BoundarySetPlanarMill.``CreateBoundaryMemberSetPlanarMill`

  Create an empty custom member data set for a planar mill/surface contour boundary

  Signature `CreateBoundaryMemberSetPlanarMill()`

  Returns: |
  Return type: | `NXOpen.CAM.BoundaryMemberSetPlanarMill`

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## CreateCurveBoundaryFromPermanent

`BoundarySetPlanarMill.``CreateCurveBoundaryFromPermanent`

  Create curve boundary from permanent one

  Signature `CreateCurveBoundaryFromPermanent()`

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## ExtendOrTrimEndPoint

`BoundarySetPlanarMill.``ExtendOrTrimEndPoint`

  Trim or extend the end point of a closed boundary

  Signature `ExtendOrTrimEndPoint(distance)`

  Parameters: | distance (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## ExtendOrTrimStartPoint

`BoundarySetPlanarMill.``ExtendOrTrimStartPoint`

  Trim or extend the start point of an open boundary

  Signature `ExtendOrTrimStartPoint(distance)`

  Parameters: | distance (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)

## MoveStartPoint

`BoundarySetPlanarMill.``MoveStartPoint`

  Move the start point of a closed boundary

  Signature `MoveStartPoint(bndSet, distance)`

  Parameters:

  - bndSet (`NXOpen.CAM.BoundaryMemberSetPlanarMill`) –
  - distance (float) –

  New in version NX11.0.1.

  License requirements: cam_base (“CAM BASE”)