ShimBuilder Class¶
-
class
NXOpen.Tooling.
ShimBuilder
¶ Bases:
NXOpen.Builder
Shim Builder of PDW and EDW.
A Body is returned by this builder. To create a new instance of this class, use
NXOpen.Tooling.ProgressiveDieManager.CreateShimBuilder()
Default values.
Property Value ParentNode NoParent RenameToggle 0 SideAttributeValue None New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
Height | Returns the height of shim body |
InsertToDelete | Returns the shim component that needs to be deleted |
InsertToEdit | Returns the shim component that needs to be edit |
OffsetOuterDistance | Returns the offset distance of outer loop |
OuterRoughOffset | Returns or sets the outer rough offset |
ParentNode | Returns or sets the parent node which shim part will be insert to |
ParentPartName | Returns or sets the parent part name of shim part |
RenameToggle | Returns or sets the toggle to indicate whether to rename shim part |
ShimFace | Returns the face for doing shim body |
SideAttributeValue | Returns or sets the side attribute value for shim. |
SlugholeProfile | Returns the list containing the inner profiles which need to offset. |
Tag | Returns the Tag for this object. |
Type | Returns or sets the type |
WizardType | Returns or sets the wizard type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateInnerProfileSetBuilder | Create a inner profile set builder object. |
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. |
GetItemName | Returns the item name Of Set List |
GetObject | Returns the object currently being edited by this builder. |
SetItemName | Sets the item name of Set List |
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¶
ShimBuilderParentOption Enumeration | Specify the parent node. |
ShimBuilderSideAttributeValues Enumeration | Specifies the value of side attribute. |
ShimBuilderTypes Enumeration | Specify the shim operation type. |
Property Detail¶
Height¶
-
ShimBuilder.
Height
¶ Returns the height of shim body
-------------------------------------
Getter Method
Signature
Height
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
InsertToDelete¶
-
ShimBuilder.
InsertToDelete
¶ Returns the shim component that needs to be deleted
-------------------------------------
Getter Method
Signature
InsertToDelete
Returns: Return type: NXOpen.Assemblies.SelectComponentList
New in version NX10.0.0.
License requirements: None.
InsertToEdit¶
-
ShimBuilder.
InsertToEdit
¶ Returns the shim component that needs to be edit
-------------------------------------
Getter Method
Signature
InsertToEdit
Returns: Return type: NXOpen.Assemblies.SelectComponent
New in version NX10.0.0.
License requirements: None.
OffsetOuterDistance¶
-
ShimBuilder.
OffsetOuterDistance
¶ Returns the offset distance of outer loop
-------------------------------------
Getter Method
Signature
OffsetOuterDistance
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
OuterRoughOffset¶
-
ShimBuilder.
OuterRoughOffset
¶ Returns or sets the outer rough offset
-------------------------------------
Getter Method
Signature
OuterRoughOffset
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OuterRoughOffset
Parameters: outerRoughOffset (bool) – New in version NX10.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
ParentNode¶
-
ShimBuilder.
ParentNode
¶ Returns or sets the parent node which shim part will be insert to
-------------------------------------
Getter Method
Signature
ParentNode
Returns: Return type: NXOpen.Tooling.ShimBuilderParentOption
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParentNode
Parameters: parentNode ( NXOpen.Tooling.ShimBuilderParentOption
) –New in version NX10.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
ParentPartName¶
-
ShimBuilder.
ParentPartName
¶ Returns or sets the parent part name of shim part
-------------------------------------
Getter Method
Signature
ParentPartName
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParentPartName
Parameters: parentPartName (str) – New in version NX10.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
RenameToggle¶
-
ShimBuilder.
RenameToggle
¶ Returns or sets the toggle to indicate whether to rename shim part
-------------------------------------
Getter Method
Signature
RenameToggle
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RenameToggle
Parameters: renameToggle (bool) – New in version NX10.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
ShimFace¶
-
ShimBuilder.
ShimFace
¶ Returns the face for doing shim body
-------------------------------------
Getter Method
Signature
ShimFace
Returns: Return type: NXOpen.SelectFaceList
New in version NX10.0.0.
License requirements: None.
SideAttributeValue¶
-
ShimBuilder.
SideAttributeValue
¶ Returns or sets the side attribute value for shim.
-------------------------------------
Getter Method
Signature
SideAttributeValue
Returns: Indicates the side attribute value for shim Return type: NXOpen.Tooling.ShimBuilderSideAttributeValues
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SideAttributeValue
Parameters: sideAttributeValue ( NXOpen.Tooling.ShimBuilderSideAttributeValues
) – Indicates the side attribute value for shimNew in version NX12.0.0.
License requirements: None.
SlugholeProfile¶
-
ShimBuilder.
SlugholeProfile
¶ Returns the list containing the inner profiles which need to offset.
-------------------------------------
Getter Method
Signature
SlugholeProfile
Returns: Return type: NXOpen.Tooling.ShimInnerProfileSetBuilderList
New in version NX10.0.0.
License requirements: None.
Type¶
-
ShimBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Tooling.ShimBuilderTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Tooling.ShimBuilderTypes
) –New in version NX10.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
WizardType¶
-
ShimBuilder.
WizardType
¶ Returns or sets the wizard type
-------------------------------------
Getter Method
Signature
WizardType
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WizardType
Parameters: wizardType (int) – New in version NX10.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
Method Detail¶
CreateInnerProfileSetBuilder¶
-
ShimBuilder.
CreateInnerProfileSetBuilder
¶ Create a inner profile set builder object.
Signature
CreateInnerProfileSetBuilder()
Returns: Return type: NXOpen.Tooling.ShimInnerProfileSetBuilder
New in version NX10.0.0.
License requirements: None.
GetItemName¶
-
ShimBuilder.
GetItemName
¶ Returns the item name Of Set List
Signature
GetItemName()
Returns: the item name Return type: list of int New in version NX11.0.0.
License requirements: None.
SetItemName¶
-
ShimBuilder.
SetItemName
¶ Sets the item name of Set List
Signature
SetItemName(itemName)
Parameters: itemName (list of int) – the item name New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
Validate¶
-
ShimBuilder.
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.