PlaneListBuilder Class¶
-
class
NXOpen.Features.ShipDesign.PlaneListBuilder¶ Bases:
NXOpen.BuilderThis class is used to place a plane into a list.
To create a new instance of this class, use
NXOpen.Features.ShipDesign.FeatureParmsBuilder.CreatePlaneForList()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| Plane | Returns or sets the plane defined. |
| Tag | Returns the Tag for this object. |
| Valid | Returns or sets the indication if the defined plane is valid or not. |
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. |
Property Detail¶
Plane¶
-
PlaneListBuilder.Plane¶ Returns or sets the plane defined.
-------------------------------------Getter Method
Signature
PlaneReturns: Return type: NXOpen.PlaneNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneParameters: plane1 ( NXOpen.Plane) –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”)
Valid¶
-
PlaneListBuilder.Valid¶ Returns or sets the indication if the defined plane is valid or not.
-------------------------------------Getter Method
Signature
ValidReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ValidParameters: valid (bool) – 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”)
Method Detail¶
Validate¶
-
PlaneListBuilder.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.