PenetrationRequestBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PenetrationRequestBuilder Class

class `NXOpen.Features.ShipDesign.``PenetrationRequestBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.ShipDesign.PenetrationRequest` builder

  To create a new instance of this class, use `NXOpen.Features.ShipDesign.PenetrationRequestCollection.CreatePenetrationRequestBuilder()`

  Default values.

  Property | Value
  --- | ---
  CompensationType | NotRequired
  CornerRadius.Value | 0 (millimeters part), 0 (inches part)
  CoutoutType | Circular
  Cut | 0
  Diameter.Value | 0 (millimeters part), 0 (inches part)
  DirectionType | PerpendiculartoStructure
  Hanger | 0
  Height.Value | 0 (millimeters part), 0 (inches part)
  Offset.Value | 0 (millimeters part), 0 (inches part)
  PenetrationType | PenetratingObject
  Radius.Value | 0 (millimeters part), 0 (inches part)
  RequestType | Single
  Spill | 0
  Width.Value | 0 (millimeters part), 0 (inches part)

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
CompensationNumber | Returns or sets the compensation number
CompensationType | Returns or sets the compensation type
CornerRadius | Returns the corner radius expression
CoutoutType | Returns or sets the coutout type
Cut | Returns or sets the cut
DialogType | Returns or sets the dialog type
Diameter | Returns the diameter expression
DirectionType | Returns or sets the direction
DueDate | Returns or sets the due date
Hanger | Returns or sets the hanger
HangerNumber | Returns or sets the hanger number
Height | Returns the height expression
HoleSubType | Returns or sets the hole sub-type
HoleType | Returns or sets the hole type
HorizontalDirection | Returns or sets the horizontal direction
ModifiedSketch | Returns or sets the modified sketch
Offset | Returns the offset expression
Orientation | Returns or sets the orientation
PenetrationType | Returns or sets the penetration type
Point | Returns or sets the penetrating point
Radius | Returns the radius expression
RequestName | Returns or sets the request name
RequestType | Returns or sets the request type
RouteObjectCollector | Returns the route object collector
RoutePenetrating | Returns the route penetrating
SelectedSegment | Returns or sets the selected segment
SelectionCompensation | Returns the selection compensation
SelectionHanger | Returns the selection hanger
SelectionStructure | Returns the selection structure
Sketch | Returns the sketch
Spill | Returns or sets the spill
Tag | Returns the Tag for this object.
Width | Returns the width expression

# Methods

Method | Description
--- | ---
AddAdjacentStructure | Adds adjacent structures
AddNonIntersectedStructure | Adds nonintersected structures
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.
GetRequestDescription | Returns the description
RemoveAllAdjacentStructures | Removes all adjacent structures
RemoveNonIntersectedStructures | Removes all nonintersected structures
SetApplyOffset | Sets the value that whether the offset is applied
SetOffsetValue | Sets the offset value
SetRequestDescription | Sets the description
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

PenetrationRequestBuilderRequestDialogType Enumeration | Represents the dialog type

# Property Detail

## CompensationNumber

`PenetrationRequestBuilder.``CompensationNumber`

  Returns or sets the compensation number

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

  Getter Method

  Signature `CompensationNumber`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CompensationNumber`

  Parameters: | stringCompensationNumber (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## CompensationType

`PenetrationRequestBuilder.``CompensationType`

  Returns or sets the compensation type

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

  Getter Method

  Signature `CompensationType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationRequestCompensationType`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CompensationType`

  Parameters: | enumCompensationType (`NXOpen.Features.ShipDesign.PenetrationRequestCompensationType`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## CornerRadius

`PenetrationRequestBuilder.``CornerRadius`

  Returns the corner radius expression

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

  Getter Method

  Signature `CornerRadius`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: None.

## CoutoutType

`PenetrationRequestBuilder.``CoutoutType`

  Returns or sets the coutout type

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

  Getter Method

  Signature `CoutoutType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationRequestCoutoutType`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CoutoutType`

  Parameters: | enumCoutoutType (`NXOpen.Features.ShipDesign.PenetrationRequestCoutoutType`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## Cut

`PenetrationRequestBuilder.``Cut`

  Returns or sets the cut

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

  Getter Method

  Signature `Cut`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Cut`

  Parameters: | toggleCut (bool) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## DialogType

`PenetrationRequestBuilder.``DialogType`

  Returns or sets the dialog type

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

  Getter Method

  Signature `DialogType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationRequestBuilderRequestDialogType`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DialogType`

  Parameters: | dialogType (`NXOpen.Features.ShipDesign.PenetrationRequestBuilderRequestDialogType`) –

  New in version NX8.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## Diameter

`PenetrationRequestBuilder.``Diameter`

  Returns the diameter expression

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

  Getter Method

  Signature `Diameter`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: None.

## DirectionType

`PenetrationRequestBuilder.``DirectionType`

  Returns or sets the direction

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

  Getter Method

  Signature `DirectionType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationRequestDirectionType`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DirectionType`

  Parameters: | enumDirection (`NXOpen.Features.ShipDesign.PenetrationRequestDirectionType`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## DueDate

`PenetrationRequestBuilder.``DueDate`

  Returns or sets the due date

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

  Getter Method

  Signature `DueDate`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DueDate`

  Parameters: | stringDueDate (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## Hanger

`PenetrationRequestBuilder.``Hanger`

  Returns or sets the hanger

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

  Getter Method

  Signature `Hanger`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Hanger`

  Parameters: | toggleHanger (bool) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## HangerNumber

`PenetrationRequestBuilder.``HangerNumber`

  Returns or sets the hanger number

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

  Getter Method

  Signature `HangerNumber`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HangerNumber`

  Parameters: | stringHangerNumber (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## Height

`PenetrationRequestBuilder.``Height`

  Returns the height expression

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

  Getter Method

  Signature `Height`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: None.

## HoleSubType

`PenetrationRequestBuilder.``HoleSubType`

  Returns or sets the hole sub-type

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

  Getter Method

  Signature `HoleSubType`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleSubType`

  Parameters: | stringHoleType (str) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## HoleType

`PenetrationRequestBuilder.``HoleType`

  Returns or sets the hole type

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

  Getter Method

  Signature `HoleType`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleType`

  Parameters: | stringHoleType (str) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## HorizontalDirection

`PenetrationRequestBuilder.``HorizontalDirection`

  Returns or sets the horizontal direction

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

  Getter Method

  Signature `HorizontalDirection`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HorizontalDirection`

  Parameters: | vectorHorizontalDirection (`NXOpen.Direction`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## ModifiedSketch

`PenetrationRequestBuilder.``ModifiedSketch`

  Returns or sets the modified sketch

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

  Getter Method

  Signature `ModifiedSketch`

  Returns: |
  Return type: | `NXOpen.Sketch`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ModifiedSketch`

  Parameters: | modifiedSketch (`NXOpen.Sketch`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## Offset

`PenetrationRequestBuilder.``Offset`

  Returns the offset expression

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

  Getter Method

  Signature `Offset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: None.

## Orientation

`PenetrationRequestBuilder.``Orientation`

  Returns or sets the orientation

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

  Getter Method

  Signature `Orientation`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Orientation`

  Parameters: | vectorOrientation (`NXOpen.Direction`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## PenetrationType

`PenetrationRequestBuilder.``PenetrationType`

  Returns or sets the penetration type

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

  Getter Method

  Signature `PenetrationType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationRequestPenetrationType`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PenetrationType`

  Parameters: | enumPenetrationType (`NXOpen.Features.ShipDesign.PenetrationRequestPenetrationType`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## Point

`PenetrationRequestBuilder.``Point`

  Returns or sets the penetrating point

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

  Getter Method

  Signature `Point`

  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Point`

  Parameters: | pointPenetrating (`NXOpen.Point`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## Radius

`PenetrationRequestBuilder.``Radius`

  Returns the radius expression

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

  Getter Method

  Signature `Radius`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: None.

## RequestName

`PenetrationRequestBuilder.``RequestName`

  Returns or sets the request name

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

  Getter Method

  Signature `RequestName`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RequestName`

  Parameters: | stringName (str) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## RequestType

`PenetrationRequestBuilder.``RequestType`

  Returns or sets the request type

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

  Getter Method

  Signature `RequestType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationRequestRequestType`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RequestType`

  Parameters: | enumRequestType (`NXOpen.Features.ShipDesign.PenetrationRequestRequestType`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## RouteObjectCollector

`PenetrationRequestBuilder.``RouteObjectCollector`

  Returns the route object collector

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

  Getter Method

  Signature `RouteObjectCollector`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX8.0.0.

  License requirements: None.

## RoutePenetrating

`PenetrationRequestBuilder.``RoutePenetrating`

  Returns the route penetrating

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

  Getter Method

  Signature `RoutePenetrating`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX8.0.0.

  License requirements: None.

## SelectedSegment

`PenetrationRequestBuilder.``SelectedSegment`

  Returns or sets the selected segment

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

  Getter Method

  Signature `SelectedSegment`

  Returns: |
  Return type: | `NXOpen.NXObject`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectedSegment`

  Parameters: | selectedSegment (`NXOpen.NXObject`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SelectionCompensation

`PenetrationRequestBuilder.``SelectionCompensation`

  Returns the selection compensation

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

  Getter Method

  Signature `SelectionCompensation`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX8.0.0.

  License requirements: None.

## SelectionHanger

`PenetrationRequestBuilder.``SelectionHanger`

  Returns the selection hanger

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

  Getter Method

  Signature `SelectionHanger`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX8.0.0.

  License requirements: None.

## SelectionStructure

`PenetrationRequestBuilder.``SelectionStructure`

  Returns the selection structure

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

  Getter Method

  Signature `SelectionStructure`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX8.0.0.

  License requirements: None.

## Sketch

`PenetrationRequestBuilder.``Sketch`

  Returns the sketch

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

  Getter Method

  Signature `Sketch`

  Returns: |
  Return type: | `NXOpen.Section`

  New in version NX8.0.0.

  License requirements: None.

## Spill

`PenetrationRequestBuilder.``Spill`

  Returns or sets the spill

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

  Getter Method

  Signature `Spill`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Spill`

  Parameters: | toggleSpill (bool) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## Width

`PenetrationRequestBuilder.``Width`

  Returns the width expression

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

  Getter Method

  Signature `Width`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.0.0.

  License requirements: None.

# Method Detail

## AddAdjacentStructure

`PenetrationRequestBuilder.``AddAdjacentStructure`

  Adds adjacent structures

  Signature `AddAdjacentStructure(adjacentStructure)`

  Parameters: | adjacentStructure (`NXOpen.Body`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AddNonIntersectedStructure

`PenetrationRequestBuilder.``AddNonIntersectedStructure`

  Adds nonintersected structures

  Signature `AddNonIntersectedStructure(structure)`

  Parameters: | structure (`NXOpen.Body`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## GetRequestDescription

`PenetrationRequestBuilder.``GetRequestDescription`

  Returns the description

  Signature `GetRequestDescription()`

  Returns: |
  Return type: | list of str

  New in version NX8.0.0.

  License requirements: None.

## RemoveAllAdjacentStructures

`PenetrationRequestBuilder.``RemoveAllAdjacentStructures`

  Removes all adjacent structures

  Signature `RemoveAllAdjacentStructures()`

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## RemoveNonIntersectedStructures

`PenetrationRequestBuilder.``RemoveNonIntersectedStructures`

  Removes all nonintersected structures

  Signature `RemoveNonIntersectedStructures()`

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetApplyOffset

`PenetrationRequestBuilder.``SetApplyOffset`

  Sets the value that whether the offset is applied

  Signature `SetApplyOffset(applyOffset)`

  Parameters: | applyOffset (bool) –

  New in version NX12.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetOffsetValue

`PenetrationRequestBuilder.``SetOffsetValue`

  Sets the offset value

  Signature `SetOffsetValue(offsetValue)`

  Parameters: | offsetValue (float) –

  New in version NX12.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetRequestDescription

`PenetrationRequestBuilder.``SetRequestDescription`

  Sets the description

  Signature `SetRequestDescription(stringDesc)`

  Parameters: | stringDesc (list of str) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## Validate

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