BooleanOperation Class — NXOpen Python API Reference 12.0.0 documentation

# BooleanOperation Class

class `NXOpen.GeometricUtilities.``BooleanOperation`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a boolean operation .

  New in version NX3.0.1.

# Properties

Property | Description
--- | ---
Tag | Returns the Tag for this object.
Type | Returns or sets the boolean operation type

# Methods

Method | Description
--- | ---
GetBooleanOperationAndBody | Get the Boolean operation type and target body
GetTargetBodies | Get the target bodies
SetBooleanOperationAndBody | Set the Boolean operation type and target body
SetTargetBodies | Set the target bodies
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

BooleanOperationBooleanType Enumeration | Boolean operation type.

# Property Detail

## Type

`BooleanOperation.``Type`

  Returns or sets the boolean operation type

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

  Getter Method

  Signature `Type`

  Returns: | boolean type
  Return type: | `NXOpen.GeometricUtilities.BooleanOperationBooleanType`

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.GeometricUtilities.BooleanOperationBooleanType`) – boolean type

  New in version NX4.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## GetBooleanOperationAndBody

`BooleanOperation.``GetBooleanOperationAndBody`

  Get the Boolean operation type and target body

  Signature `GetBooleanOperationAndBody()`

  Returns: | a tuple
  Return type: | A tuple consisting of (type, targetBody). type is a `NXOpen.GeometricUtilities.BooleanOperationBooleanType`. boolean type targetBody is a `NXOpen.Body`. target body

  New in version NX3.0.1.

  Deprecated since version NX4.0.0: Use `GeometricUtilities.BooleanOperation.Type()` and `GeometricUtilities.BooleanOperation.GetTargetBodies()` instead.

  License requirements: None.

## GetTargetBodies

`BooleanOperation.``GetTargetBodies`

  Get the target bodies

  Signature `GetTargetBodies()`

  Returns: | target bodies of boolean
  Return type: | list of `NXOpen.Body`

  New in version NX4.0.0.

  License requirements: None.

## SetBooleanOperationAndBody

`BooleanOperation.``SetBooleanOperationAndBody`

  Set the Boolean operation type and target body

  Signature `SetBooleanOperationAndBody(type, targetBody)`

  Parameters:

  - type (`NXOpen.GeometricUtilities.BooleanOperationBooleanType`) – boolean type
  - targetBody (`NXOpen.Body`) – target body

  New in version NX3.0.1.

  Deprecated since version NX4.0.0: Use `GeometricUtilities.BooleanOperation.Type()` and `GeometricUtilities.BooleanOperation.SetTargetBodies()` instead.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## SetTargetBodies

`BooleanOperation.``SetTargetBodies`

  Set the target bodies

  Signature `SetTargetBodies(targetBodies)`

  Parameters: | targetBodies (list of `NXOpen.Body`) – target bodies of boolean

  New in version NX4.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## Validate

`BooleanOperation.``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.