SlugRetentionBuilder Class

class NXOpen.Tooling.SlugRetentionBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Tooling.SlugRetentionBuilder which is used to create the Slug Retention.

To create a new instance of this class, use NXOpen.Tooling.ProgressiveDieManager.CreateSlugRetentionBuilder()

Default values.

Property Value
AngularDimension.Value 5
CuttingClearance.Value 2 (millimeters part), 0.05 (inches part)
CuttingDistance.Value 10 (millimeters part), 0.25 (inches part)
OffsetDistance 5
RadiusDimension.Value 7 (millimeters part), 0.25 (inches part)

New in version NX10.0.0.

Properties

Property Description
AngularDimension Returns the angular dimension
CuttingClearance Returns the cutting clearance
CuttingDistance Returns the cutting distance
OffsetDirection Returns or sets the offset direction
OffsetDistance Returns or sets the offset distance
PreviousWorkPart Returns or sets the previous work part
RadiusDimension Returns the radius dimension
RotateDirection Returns or sets the rotate direction
SelectComponent Returns the select component
SelectDataFile Returns or sets the select data file
SelectPoint Returns or sets the select point
SlugEdgeForTypeTwo Returns or sets the slug edge for type two
SlugRetentionBooleanData Returns the slug retention boolean data
SlugRetentionEdge Returns the slug retention edge
SlugRetentionFeature Returns or sets the slug retention feature
Tag Returns the Tag for this object.
TargetBodyForSubtract Returns or sets the target body for subtract
Type Returns or sets the type

Methods

Method Description
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.
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

SlugRetentionBuilderTypes Enumeration the main type

Property Detail

AngularDimension

SlugRetentionBuilder.AngularDimension

Returns the angular dimension

-------------------------------------

Getter Method

Signature AngularDimension

Returns:
Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: None.

CuttingClearance

SlugRetentionBuilder.CuttingClearance

Returns the cutting clearance

-------------------------------------

Getter Method

Signature CuttingClearance

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

CuttingDistance

SlugRetentionBuilder.CuttingDistance

Returns the cutting distance

-------------------------------------

Getter Method

Signature CuttingDistance

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

OffsetDirection

SlugRetentionBuilder.OffsetDirection

Returns or sets the offset direction

-------------------------------------

Getter Method

Signature OffsetDirection

Returns:
Return type:NXOpen.Direction

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature OffsetDirection

Parameters:offsetDirection (NXOpen.Direction) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

OffsetDistance

SlugRetentionBuilder.OffsetDistance

Returns or sets the offset distance

-------------------------------------

Getter Method

Signature OffsetDistance

Returns:
Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature OffsetDistance

Parameters:offsetDistance (float) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

PreviousWorkPart

SlugRetentionBuilder.PreviousWorkPart

Returns or sets the previous work part

-------------------------------------

Getter Method

Signature PreviousWorkPart

Returns:
Return type:NXOpen.Part

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PreviousWorkPart

Parameters:previousWorkPart (NXOpen.Part) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

RadiusDimension

SlugRetentionBuilder.RadiusDimension

Returns the radius dimension

-------------------------------------

Getter Method

Signature RadiusDimension

Returns:
Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: None.

RotateDirection

SlugRetentionBuilder.RotateDirection

Returns or sets the rotate direction

-------------------------------------

Getter Method

Signature RotateDirection

Returns:
Return type:NXOpen.Direction

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RotateDirection

Parameters:rotateDirection (NXOpen.Direction) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SelectComponent

SlugRetentionBuilder.SelectComponent

Returns the select component

-------------------------------------

Getter Method

Signature SelectComponent

Returns:
Return type:NXOpen.Assemblies.SelectComponent

New in version NX10.0.0.

License requirements: None.

SelectDataFile

SlugRetentionBuilder.SelectDataFile

Returns or sets the select data file

-------------------------------------

Getter Method

Signature SelectDataFile

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SelectDataFile

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SelectPoint

SlugRetentionBuilder.SelectPoint

Returns or sets the select point

-------------------------------------

Getter Method

Signature SelectPoint

Returns:
Return type:NXOpen.Point

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SelectPoint

Parameters:selectPoint (NXOpen.Point) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SlugEdgeForTypeTwo

SlugRetentionBuilder.SlugEdgeForTypeTwo

Returns or sets the slug edge for type two

-------------------------------------

Getter Method

Signature SlugEdgeForTypeTwo

Returns:
Return type:NXOpen.Edge

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SlugEdgeForTypeTwo

Parameters:slugEdgeForTypeTwo (NXOpen.Edge) –

New in version NX12.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SlugRetentionBooleanData

SlugRetentionBuilder.SlugRetentionBooleanData

Returns the slug retention boolean data

-------------------------------------

Getter Method

Signature SlugRetentionBooleanData

Returns:
Return type:NXOpen.GeometricUtilities.BooleanOperation

New in version NX10.0.0.

License requirements: None.

SlugRetentionEdge

SlugRetentionBuilder.SlugRetentionEdge

Returns the slug retention edge

-------------------------------------

Getter Method

Signature SlugRetentionEdge

Returns:
Return type:NXOpen.SelectEdge

New in version NX12.0.0.

License requirements: None.

SlugRetentionFeature

SlugRetentionBuilder.SlugRetentionFeature

Returns or sets the slug retention feature

-------------------------------------

Getter Method

Signature SlugRetentionFeature

Returns:
Return type:NXOpen.Features.Feature

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SlugRetentionFeature

Parameters:slugRetentionFeature (NXOpen.Features.Feature) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

TargetBodyForSubtract

SlugRetentionBuilder.TargetBodyForSubtract

Returns or sets the target body for subtract

-------------------------------------

Getter Method

Signature TargetBodyForSubtract

Returns:
Return type:NXOpen.Body

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TargetBodyForSubtract

Parameters:targetBodyForSubtract (NXOpen.Body) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

Type

SlugRetentionBuilder.Type

Returns or sets the type

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:NXOpen.Tooling.SlugRetentionBuilderTypes

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.Tooling.SlugRetentionBuilderTypes) –

New in version NX12.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

Method Detail

Validate

SlugRetentionBuilder.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.