PocketBuilder Class¶
-
class
NXOpen.Tooling.
PocketBuilder
¶ Bases:
NXOpen.Builder
Mold Wizard pocket management builder
To create a new instance of this class, use
NXOpen.Tooling.PocketCollection.CreatePocketBuilder()
Default values.
Property Value EntireComponentPattern 0 PreviewFalseBody 0 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AssociationSetting | Returns or sets the association setting access functions |
CreateSolidSetting | Returns or sets the option for creating interference solids for HD3D. |
EntireComponentPattern | Returns or sets the option for selecting entire component pattern. |
ModeSelection | Returns or sets the mode select types |
PreviewFalseBody | Returns or sets the option for previewing family part false bodies. |
ReferenceSets | Returns or sets the types of reference sets |
SaveSetting | Returns or sets the option for saving pocket check result in part. |
SelectTarget | Returns the target part selection |
SelectTool | Returns the tool part selection |
SelectTypes | Returns or sets the types of tool to select |
ShowSetting | Returns or sets the show or hide value access functions |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
CheckStatus | Checks the pocket status of standard parts |
Commit | Commits any edits that have been applied to the builder. |
DeleteFamilyToolFalse | Deletes the family tool false body |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EditFalseBody | Edits false body |
FindIntersection | Finds the intersected components to create pocket |
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. |
RemovePocket | The function to remove pocket |
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¶
PocketBuilderModeType Enumeration | Represents the pocket operation method |
PocketBuilderRsetType Enumeration | Represents the pocket refset types |
PocketBuilderToolType Enumeration | Represents the select type of tool |
Property Detail¶
AssociationSetting¶
-
PocketBuilder.
AssociationSetting
¶ Returns or sets the association setting access functions
-------------------------------------
Getter Method
Signature
AssociationSetting
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AssociationSetting
Parameters: associationSetting (bool) – New in version NX6.0.0.
License requirements: None.
CreateSolidSetting¶
-
PocketBuilder.
CreateSolidSetting
¶ Returns or sets the option for creating interference solids for HD3D.
-------------------------------------
Getter Method
Signature
CreateSolidSetting
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateSolidSetting
Parameters: createSolidSetting (bool) – New in version NX8.0.0.
License requirements: None.
EntireComponentPattern¶
-
PocketBuilder.
EntireComponentPattern
¶ Returns or sets the option for selecting entire component pattern.
-------------------------------------
Getter Method
Signature
EntireComponentPattern
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EntireComponentPattern
Parameters: entire (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR ug_die_design (“Die Design”)
ModeSelection¶
-
PocketBuilder.
ModeSelection
¶ Returns or sets the mode select types
-------------------------------------
Getter Method
Signature
ModeSelection
Returns: Return type: NXOpen.Tooling.PocketBuilderModeType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ModeSelection
Parameters: modeSelection ( NXOpen.Tooling.PocketBuilderModeType
) –New in version NX6.0.0.
License requirements: None.
PreviewFalseBody¶
-
PocketBuilder.
PreviewFalseBody
¶ Returns or sets the option for previewing family part false bodies.
-------------------------------------
Getter Method
Signature
PreviewFalseBody
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PreviewFalseBody
Parameters: previewFalse (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR ug_die_design (“Die Design”)
ReferenceSets¶
-
PocketBuilder.
ReferenceSets
¶ Returns or sets the types of reference sets
-------------------------------------
Getter Method
Signature
ReferenceSets
Returns: Return type: NXOpen.Tooling.PocketBuilderRsetType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceSets
Parameters: referenceSets ( NXOpen.Tooling.PocketBuilderRsetType
) –New in version NX6.0.0.
License requirements: None.
SaveSetting¶
-
PocketBuilder.
SaveSetting
¶ Returns or sets the option for saving pocket check result in part.
-------------------------------------
Getter Method
Signature
SaveSetting
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SaveSetting
Parameters: saveSetting (bool) – New in version NX8.0.0.
License requirements: None.
SelectTarget¶
-
PocketBuilder.
SelectTarget
¶ Returns the target part selection
-------------------------------------
Getter Method
Signature
SelectTarget
Returns: Return type: NXOpen.SelectBodyList
New in version NX6.0.0.
License requirements: None.
SelectTool¶
-
PocketBuilder.
SelectTool
¶ Returns the tool part selection
-------------------------------------
Getter Method
Signature
SelectTool
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
License requirements: None.
SelectTypes¶
-
PocketBuilder.
SelectTypes
¶ Returns or sets the types of tool to select
-------------------------------------
Getter Method
Signature
SelectTypes
Returns: Return type: NXOpen.Tooling.PocketBuilderToolType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectTypes
Parameters: selectTypes ( NXOpen.Tooling.PocketBuilderToolType
) –New in version NX6.0.0.
License requirements: None.
ShowSetting¶
-
PocketBuilder.
ShowSetting
¶ Returns or sets the show or hide value access functions
-------------------------------------
Getter Method
Signature
ShowSetting
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowSetting
Parameters: showSetting (bool) – New in version NX6.0.0.
License requirements: None.
Method Detail¶
CheckStatus¶
-
PocketBuilder.
CheckStatus
¶ Checks the pocket status of standard parts
Signature
CheckStatus()
New in version NX10.0.0.
License requirements: None.
DeleteFamilyToolFalse¶
-
PocketBuilder.
DeleteFamilyToolFalse
¶ Deletes the family tool false body
Signature
DeleteFamilyToolFalse()
New in version NX11.0.0.
License requirements: None.
EditFalseBody¶
-
PocketBuilder.
EditFalseBody
¶ Edits false body
Signature
EditFalseBody()
New in version NX11.0.0.
License requirements: None.
FindIntersection¶
-
PocketBuilder.
FindIntersection
¶ Finds the intersected components to create pocket
Signature
FindIntersection()
New in version NX10.0.0.
License requirements: None.
RemovePocket¶
-
PocketBuilder.
RemovePocket
¶ The function to remove pocket
Signature
RemovePocket()
New in version NX6.0.0.
License requirements: None.
Validate¶
-
PocketBuilder.
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.