WireHoleBuilder Class¶
-
class
NXOpen.Tooling.
WireHoleBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Tooling.WireHoleBuilder
This class is for Wire Hole Design UITo create a new instance of this class, use
NXOpen.Tooling.WireHoleCollection.CreateWireHoleBuilder()
Default values.
Property Value DistanceToEdgeMidpoint 3 HoleDiameter 3 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
CenterlineLength | Returns or sets the centerline length to create wire hole |
CircleCenter | Returns or sets the circle center to create wire hole |
DistanceToEdgeMidpoint | Returns or sets the distance to edge midpoint |
HoleDepth | Returns or sets the depth of wire hole. |
HoleDiameter | Returns or sets the diameter to create wire hole |
SelectEdge | Returns the select edge |
SketchOrientation | Returns or sets the orientation to create wire hole sketch |
SketchPlane | Returns the plane to create wire hole sketch |
Tag | Returns the Tag for this object. |
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¶
WireHoleBuilderTypes Enumeration | the plane to create wire hole sketch |
Property Detail¶
CenterlineLength¶
-
WireHoleBuilder.
CenterlineLength
¶ Returns or sets the centerline length to create wire hole
-------------------------------------
Getter Method
Signature
CenterlineLength
Returns: Returns the centerline length to create wire hole Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CenterlineLength
Parameters: centerlineLength (str) – Sets the centerline length to create wire hole New in version NX6.0.0.
License requirements: None.
CircleCenter¶
-
WireHoleBuilder.
CircleCenter
¶ Returns or sets the circle center to create wire hole
-------------------------------------
Getter Method
Signature
CircleCenter
Returns: Returns the circle center to create wire hole Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CircleCenter
Parameters: circleCenter ( NXOpen.Point
) – Sets the circle center to create wire holeNew in version NX6.0.0.
License requirements: None.
DistanceToEdgeMidpoint¶
-
WireHoleBuilder.
DistanceToEdgeMidpoint
¶ Returns or sets the distance to edge midpoint
-------------------------------------
Getter Method
Signature
DistanceToEdgeMidpoint
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceToEdgeMidpoint
Parameters: distanceToEdgeMidpoint (float) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
HoleDepth¶
-
WireHoleBuilder.
HoleDepth
¶ Returns or sets the depth of wire hole.
-------------------------------------
Getter Method
Signature
HoleDepth
Returns: Returns the depth of wire hole. Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HoleDepth
Parameters: holeDepth (float) – Sets the depth of wire hole. New in version NX7.5.0.
License requirements: None.
HoleDiameter¶
-
WireHoleBuilder.
HoleDiameter
¶ Returns or sets the diameter to create wire hole
-------------------------------------
Getter Method
Signature
HoleDiameter
Returns: Returns the diameter to create wire hole Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HoleDiameter
Parameters: holeDiameter (float) – Sets the diameter to create wire hole New in version NX6.0.0.
License requirements: None.
SelectEdge¶
-
WireHoleBuilder.
SelectEdge
¶ Returns the select edge
-------------------------------------
Getter Method
Signature
SelectEdge
Returns: Return type: NXOpen.SelectEdgeList
New in version NX11.0.0.
License requirements: None.
SketchOrientation¶
-
WireHoleBuilder.
SketchOrientation
¶ Returns or sets the orientation to create wire hole sketch
-------------------------------------
Getter Method
Signature
SketchOrientation
Returns: Returns the orientation to create wire hole sketch Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SketchOrientation
Parameters: sketchOrientation ( NXOpen.Direction
) – Sets the orientation to create wire hole sketchNew in version NX6.0.0.
License requirements: None.
SketchPlane¶
-
WireHoleBuilder.
SketchPlane
¶ Returns the plane to create wire hole sketch
-------------------------------------
Getter Method
Signature
SketchPlane
Returns: Returns the plane to create wire hole sketch Return type: NXOpen.ScCollector
New in version NX6.0.0.
License requirements: None.
Type¶
-
WireHoleBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Tooling.WireHoleBuilderTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Tooling.WireHoleBuilderTypes
) –New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Method Detail¶
Validate¶
-
WireHoleBuilder.
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.