ReusablePocketBuilder Class¶
-
class
NXOpen.Tooling.
ReusablePocketBuilder
¶ Bases:
NXOpen.Builder
Reusable pocket builder.
To create a new instance of this class, use
NXOpen.Tooling.ReusablePocketCollection.CreateReusablePocketBuilder
Default values.
Property Value AutoTarget true ThreadHole false New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AutoTarget | Returns or sets the flag specifying whether target is fetched automatically. |
Tag | Returns the Tag for this object. |
ThreadHole | Returns or sets the flag specifying whether thread hole is used. |
Methods¶
Method | Description |
---|---|
AddTargetBody | Adds target body. |
AddToolComponent | Adds tool component. |
BreakLink | Breaks link. |
Commit | Commits any edits that have been applied to the builder. |
CreatePocket | Creates pocket. |
DeletePocket | Deletes pocket. |
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. |
RecreateHoleSeries | Recreates hole series if hole feature is updated. |
RemoveTargetBody | Removes target body. |
RemoveToolComponent | Removes tool component. |
SetCounterboreDiameter | Sets counterbore diameter for hole series. |
SetCountersunkDiameter | Sets countersunk diameter for hole series. |
SetDiameter | Sets diameter for hole series. |
SetFit | Sets fit for hole series. |
SetForm | Sets form for hole series. |
SetHoleType | Sets hole type. |
SetReference | Sets reference set. |
SetScrewType | Sets screw type for hole series. |
SetStandard | Sets standard for hole series. |
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. |
VerifyHoleSeries | Verifies hole series parameters. |
Enumerations¶
ReusablePocketBuilderHole Enumeration | Represents hole types. |
Property Detail¶
AutoTarget¶
-
ReusablePocketBuilder.
AutoTarget
¶ Returns or sets the flag specifying whether target is fetched automatically.
If true, the target is fetched automatically, else, the target is fetched manually.
-------------------------------------
Getter Method
Signature
AutoTarget()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutoTarget(autoTarget)
Parameters: autoTarget (bool) – New in version NX7.5.0.
License requirements: None.
ThreadHole¶
-
ReusablePocketBuilder.
ThreadHole
¶ Returns or sets the flag specifying whether thread hole is used.
If true, thread hole is used, else, screw clearance hole is used.
-------------------------------------
Getter Method
Signature
ThreadHole()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThreadHole(threadHole)
Parameters: threadHole (bool) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
AddTargetBody¶
-
ReusablePocketBuilder.
AddTargetBody
¶ Adds target body.
Signature
AddTargetBody(component, targetBody)
Parameters: - component (
NXOpen.NXObject
) – Component to which target body is added - targetBody (
NXOpen.NXObject
) – Target body
New in version NX7.5.0.
License requirements: None.
- component (
AddToolComponent¶
-
ReusablePocketBuilder.
AddToolComponent
¶ Adds tool component.
Signature
AddToolComponent(component)
Parameters: component ( NXOpen.NXObject
) – Tool componentNew in version NX7.5.0.
License requirements: None.
BreakLink¶
-
ReusablePocketBuilder.
BreakLink
¶ Breaks link.
Signature
BreakLink(component)
Parameters: component ( NXOpen.NXObject
) – Component to which link is brokeNew in version NX8.0.0.
License requirements: None.
CreatePocket¶
-
ReusablePocketBuilder.
CreatePocket
¶ Creates pocket.
Signature
CreatePocket(component)
Parameters: component ( NXOpen.NXObject
) – Component to which pocket is createdNew in version NX7.5.0.
License requirements: None.
DeletePocket¶
-
ReusablePocketBuilder.
DeletePocket
¶ Deletes pocket.
Signature
DeletePocket(component)
Parameters: component ( NXOpen.NXObject
) – Component to which pocket is deletedNew in version NX7.5.0.
License requirements: None.
RecreateHoleSeries¶
-
ReusablePocketBuilder.
RecreateHoleSeries
¶ Recreates hole series if hole feature is updated.
Signature
RecreateHoleSeries(component, feature)
Parameters: - component (
NXOpen.NXObject
) – Component to recreate hole series - feature (
NXOpen.NXObject
) – Feature to be recreated
New in version NX7.5.0.
License requirements: None.
- component (
RemoveTargetBody¶
-
ReusablePocketBuilder.
RemoveTargetBody
¶ Removes target body.
Signature
RemoveTargetBody(component, targetBody)
Parameters: - component (
NXOpen.NXObject
) – Component to which target body is removed - targetBody (
NXOpen.NXObject
) – Target body
New in version NX7.5.0.
License requirements: None.
- component (
RemoveToolComponent¶
-
ReusablePocketBuilder.
RemoveToolComponent
¶ Removes tool component.
Signature
RemoveToolComponent(component)
Parameters: component ( NXOpen.NXObject
) – Tool component to removeNew in version NX7.5.0.
License requirements: None.
SetCounterboreDiameter¶
-
ReusablePocketBuilder.
SetCounterboreDiameter
¶ Sets counterbore diameter for hole series.
Signature
SetCounterboreDiameter(component, counterboreDiameter)
Parameters: - component (
NXOpen.NXObject
) – Component to which counterbore diameter is set - counterboreDiameter (float) – C-Bore diameter for hole series
New in version NX7.5.0.
License requirements: None.
- component (
SetCountersunkDiameter¶
-
ReusablePocketBuilder.
SetCountersunkDiameter
¶ Sets countersunk diameter for hole series.
Signature
SetCountersunkDiameter(component, countersunkDiameter)
Parameters: - component (
NXOpen.NXObject
) – Component to which countersunk diameter is set - countersunkDiameter (float) – C-Sink diameter for hole series
New in version NX8.0.0.
License requirements: None.
- component (
SetDiameter¶
-
ReusablePocketBuilder.
SetDiameter
¶ Sets diameter for hole series.
Signature
SetDiameter(component, diameter)
Parameters: - component (
NXOpen.NXObject
) – Component to which diameter is set - diameter (float) – Diameter for hole series
New in version NX7.5.0.
License requirements: None.
- component (
SetFit¶
-
ReusablePocketBuilder.
SetFit
¶ Sets fit for hole series.
Signature
SetFit(component, fit)
Parameters: - component (
NXOpen.NXObject
) – Component to which fit is set - fit (str) – Hole series fit NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.0.
License requirements: None.
- component (
SetForm¶
-
ReusablePocketBuilder.
SetForm
¶ Sets form for hole series.
Signature
SetForm(component, form)
Parameters: - component (
NXOpen.NXObject
) – Component to which form is set - form (str) – Hole series form NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.0.
License requirements: None.
- component (
SetHoleType¶
-
ReusablePocketBuilder.
SetHoleType
¶ Sets hole type.
Signature
SetHoleType(component, holeType)
Parameters: - component (
NXOpen.NXObject
) – Component to which hole type is set - holeType (
NXOpen.Tooling.ReusablePocketBuilderHole
) – Hole type
New in version NX7.5.0.
License requirements: None.
- component (
SetReference¶
-
ReusablePocketBuilder.
SetReference
¶ Sets reference set.
Signature
SetReference(component, reference)
Parameters: - component (
NXOpen.NXObject
) – Component to which reference is set - reference (str) – Reference set with cut body NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.0.
License requirements: None.
- component (
SetScrewType¶
-
ReusablePocketBuilder.
SetScrewType
¶ Sets screw type for hole series.
Signature
SetScrewType(component, screwType)
Parameters: - component (
NXOpen.NXObject
) – Component to which screw type is set - screwType (str) – Hole series screw type NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.0.
License requirements: None.
- component (
SetStandard¶
-
ReusablePocketBuilder.
SetStandard
¶ Sets standard for hole series.
Signature
SetStandard(component, standard)
Parameters: - component (
NXOpen.NXObject
) – Component to which standard is set - standard (str) – Hole series standard NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.0.
License requirements: None.
- component (
Validate¶
-
ReusablePocketBuilder.
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.
VerifyHoleSeries¶
-
ReusablePocketBuilder.
VerifyHoleSeries
¶ Verifies hole series parameters.
Signature
VerifyHoleSeries(component)
Parameters: component ( NXOpen.NXObject
) – Component to verify hole series parametersNew in version NX7.5.0.
License requirements: None.