LabellingRoomsBuilder Class¶
-
class
NXOpen.Features.ShipDesign.LabellingRoomsBuilder¶ Bases:
NXOpen.BuilderRepresents a
Features.ShipDesign.LabellingRoomsBuilderbuilderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateLabellingRoomsBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| RoomsSelection | Returns the rooms selection |
| 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. |
| 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. |
| GetPmiNoteTags | Get rooms pmi notes |
| 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¶
RoomsSelection¶
-
LabellingRoomsBuilder.RoomsSelection¶ Returns the rooms selection
-------------------------------------Getter Method
Signature
RoomsSelectionReturns: Return type: NXOpen.Assemblies.SelectComponentListNew in version NX12.0.0.
License requirements: None.
Method Detail¶
GetPmiNoteTags¶
-
LabellingRoomsBuilder.GetPmiNoteTags¶ Get rooms pmi notes
Signature
GetPmiNoteTags()Returns: Return type: list of NXOpen.Annotations.PmiNoteNew in version NX12.0.0.
License requirements: None.
Validate¶
-
LabellingRoomsBuilder.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.