ShipNavigatorNodeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ShipNavigatorNodeBuilder Class

class `NXOpen.ShipDesign.``ShipNavigatorNodeBuilder`

  Bases: `NXOpen.Builder`

  Represents the ship navigator node builder to add or edit ship navigator node.

  To create a new instance of this class, use `NXOpen.ShipDesign.NavigatorCollection.CreateShipNavigatorNodeBuilder()`

  New in version NX11.0.1.

# Properties

Property | Description
--- | ---
ExpandChildNodes | Returns or sets the setting indicates if the node we create or edit will expand its children in ship navigator.
NodeName | Returns or sets the ship navigator node name.
NodeType | Returns or sets the ship navigator node type, which can be object, part or container.
SourceFeatures | Returns the list of features used to create ship navigator object node.
SourceParts | Returns the list of parts used to create ship navigator part nodes.
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.
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.

# Enumerations

ShipNavigatorNodeBuilderNodeTypes Enumeration | Settings to indicate the type of ship navigator node.

# Property Detail

## ExpandChildNodes

`ShipNavigatorNodeBuilder.``ExpandChildNodes`

  Returns or sets the setting indicates if the node we create or edit will expand its children in ship navigator.

  `-------------------------------------`

  Getter Method

  Signature `ExpandChildNodes`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ExpandChildNodes`

  Parameters: | expandNode (bool) –

  New in version NX11.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## NodeName

`ShipNavigatorNodeBuilder.``NodeName`

  Returns or sets the ship navigator node name.

  `-------------------------------------`

  Getter Method

  Signature `NodeName`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NodeName`

  Parameters: | nodeName (str) –

  New in version NX11.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## NodeType

`ShipNavigatorNodeBuilder.``NodeType`

  Returns or sets the ship navigator node type, which can be object, part or container.

  `-------------------------------------`

  Getter Method

  Signature `NodeType`

  Returns: |
  Return type: | `NXOpen.ShipDesign.ShipNavigatorNodeBuilderNodeTypes`

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NodeType`

  Parameters: | type (`NXOpen.ShipDesign.ShipNavigatorNodeBuilderNodeTypes`) –

  New in version NX11.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## SourceFeatures

`ShipNavigatorNodeBuilder.``SourceFeatures`

  Returns the list of features used to create ship navigator object node.

  `-------------------------------------`

  Getter Method

  Signature `SourceFeatures`

  Returns: |
  Return type: | `NXOpen.Features.SelectFeatureList`

  New in version NX11.0.1.

  License requirements: None.

## SourceParts

`ShipNavigatorNodeBuilder.``SourceParts`

  Returns the list of parts used to create ship navigator part nodes.

  `-------------------------------------`

  Getter Method

  Signature `SourceParts`

  Returns: |
  Return type: | `NXOpen.Assemblies.SelectComponentList`

  New in version NX11.0.1.

  License requirements: None.

# Method Detail

## Validate

`ShipNavigatorNodeBuilder.``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.