SelectStructuresBuilder Class¶
-
class
NXOpen.Features.ShipDesign.SelectStructuresBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderThis builder allows you to select structures in
NXOpen.Features.ShipDesign.GeneralArrangementViewBuilder.It represents
NXOpen.Features.ShipDesign.SelectStructuresBuilder.New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| AdditionalStructures | Returns the additional structures selected by the user |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AddStructuresByRule | Adds ship structures to the view |
| GetFinalStructuresByRule | Searches ship structures added to the view by the rule |
| RemoveStructuresByRule | Removes ship structures from the view |
| ResetStructuresByRule | Resets the structures to be added to the view by rule |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AdditionalStructures¶
-
SelectStructuresBuilder.AdditionalStructures¶ Returns the additional structures selected by the user
-------------------------------------Getter Method
Signature
AdditionalStructuresReturns: Return type: NXOpen.SelectNXObjectListNew in version NX12.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
Method Detail¶
AddStructuresByRule¶
-
SelectStructuresBuilder.AddStructuresByRule¶ Adds ship structures to the view
Signature
AddStructuresByRule(structures)Parameters: structures (list of NXOpen.Assemblies.Component) –New in version NX12.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
GetFinalStructuresByRule¶
-
SelectStructuresBuilder.GetFinalStructuresByRule¶ Searches ship structures added to the view by the rule
Signature
GetFinalStructuresByRule()Returns: Return type: list of NXOpen.Assemblies.ComponentNew in version NX12.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
RemoveStructuresByRule¶
-
SelectStructuresBuilder.RemoveStructuresByRule¶ Removes ship structures from the view
Signature
RemoveStructuresByRule(structures)Parameters: structures (list of NXOpen.Assemblies.Component) –New in version NX12.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ResetStructuresByRule¶
-
SelectStructuresBuilder.ResetStructuresByRule¶ Resets the structures to be added to the view by rule
Signature
ResetStructuresByRule()New in version NX12.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
Validate¶
-
SelectStructuresBuilder.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.