ExamineSteelFeatureBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ExamineSteelFeatureBuilder
¶ Bases:
NXOpen.Builder
Represents the examine steel feature builder to examine steel feature.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateExamineSteelFeatureBuilder()
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
SelectObject | Returns the Examining objects. |
Tag | Returns the Tag for this object. |
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. |
DisplayInformation | Displays the Examining results in the information window. |
Examine | Examines the selected objects. |
GetCheckResult | Get the Examining status. |
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. |
HighlightCheckResult | Highlights or unhighlights the geometries in graphic to display the check result. |
SetCheck | Set the flag to indicate whether or not to examine the specific object type. |
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. |
Property Detail¶
SelectObject¶
-
ExamineSteelFeatureBuilder.
SelectObject
¶ Returns the Examining objects.
-------------------------------------
Getter Method
Signature
SelectObject
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX9.0.0.
License requirements: None.
Method Detail¶
DisplayInformation¶
-
ExamineSteelFeatureBuilder.
DisplayInformation
¶ Displays the Examining results in the information window.
Signature
DisplayInformation()
New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Examine¶
-
ExamineSteelFeatureBuilder.
Examine
¶ Examines the selected objects.
Signature
Examine()
New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
GetCheckResult¶
-
ExamineSteelFeatureBuilder.
GetCheckResult
¶ Get the Examining status.
Signature
GetCheckResult(check)
Parameters: check ( NXOpen.Features.ShipDesign.ExamineSteelFeatureBuilderCheck
) – Type of CheckReturns: Return type: NXOpen.Features.ShipDesign.ExamineSteelFeatureBuilderResult
New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
HighlightCheckResult¶
-
ExamineSteelFeatureBuilder.
HighlightCheckResult
¶ Highlights or unhighlights the geometries in graphic to display the check result.
Signature
HighlightCheckResult(check, highlight)
Parameters: - check (
NXOpen.Features.ShipDesign.ExamineSteelFeatureBuilderCheck
) – Type of Check - highlight (bool) –
New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
- check (
SetCheck¶
-
ExamineSteelFeatureBuilder.
SetCheck
¶ Set the flag to indicate whether or not to examine the specific object type.
Signature
SetCheck(check, status)
Parameters: - check (
NXOpen.Features.ShipDesign.ExamineSteelFeatureBuilderCheck
) – Type of Check - status (bool) –
New in version NX9.0.0.
License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
- check (
Validate¶
-
ExamineSteelFeatureBuilder.
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.