FeatureParmsBuilder Class¶
-
class
NXOpen.Features.ShipDesign.FeatureParmsBuilder¶ Bases:
NXOpen.Features.FeatureBuilderThis class is used to create or edit the information shared among all Ship Design features.
Currently only Basic Design features are utilizing this class.
Cannot create directly.
New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the tolerance, in degrees, used to determine when angles are zero. |
| DistanceTolerance | Returns or sets the tolerance used to determine when distances are considered zero. |
| OrientationAngleRule | Returns or sets the angle rule to use when measuring angles. |
| 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 |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| CreatePlaneForList | Create a NXOpen.Features.ShipDesign.PlaneListBuilder to add a defined plane to a list. |
| 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¶
| FeatureParmsBuilderOrientationAngleRuleTypes Enumeration | Settings to indicate how angles are to be measured. |
Property Detail¶
AngleTolerance¶
-
FeatureParmsBuilder.AngleTolerance¶ Returns or sets the tolerance, in degrees, used to determine when angles are zero.
-------------------------------------Getter Method
Signature
AngleToleranceReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleToleranceParameters: angleTolerance (float) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
DistanceTolerance¶
-
FeatureParmsBuilder.DistanceTolerance¶ Returns or sets the tolerance used to determine when distances are considered zero.
-------------------------------------Getter Method
Signature
DistanceToleranceReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceToleranceParameters: distanceTolerance (float) – New in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
OrientationAngleRule¶
-
FeatureParmsBuilder.OrientationAngleRule¶ Returns or sets the angle rule to use when measuring angles.
-------------------------------------Getter Method
Signature
OrientationAngleRuleReturns: Return type: NXOpen.Features.ShipDesign.FeatureParmsBuilderOrientationAngleRuleTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OrientationAngleRuleParameters: angleRule ( NXOpen.Features.ShipDesign.FeatureParmsBuilderOrientationAngleRuleTypes) –New in version NX9.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Method Detail¶
CreatePlaneForList¶
-
FeatureParmsBuilder.CreatePlaneForList¶ Create a
NXOpen.Features.ShipDesign.PlaneListBuilderto add a defined plane to a list.Signature
CreatePlaneForList()Returns: Return type: NXOpen.Features.ShipDesign.PlaneListBuilderNew in version NX8.0.0.
License requirements: nx_ship_concept (“Ship Concept”) OR nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Validate¶
-
FeatureParmsBuilder.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.