FingerClearanceNotchBuilder Class¶
-
class
NXOpen.Die.FingerClearanceNotchBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a builder that is used to create or edit a
NXOpen.Die.FingerClearanceNotchfeature.To create a new instance of this class, use
NXOpen.Die.DieCollection.CreateFingerClearanceNotchBuilder()Default values.
Property Value Depth.Value 5 (millimeters part), 0.2 (inches part) ExtrudeWidth.Value 0 (millimeters part), 0 (inches part) Width.Value 5 (millimeters part), 0.2 (inches part) New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the angle tolerance. |
| Attributes | Returns the attribute title, value and face color to apply to the notch faces. |
| BaseOrientation | Returns the plane defining the base of the target solid. |
| ClearanceDirection | Returns the direction (pointing away from the solid) in which to clear material from the target solid. |
| Depth | Returns the expression containing the value for the clearance to provide into the target solid. |
| DistanceTolerance | Returns or sets the distance tolerance. |
| ExtrudeWidth | Returns the expression containing the value to use to extrude the section. |
| Geometry | Returns the geometry to use as the definition of the notch. |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| ReverseDirection | Returns or sets the value to apply, for the purpose of reversing, to the derived clearance direction if a face or sheet body is specified. |
| Section | Returns the open section constructed from curves, edges, or a sketch. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Target | Returns the target solid the finger clearance notch will be subtracted from. |
| Type | Returns or sets the indicator specifying the type of input data that defines how to build the notch. |
| Width | Returns the expression containing the value for the clearance to provide on either side of the notch. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| 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. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| FingerClearanceNotchBuilderTypes Enumeration | Specifies what type of base geometry to build the finger clearance notch from. |
Property Detail¶
AngleTolerance¶
-
FingerClearanceNotchBuilder.AngleTolerance¶ Returns or sets the angle tolerance.
-------------------------------------Getter Method
Signature
AngleToleranceReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleToleranceParameters: angleTolerance (float) – New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Attributes¶
-
FingerClearanceNotchBuilder.Attributes¶ Returns the attribute title, value and face color to apply to the notch faces.
-------------------------------------Getter Method
Signature
AttributesReturns: Return type: NXOpen.Die.DieAttributesBuilderNew in version NX7.5.0.
License requirements: None.
BaseOrientation¶
-
FingerClearanceNotchBuilder.BaseOrientation¶ Returns the plane defining the base of the target solid.
Used to orient the extrude and clearance directions.
-------------------------------------Getter Method
Signature
BaseOrientationReturns: Return type: NXOpen.Die.DiePlaneBuilderNew in version NX7.5.0.
License requirements: None.
ClearanceDirection¶
-
FingerClearanceNotchBuilder.ClearanceDirection¶ Returns the direction (pointing away from the solid) in which to clear material from the target solid.
-------------------------------------Getter Method
Signature
ClearanceDirectionReturns: Return type: NXOpen.Die.DieDirectionBuilderNew in version NX7.5.0.
License requirements: None.
Depth¶
-
FingerClearanceNotchBuilder.Depth¶ Returns the expression containing the value for the clearance to provide into the target solid.
-------------------------------------Getter Method
Signature
DepthReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
DistanceTolerance¶
-
FingerClearanceNotchBuilder.DistanceTolerance¶ Returns or sets the distance tolerance.
-------------------------------------Getter Method
Signature
DistanceToleranceReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceToleranceParameters: distanceTolerance (float) – New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
ExtrudeWidth¶
-
FingerClearanceNotchBuilder.ExtrudeWidth¶ Returns the expression containing the value to use to extrude the section.
The extrusion direction is specified by the cross product of the base orientation and the clearance direction.
-------------------------------------Getter Method
Signature
ExtrudeWidthReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
Geometry¶
-
FingerClearanceNotchBuilder.Geometry¶ Returns the geometry to use as the definition of the notch.
A single face or multiple connected faces can be specified, or a single sheet or body may be specified. Only valid when type is
Die.FingerClearanceNotchBuilderTypes.FaceorDie.FingerClearanceNotchBuilderTypes.SheetBody.-------------------------------------Getter Method
Signature
GeometryReturns: Return type: NXOpen.SelectNXObjectListNew in version NX7.5.0.
License requirements: None.
ReverseDirection¶
-
FingerClearanceNotchBuilder.ReverseDirection¶ Returns or sets the value to apply, for the purpose of reversing, to the derived clearance direction if a face or sheet body is specified.
If TRUE, then the derived direction will be flipped.
-------------------------------------Getter Method
Signature
ReverseDirectionReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseDirectionParameters: reverseDirection (bool) – New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Section¶
-
FingerClearanceNotchBuilder.Section¶ Returns the open section constructed from curves, edges, or a sketch.
Only valid when type is
Die.FingerClearanceNotchBuilderTypes.Section.-------------------------------------Getter Method
Signature
SectionReturns: Return type: NXOpen.SectionNew in version NX7.5.0.
License requirements: None.
Target¶
-
FingerClearanceNotchBuilder.Target¶ Returns the target solid the finger clearance notch will be subtracted from.
-------------------------------------Getter Method
Signature
TargetReturns: Return type: NXOpen.SelectBodyNew in version NX7.5.0.
License requirements: None.
Type¶
-
FingerClearanceNotchBuilder.Type¶ Returns or sets the indicator specifying the type of input data that defines how to build the notch.
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Die.FingerClearanceNotchBuilderTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Die.FingerClearanceNotchBuilderTypes) –New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Width¶
-
FingerClearanceNotchBuilder.Width¶ Returns the expression containing the value for the clearance to provide on either side of the notch.
-------------------------------------Getter Method
Signature
WidthReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
FingerClearanceNotchBuilder.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.