HoleFeatureBuilder Class¶
-
class
NXOpen.LineDesigner.
HoleFeatureBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
LineDesigner.HoleFeature
builderTo create a new instance of this class, use
NXOpen.LineDesigner.LineDesignerManager.CreateHoleFeatureBuilder
Default values.
Property Value AddCover 0 CoverThickness.Value 127 (millimeters part), 5 (inches part) LoadRequirements 0 TextSize 60 UseCoverOffset 0 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AddCover | Returns or sets the add cover |
CoverThickness | Returns the cover thickness |
LoadRequirements | Returns or sets the load requirements |
MakeSketchInternal | Returns or sets the make sketchInternal |
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 |
SelectOutline | Returns the select outline |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TextLocation | Returns or sets the text location |
TextSize | Returns or sets the text size |
UseCoverOffset | Returns or sets the use cover offset |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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. |
GetEnterTextString | Returns the enter text string @return |
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. |
SetEnterTextString | Sets the enter text string |
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. |
Property Detail¶
AddCover¶
-
HoleFeatureBuilder.
AddCover
¶ Returns or sets the add cover
-------------------------------------
Getter Method
Signature
AddCover()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
AddCover(addCover)
Parameters: addCover (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CoverThickness¶
-
HoleFeatureBuilder.
CoverThickness
¶ Returns the cover thickness
-------------------------------------
Getter Method
Signature
CoverThickness()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LoadRequirements¶
-
HoleFeatureBuilder.
LoadRequirements
¶ Returns or sets the load requirements
-------------------------------------
Getter Method
Signature
LoadRequirements()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
LoadRequirements(loadRequirements)
Parameters: loadRequirements (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
MakeSketchInternal¶
-
HoleFeatureBuilder.
MakeSketchInternal
¶ Returns or sets the make sketchInternal
-------------------------------------
Getter Method
Signature
MakeSketchInternal()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
MakeSketchInternal(makeSketchInternal)
Parameters: makeSketchInternal (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SelectOutline¶
-
HoleFeatureBuilder.
SelectOutline
¶ Returns the select outline
-------------------------------------
Getter Method
Signature
SelectOutline()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
TextLocation¶
-
HoleFeatureBuilder.
TextLocation
¶ Returns or sets the text location
-------------------------------------
Getter Method
Signature
TextLocation()
Returns: Return type: NXOpen.Point
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
TextLocation(textLocation)
Parameters: textLocation ( NXOpen.Point
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
TextSize¶
-
HoleFeatureBuilder.
TextSize
¶ Returns or sets the text size
-------------------------------------
Getter Method
Signature
TextSize()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
TextSize(textSize)
Parameters: textSize (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
UseCoverOffset¶
-
HoleFeatureBuilder.
UseCoverOffset
¶ Returns or sets the use cover offset
-------------------------------------
Getter Method
Signature
UseCoverOffset()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
UseCoverOffset(useCoverOffset)
Parameters: useCoverOffset (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Method Detail¶
GetEnterTextString¶
-
HoleFeatureBuilder.
GetEnterTextString
¶ Returns the enter text string
Signature
GetEnterTextString()
Returns: Return type: list of str New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SetEnterTextString¶
-
HoleFeatureBuilder.
SetEnterTextString
¶ Sets the enter text string
Signature
SetEnterTextString(enterTextString)
Parameters: enterTextString (list of str) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Validate¶
-
HoleFeatureBuilder.
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.