StockSizeBuilder Class¶
-
class
NXOpen.Tooling.
StockSizeBuilder
¶ Bases:
NXOpen.Builder
Represents a Tooling::StockSizeBuilder builder.
To create a new instance of this class, use
NXOpen.Tooling.StockSizeCollection.CreateStocksizeBuilder()
Default values.
Property Value Associative 1 Clearance.Value 3.0 (millimeters part), 0.125 (inches part) IsClearanceAutoSet 0 ReferenceCsysType Wcs ShowDiameterSymbol 1 SizePrecision 3 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Associative | Returns or sets the association of stock size object |
AxisVector | Returns or sets the cylinder axis vector to calculate cylinder stock szie |
BlankPrecisionValue | Returns or sets the blank size precision string. |
BlankSize | Returns or sets the blank size string, it is separated by X . |
Clearance | Returns the clearance of the stocksize. |
ConnectionString | Returns or sets the connection string |
CylinderType | Returns or sets the cylinder type to generate a cylinder for the stock size. |
IsClearanceAutoSet | Returns or sets the is clearance auto set |
OffsetNegativeX | Returns or sets the clearance value for the blank in -X direction. |
OffsetNegativeY | Returns or sets the clearance value for the blank in -Y direction. |
OffsetNegativeZ | Returns or sets the clearance value for the blank in -Z direction. |
OffsetPositiveX | Returns or sets the clearance value for the blank in +X direction. |
OffsetPositiveY | Returns or sets the clearance value for the blank in +Y direction. |
OffsetPositiveZ | Returns or sets the clearance value for the blank in +Z direction. |
RadialOffset | Returns or sets the clearance value for the cylinder blank in radial direction. |
RefCsys | Returns or sets the reference csys to calculate stocksize. |
RefCsysSelection | Returns the reference csys to calculate stocksize. |
ReferenceCsysType | Returns or sets the reference csys type |
SelectBody | Returns the selected body to calculate a bounding box for stock size. |
ShowDiameterSymbol | Returns or sets the attribute which determines whether the diameter symbol is shown or not when stock type is cylinder |
SizePrecision | Returns or sets the size precision of the stock. |
StockType | Returns or sets the stock shape to be generated, it can be a box or cylinder. |
StringStock | Returns or sets the stock size string, it is separated by X . |
Tag | Returns the Tag for this object. |
Type | Returns or sets the stock shape to be generated, it can be a block or cylinder. |
Methods¶
Method | Description |
---|---|
CalculateBoxSize | Calculate box size and get directions, edge length, lower point position. |
Commit | Commits any edits that have been applied to the builder. |
ConvertStockDataToBuilder | Convert stock size object data to builder. |
CreateRefCsys | Creates the reference csys for stock size. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EditStockSizeAttr | Add or edit stock size attributes. |
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. |
ModifyRefCsys | Modifies the reference csys for stock size. |
SetFitFaceStatus | Find out those extreme planar faces, and set fitting face status in all directions. |
SetManipulatorOrientation | Set the orientation of the current bounded box. |
SetStockSizeObject | Set stock size object. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateBlankSizeString | Update blank size. |
UpdateStockSizeString | Update stock size. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
StockSizeBuilderCylinder Enumeration | Represents the base circle type of cylinder. |
StockSizeBuilderRefCsysType Enumeration | Represents the reference CSYS type. |
StockSizeBuilderShape Enumeration | Represents the shape of stock size. |
StockSizeBuilderTypes Enumeration | Represents the shape of stock size. |
Property Detail¶
Associative¶
-
StockSizeBuilder.
Associative
¶ Returns or sets the association of stock size object
-------------------------------------
Getter Method
Signature
Associative
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Associative
Parameters: isAssociation (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
AxisVector¶
-
StockSizeBuilder.
AxisVector
¶ Returns or sets the cylinder axis vector to calculate cylinder stock szie
-------------------------------------
Getter Method
Signature
AxisVector
Returns: Return type: NXOpen.Direction
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AxisVector
Parameters: cylinderVector ( NXOpen.Direction
) –New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
BlankPrecisionValue¶
-
StockSizeBuilder.
BlankPrecisionValue
¶ Returns or sets the blank size precision string.
-------------------------------------
Getter Method
Signature
BlankPrecisionValue
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BlankPrecisionValue
Parameters: blankPrecisionValue (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
BlankSize¶
-
StockSizeBuilder.
BlankSize
¶ Returns or sets the blank size string, it is separated by ” X “.
-------------------------------------
Getter Method
Signature
BlankSize
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BlankSize
Parameters: blankSize (str) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Clearance¶
-
StockSizeBuilder.
Clearance
¶ Returns the clearance of the stocksize.
-------------------------------------
Getter Method
Signature
Clearance
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
ConnectionString¶
-
StockSizeBuilder.
ConnectionString
¶ Returns or sets the connection string
-------------------------------------
Getter Method
Signature
ConnectionString
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConnectionString
Parameters: connectionString (str) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
CylinderType¶
-
StockSizeBuilder.
CylinderType
¶ Returns or sets the cylinder type to generate a cylinder for the stock size.
-------------------------------------
Getter Method
Signature
CylinderType
Returns: Return type: NXOpen.Tooling.StockSizeBuilderCylinder
New in version NX6.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
-------------------------------------
Setter Method
Signature
CylinderType
Parameters: enumCylinderType ( NXOpen.Tooling.StockSizeBuilderCylinder
) –New in version NX6.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
IsClearanceAutoSet¶
-
StockSizeBuilder.
IsClearanceAutoSet
¶ Returns or sets the is clearance auto set
-------------------------------------
Getter Method
Signature
IsClearanceAutoSet
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsClearanceAutoSet
Parameters: isClearanceAutoSet (bool) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetNegativeX¶
-
StockSizeBuilder.
OffsetNegativeX
¶ Returns or sets the clearance value for the blank in -X direction.
-------------------------------------
Getter Method
Signature
OffsetNegativeX
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetNegativeX
Parameters: offsetNegativeX (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetNegativeY¶
-
StockSizeBuilder.
OffsetNegativeY
¶ Returns or sets the clearance value for the blank in -Y direction.
-------------------------------------
Getter Method
Signature
OffsetNegativeY
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetNegativeY
Parameters: offsetNegativeY (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetNegativeZ¶
-
StockSizeBuilder.
OffsetNegativeZ
¶ Returns or sets the clearance value for the blank in -Z direction.
-------------------------------------
Getter Method
Signature
OffsetNegativeZ
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetNegativeZ
Parameters: offsetNegativeZ (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetPositiveX¶
-
StockSizeBuilder.
OffsetPositiveX
¶ Returns or sets the clearance value for the blank in +X direction.
-------------------------------------
Getter Method
Signature
OffsetPositiveX
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetPositiveX
Parameters: offsetPositiveX (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetPositiveY¶
-
StockSizeBuilder.
OffsetPositiveY
¶ Returns or sets the clearance value for the blank in +Y direction.
-------------------------------------
Getter Method
Signature
OffsetPositiveY
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetPositiveY
Parameters: offsetPositiveY (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetPositiveZ¶
-
StockSizeBuilder.
OffsetPositiveZ
¶ Returns or sets the clearance value for the blank in +Z direction.
-------------------------------------
Getter Method
Signature
OffsetPositiveZ
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetPositiveZ
Parameters: offsetPositiveZ (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
RadialOffset¶
-
StockSizeBuilder.
RadialOffset
¶ Returns or sets the clearance value for the cylinder blank in radial direction.
-------------------------------------
Getter Method
Signature
RadialOffset
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RadialOffset
Parameters: radialOffset (float) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
RefCsys¶
-
StockSizeBuilder.
RefCsys
¶ Returns or sets the reference csys to calculate stocksize.
-------------------------------------
Getter Method
Signature
RefCsys
Returns: Return type: NXOpen.CoordinateSystem
New in version NX8.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
-------------------------------------
Setter Method
Signature
RefCsys
Parameters: refCsys ( NXOpen.CoordinateSystem
) –New in version NX8.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
RefCsysSelection¶
-
StockSizeBuilder.
RefCsysSelection
¶ Returns the reference csys to calculate stocksize.
-------------------------------------
Getter Method
Signature
RefCsysSelection
Returns: Return type: NXOpen.SelectCoordinateSystem
New in version NX10.0.0.
License requirements: None.
ReferenceCsysType¶
-
StockSizeBuilder.
ReferenceCsysType
¶ Returns or sets the reference csys type
-------------------------------------
Getter Method
Signature
ReferenceCsysType
Returns: Return type: NXOpen.Tooling.StockSizeBuilderRefCsysType
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceCsysType
Parameters: referenceCsysType ( NXOpen.Tooling.StockSizeBuilderRefCsysType
) –New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SelectBody¶
-
StockSizeBuilder.
SelectBody
¶ Returns the selected body to calculate a bounding box for stock size.
-------------------------------------
Getter Method
Signature
SelectBody
Returns: Return type: NXOpen.SelectBodyList
New in version NX6.0.0.
License requirements: None.
ShowDiameterSymbol¶
-
StockSizeBuilder.
ShowDiameterSymbol
¶ Returns or sets the attribute which determines whether the diameter symbol is shown or not when stock type is cylinder
-------------------------------------
Getter Method
Signature
ShowDiameterSymbol
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowDiameterSymbol
Parameters: showDiameterSymbol (bool) – New in version NX12.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SizePrecision¶
-
StockSizeBuilder.
SizePrecision
¶ Returns or sets the size precision of the stock.
-------------------------------------
Getter Method
Signature
SizePrecision
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SizePrecision
Parameters: integerPrecision (int) – New in version NX6.0.0.
License requirements: None.
StockType¶
-
StockSizeBuilder.
StockType
¶ Returns or sets the stock shape to be generated, it can be a box or cylinder.
-------------------------------------
Getter Method
Signature
StockType
Returns: Return type: NXOpen.Tooling.StockSizeBuilderShape
New in version NX6.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
-------------------------------------
Setter Method
Signature
StockType
Parameters: enumStockType ( NXOpen.Tooling.StockSizeBuilderShape
) –New in version NX6.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
StringStock¶
-
StockSizeBuilder.
StringStock
¶ Returns or sets the stock size string, it is separated by ” X “.
-------------------------------------
Getter Method
Signature
StringStock
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringStock
Parameters: stringStock (str) – New in version NX6.0.0.
License requirements: None.
Type¶
-
StockSizeBuilder.
Type
¶ Returns or sets the stock shape to be generated, it can be a block or cylinder.
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Tooling.StockSizeBuilderTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Tooling.StockSizeBuilderTypes
) –New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Method Detail¶
CalculateBoxSize¶
-
StockSizeBuilder.
CalculateBoxSize
¶ Calculate box size and get directions, edge length, lower point position.
Signature
CalculateBoxSize()
Returns: a tuple Return type: A tuple consisting of (minPoint, edgeLength, cysMatrix). minPoint is a NXOpen.Point3d
. edgeLength is a list of float. cysMatrix is aNXOpen.Matrix3x3
.New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ConvertStockDataToBuilder¶
-
StockSizeBuilder.
ConvertStockDataToBuilder
¶ Convert stock size object data to builder.
Signature
ConvertStockDataToBuilder(stock)
Parameters: stock ( NXOpen.NXObject
) –New in version NX11.0.1.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
CreateRefCsys¶
-
StockSizeBuilder.
CreateRefCsys
¶ Creates the reference csys for stock size.
Signature
CreateRefCsys(inputOrigin, inputMatrix)
Parameters: - inputOrigin (
NXOpen.Point3d
) – - inputMatrix (
NXOpen.Matrix3x3
) –
New in version NX8.0.0.
License requirements: None.
- inputOrigin (
EditStockSizeAttr¶
-
StockSizeBuilder.
EditStockSizeAttr
¶ Add or edit stock size attributes.
Signature
EditStockSizeAttr(workPart)
Parameters: workPart ( NXOpen.NXObject
) –New in version NX8.0.0.
License requirements: None.
ModifyRefCsys¶
-
StockSizeBuilder.
ModifyRefCsys
¶ Modifies the reference csys for stock size.
Signature
ModifyRefCsys(inputOrigin, inputMatrix)
Parameters: - inputOrigin (
NXOpen.Point3d
) – - inputMatrix (
NXOpen.Matrix3x3
) –
New in version NX8.0.0.
License requirements: None.
- inputOrigin (
SetFitFaceStatus¶
-
StockSizeBuilder.
SetFitFaceStatus
¶ Find out those extreme planar faces, and set fitting face status in all directions.
Signature
SetFitFaceStatus(fitFace)
Parameters: fitFace (bool) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SetManipulatorOrientation¶
-
StockSizeBuilder.
SetManipulatorOrientation
¶ Set the orientation of the current bounded box.
Signature
SetManipulatorOrientation(cysMatrix)
Parameters: cysMatrix ( NXOpen.Matrix3x3
) –New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SetStockSizeObject¶
-
StockSizeBuilder.
SetStockSizeObject
¶ Set stock size object.
Signature
SetStockSizeObject(stock)
Parameters: stock ( NXOpen.NXObject
) –New in version NX11.0.1.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
UpdateBlankSizeString¶
-
StockSizeBuilder.
UpdateBlankSizeString
¶ Update blank size.
Signature
UpdateBlankSizeString()
New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
UpdateStockSizeString¶
-
StockSizeBuilder.
UpdateStockSizeString
¶ Update stock size.
Signature
UpdateStockSizeString()
New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR nx_electrode_wizard (“NX Electrode Wizard”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Validate¶
-
StockSizeBuilder.
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.