PenetrationUtils Class — NXOpen Python API Reference 12.0.0 documentation

# PenetrationUtils Class

class `NXOpen.Features.ShipDesign.``PenetrationUtils`

  Bases: `object`

  Contains various penetration utility methods

  To obtain an instance of this class, refer to `NXOpen.Features.ShipDesign.PenetrationManager`

  New in version NX8.0.0.

# Methods

Method | Description
--- | ---
AskAssociateRequests | Ask the associate requests
AskAttachments | Get the attachments in folder
AskCurrentSite | Ask current `NXOpen.Features.ShipDesign.PenetrationSite`
AskReferenceFolder | Get the reference folder `NXOpen.Features.ShipDesign.PenetrationFolder`
AskRequestLists | Ask current `NXOpen.Features.ShipDesign.PenetrationList`
AskRequestsOfPenetratedPart | Ask requests of penetrated parts
AskRequestsOfPenetratingPart | Ask requests of penetratint parts
AskWorkingList | Ask current `NXOpen.Features.ShipDesign.PenetrationList`
AssociateRequests | Ask the associate requests
CreatePenetrationAttachment | Creates a `NXOpen.Features.ShipDesign.PenetrationAttachment`
CreatePenetrationFolder | Creates a `NXOpen.Features.ShipDesign.PenetrationFolder`
CreatePenetrationList | Creates a `NXOpen.Features.ShipDesign.PenetrationList`
CreatePenetrationSite | Creates a `NXOpen.Features.ShipDesign.PenetrationSite`
GetAttachmentPartsFromRequest | Get attachment part from request
InsertAttachment | Insert an attachment into folder
ReloadRequests | Set current `NXOpen.Features.ShipDesign.PenetrationList`
RemoveAttachment | Remove an attachment from folder
RequestCreateCutout | Create cut out for the request
ReviewRequests | Review the requests
SaveRequests | Save the requests
SendToWorkflowRequests | Send to Workflow the requests
SetContextValues | Set the CONTEXT values
SetCurrentSite | Set current `NXOpen.Features.ShipDesign.PenetrationSite`
SetRootPart | Make part root part and work part
SetWorkingList | Set current `NXOpen.Features.ShipDesign.PenetrationList`
VerifyPenetrations | Verify penetrations

# Enumerations

PenetrationUtilsReferencetype Enumeration | Represents the reference type
PenetrationUtilsRequestState Enumeration | Representes the request state

# Method Detail

## AskAssociateRequests

`PenetrationUtils.``AskAssociateRequests`

  Ask the associate requests

  Signature `AskAssociateRequests(request)`

  Parameters: | request (`NXOpen.Features.ShipDesign.PenetrationRequest`) –
  Returns: |
  Return type: | list of `NXOpen.Features.ShipDesign.PenetrationRequest`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskAttachments

`PenetrationUtils.``AskAttachments`

  Get the attachments in folder

  Signature `AskAttachments(folder, relation)`

  Parameters:

  - folder (`NXOpen.Features.ShipDesign.PenetrationFolder`) –
  - relation (str) –

  Returns: |
  Return type: | list of `NXOpen.Features.ShipDesign.PenetrationAttachment`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskCurrentSite

`PenetrationUtils.``AskCurrentSite`

  Ask current `NXOpen.Features.ShipDesign.PenetrationSite`

  Signature `AskCurrentSite()`

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

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskReferenceFolder

`PenetrationUtils.``AskReferenceFolder`

  Get the reference folder `NXOpen.Features.ShipDesign.PenetrationFolder`

  Signature `AskReferenceFolder(request, refType)`

  Parameters:

  - request (`NXOpen.Features.ShipDesign.PenetrationRequest`) –
  - refType (`NXOpen.Features.ShipDesign.PenetrationUtilsReferencetype`) –

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

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskRequestLists

`PenetrationUtils.``AskRequestLists`

  Ask current `NXOpen.Features.ShipDesign.PenetrationList`

  Signature `AskRequestLists()`

  Returns: |
  Return type: | list of `NXOpen.Features.ShipDesign.PenetrationList`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskRequestsOfPenetratedPart

`PenetrationUtils.``AskRequestsOfPenetratedPart`

  Ask requests of penetrated parts

  Signature `AskRequestsOfPenetratedPart(part)`

  Parameters: | part (`NXOpen.Part`) –
  Returns: |
  Return type: | list of `NXOpen.Features.ShipDesign.PenetrationRequest`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskRequestsOfPenetratingPart

`PenetrationUtils.``AskRequestsOfPenetratingPart`

  Ask requests of penetratint parts

  Signature `AskRequestsOfPenetratingPart(part)`

  Parameters: | part (`NXOpen.Part`) –
  Returns: |
  Return type: | list of `NXOpen.Features.ShipDesign.PenetrationRequest`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AskWorkingList

`PenetrationUtils.``AskWorkingList`

  Ask current `NXOpen.Features.ShipDesign.PenetrationList`

  Signature `AskWorkingList()`

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

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## AssociateRequests

`PenetrationUtils.``AssociateRequests`

  Ask the associate requests

  Signature `AssociateRequests(requests)`

  Parameters: | requests (list of `NXOpen.Features.ShipDesign.PenetrationRequest`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## CreatePenetrationAttachment

`PenetrationUtils.``CreatePenetrationAttachment`

  Creates a `NXOpen.Features.ShipDesign.PenetrationAttachment`

  Signature `CreatePenetrationAttachment(site)`

  Parameters: | site (`NXOpen.Features.ShipDesign.PenetrationSite`) –
  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationAttachment`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## CreatePenetrationFolder

`PenetrationUtils.``CreatePenetrationFolder`

  Creates a `NXOpen.Features.ShipDesign.PenetrationFolder`

  Signature `CreatePenetrationFolder(parent)`

  Parameters: | parent (`NXOpen.Features.ShipDesign.PenetrationFolder`) –
  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationFolder`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## CreatePenetrationList

`PenetrationUtils.``CreatePenetrationList`

  Creates a `NXOpen.Features.ShipDesign.PenetrationList`

  Signature `CreatePenetrationList(site)`

  Parameters: | site (`NXOpen.Features.ShipDesign.PenetrationSite`) –
  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationList`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## CreatePenetrationSite

`PenetrationUtils.``CreatePenetrationSite`

  Creates a `NXOpen.Features.ShipDesign.PenetrationSite`

  Signature `CreatePenetrationSite(part)`

  Parameters: | part (`NXOpen.Part`) –
  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.PenetrationSite`

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## GetAttachmentPartsFromRequest

`PenetrationUtils.``GetAttachmentPartsFromRequest`

  Get attachment part from request

  Signature `GetAttachmentPartsFromRequest(request, relation, loadParts)`

  Parameters:

  - request (`NXOpen.Features.ShipDesign.PenetrationRequest`) –
  - relation (str) –
  - loadParts (bool) –

  Returns: |
  Return type: | list of `NXOpen.Part`

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## InsertAttachment

`PenetrationUtils.``InsertAttachment`

  Insert an attachment into folder

  Signature `InsertAttachment(folder, part, name, relation)`

  Parameters:

  - folder (`NXOpen.Features.ShipDesign.PenetrationFolder`) –
  - part (`NXOpen.Part`) –
  - name (str) –
  - relation (str) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## ReloadRequests

`PenetrationUtils.``ReloadRequests`

  Set current `NXOpen.Features.ShipDesign.PenetrationList`

  Signature `ReloadRequests(list)`

  Parameters: | list (`NXOpen.Features.ShipDesign.PenetrationList`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## RemoveAttachment

`PenetrationUtils.``RemoveAttachment`

  Remove an attachment from folder

  Signature `RemoveAttachment(folder, attachments)`

  Parameters:

  - folder (`NXOpen.Features.ShipDesign.PenetrationFolder`) –
  - attachments (`NXOpen.Features.ShipDesign.PenetrationAttachment`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## RequestCreateCutout

`PenetrationUtils.``RequestCreateCutout`

  Create cut out for the request

  Signature `RequestCreateCutout(request)`

  Parameters: | request (`NXOpen.Features.ShipDesign.PenetrationRequest`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## ReviewRequests

`PenetrationUtils.``ReviewRequests`

  Review the requests

  Signature `ReviewRequests(requests, pchReviewDecision, pchReviewComments, pchDueDate)`

  Parameters:

  - requests (list of `NXOpen.Features.ShipDesign.PenetrationRequest`) –
  - pchReviewDecision (str) –
  - pchReviewComments (str) –
  - pchDueDate (str) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SaveRequests

`PenetrationUtils.``SaveRequests`

  Save the requests

  Signature `SaveRequests(eSaveRequestType, requests)`

  Parameters:

  - eSaveRequestType (int) –
  - requests (list of `NXOpen.Features.ShipDesign.PenetrationRequest`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SendToWorkflowRequests

`PenetrationUtils.``SendToWorkflowRequests`

  Send to Workflow the requests

  Signature `SendToWorkflowRequests(requests)`

  Parameters: | requests (list of `NXOpen.Features.ShipDesign.PenetrationRequest`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetContextValues

`PenetrationUtils.``SetContextValues`

  Set the CONTEXT values

  Signature `SetContextValues(rootPart, workPart, workView, workOcc)`

  Parameters:

  - rootPart (`NXOpen.Part`) –
  - workPart (`NXOpen.Part`) –
  - workView (`NXOpen.View`) –
  - workOcc (`NXOpen.NXObject`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetCurrentSite

`PenetrationUtils.``SetCurrentSite`

  Set current `NXOpen.Features.ShipDesign.PenetrationSite`

  Signature `SetCurrentSite(site)`

  Parameters: | site (`NXOpen.Features.ShipDesign.PenetrationSite`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetRootPart

`PenetrationUtils.``SetRootPart`

  Make part root part and work part

  Signature `SetRootPart(part)`

  Parameters: | part (`NXOpen.Part`) –

  New in version NX8.5.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## SetWorkingList

`PenetrationUtils.``SetWorkingList`

  Set current `NXOpen.Features.ShipDesign.PenetrationList`

  Signature `SetWorkingList(site, list)`

  Parameters:

  - site (`NXOpen.Features.ShipDesign.PenetrationSite`) –
  - list (`NXOpen.Features.ShipDesign.PenetrationList`) –

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)

## VerifyPenetrations

`PenetrationUtils.``VerifyPenetrations`

  Verify penetrations

  Signature `VerifyPenetrations(routingPart)`

  Parameters: | routingPart (list of `NXOpen.Part`) –
  Returns: | a tuple
  Return type: | A tuple consisting of (states, requests, reason). states is a list of `NXOpen.Features.ShipDesign.PenetrationUtilsRequestState`. requests is a list of `NXOpen.Features.ShipDesign.PenetrationRequest`. reason is a list of int.

  New in version NX8.0.0.

  License requirements: nx_penetration_mgmt (“Penetration Management”)