ShipSectionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ShipSectionBuilder Class

class `NXOpen.Features.ShipDesign.``ShipSectionBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.ShipDesign.ShipSection` builder

  To create a new instance of this class, use `NXOpen.Features.ShipCollection.CreateShipSectionBuilder()`

  Default values.

  Property | Value
  --- | ---
  ReadDataSet.CreateDataSetToggle | 0
  ReadDataSet.NativeToggle | 0
  XDatumFilter | All
  XMaxOffset.Value | 0 (millimeters part), 0 (inches part)
  XMinOffset.Value | 0 (millimeters part), 0 (inches part)
  YMaxOffset.Value | 0 (millimeters part), 0 (inches part)
  YMinOffset.Value | 0 (millimeters part), 0 (inches part)
  ZDatumFilter | All
  ZMaxOffset.Value | 0 (millimeters part), 0 (inches part)
  ZMinOffset.Value | 0 (millimeters part), 0 (inches part)

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AssemblyPart | Returns or sets the assembly part
BottomDeckSectionName | Returns or sets the bottom deck section name
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
ReadDataSet | Returns the Data Set Builder for reading data sets from Team Center
ReferenceGeometry | Returns the reference geometry
SectionName | Returns or sets the section name
SectionPart | Returns or sets the section part
SectionType | Returns or sets the creation method
SectionXMax | Returns or sets the section xmax
SectionXMin | Returns or sets the section xmin
SectionYMax | Returns or sets the section ymax
SectionYMin | Returns or sets the section ymin
SectionZMax | Returns or sets the section zmax
SectionZMin | Returns or sets the section zmin
ShipBodies | Returns the ship bodies
ShipBody | Returns the ship body
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
XDatumFilter | Returns or sets the x datum filter
XMaxDatumFilter | Returns or sets the x max datum filter
XMaxOffset | Returns the x max offset
XMinDatumFilter | Returns or sets the x min datum filter
XMinOffset | Returns the x min offset
YDatumFilter | Returns or sets the y datum filter
YMaxDatumFilter | Returns or sets the y max datum filter
YMaxOffset | Returns the y max offset
YMinDatumFilter | Returns or sets the y min datum filter
YMinOffset | Returns the y min offset
ZDatumFilter | Returns or sets the z datum filter
ZMaxDatumFilter | Returns or sets the z max datum filter
ZMaxOffset | Returns the z max offset
ZMinDatumFilter | Returns or sets the z min datum filter
ZMinOffset | Returns the z min offset

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
SetDeckContainer | Sets the deck container flag
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

ShipSectionBuilderType Enumeration | Define the creation type
ShipSectionBuilderXFilter Enumeration | Define the output option for each of the frame type
ShipSectionBuilderZFilter Enumeration | Define the output option for each of the frame type

# Property Detail

## AssemblyPart

`ShipSectionBuilder.``AssemblyPart`

  Returns or sets the assembly part

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

  Getter Method

  Signature `AssemblyPart`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AssemblyPart`

  Parameters: | filename (str) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## BottomDeckSectionName

`ShipSectionBuilder.``BottomDeckSectionName`

  Returns or sets the bottom deck section name

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

  Getter Method

  Signature `BottomDeckSectionName`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BottomDeckSectionName`

  Parameters: | bottomSectionName (str) –

  New in version NX12.0.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## ReadDataSet

`ShipSectionBuilder.``ReadDataSet`

  Returns the Data Set Builder for reading data sets from Team Center

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

  Getter Method

  Signature `ReadDataSet`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ReadDataSetBuilder`

  New in version NX8.5.0.

  License requirements: None.

## ReferenceGeometry

`ShipSectionBuilder.``ReferenceGeometry`

  Returns the reference geometry

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

  Getter Method

  Signature `ReferenceGeometry`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObjectList`

  New in version NX10.0.0.

  License requirements: None.

## SectionName

`ShipSectionBuilder.``SectionName`

  Returns or sets the section name

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

  Getter Method

  Signature `SectionName`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionName`

  Parameters: | sectionName (str) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionPart

`ShipSectionBuilder.``SectionPart`

  Returns or sets the section part

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

  Getter Method

  Signature `SectionPart`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionPart`

  Parameters: | filename (str) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionType

`ShipSectionBuilder.``SectionType`

  Returns or sets the creation method

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

  Getter Method

  Signature `SectionType`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ShipSectionBuilderType`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionType`

  Parameters: | type (`NXOpen.Features.ShipDesign.ShipSectionBuilderType`) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionXMax

`ShipSectionBuilder.``SectionXMax`

  Returns or sets the section xmax

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

  Getter Method

  Signature `SectionXMax`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionXMax`

  Parameters: | sectionXMax (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionXMin

`ShipSectionBuilder.``SectionXMin`

  Returns or sets the section xmin

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

  Getter Method

  Signature `SectionXMin`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionXMin`

  Parameters: | sectionXMin (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionYMax

`ShipSectionBuilder.``SectionYMax`

  Returns or sets the section ymax

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

  Getter Method

  Signature `SectionYMax`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionYMax`

  Parameters: | sectionYMax (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionYMin

`ShipSectionBuilder.``SectionYMin`

  Returns or sets the section ymin

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

  Getter Method

  Signature `SectionYMin`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionYMin`

  Parameters: | sectionYMin (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionZMax

`ShipSectionBuilder.``SectionZMax`

  Returns or sets the section zmax

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

  Getter Method

  Signature `SectionZMax`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionZMax`

  Parameters: | sectionZMax (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## SectionZMin

`ShipSectionBuilder.``SectionZMin`

  Returns or sets the section zmin

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

  Getter Method

  Signature `SectionZMin`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionZMin`

  Parameters: | sectionZMin (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## ShipBodies

`ShipSectionBuilder.``ShipBodies`

  Returns the ship bodies

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

  Getter Method

  Signature `ShipBodies`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObjectList`

  New in version NX12.0.0.

  License requirements: None.

## ShipBody

`ShipSectionBuilder.``ShipBody`

  Returns the ship body

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

  Getter Method

  Signature `ShipBody`

  Returns: |
  Return type: | `NXOpen.SelectBody`

  New in version NX7.5.0.

  License requirements: None.

## XDatumFilter

`ShipSectionBuilder.``XDatumFilter`

  Returns or sets the x datum filter

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

  Getter Method

  Signature `XDatumFilter`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ShipSectionBuilderXFilter`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `XDatumFilter`

  Parameters: | xDatumFilter (`NXOpen.Features.ShipDesign.ShipSectionBuilderXFilter`) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## XMaxDatumFilter

`ShipSectionBuilder.``XMaxDatumFilter`

  Returns or sets the x max datum filter

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

  Getter Method

  Signature `XMaxDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `XMaxDatumFilter`

  Parameters: | xMaxDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## XMaxOffset

`ShipSectionBuilder.``XMaxOffset`

  Returns the x max offset

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

  Getter Method

  Signature `XMaxOffset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## XMinDatumFilter

`ShipSectionBuilder.``XMinDatumFilter`

  Returns or sets the x min datum filter

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

  Getter Method

  Signature `XMinDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `XMinDatumFilter`

  Parameters: | xMinDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## XMinOffset

`ShipSectionBuilder.``XMinOffset`

  Returns the x min offset

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

  Getter Method

  Signature `XMinOffset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## YDatumFilter

`ShipSectionBuilder.``YDatumFilter`

  Returns or sets the y datum filter

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

  Getter Method

  Signature `YDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `YDatumFilter`

  Parameters: | yDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## YMaxDatumFilter

`ShipSectionBuilder.``YMaxDatumFilter`

  Returns or sets the y max datum filter

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

  Getter Method

  Signature `YMaxDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `YMaxDatumFilter`

  Parameters: | yMaxDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## YMaxOffset

`ShipSectionBuilder.``YMaxOffset`

  Returns the y max offset

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

  Getter Method

  Signature `YMaxOffset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## YMinDatumFilter

`ShipSectionBuilder.``YMinDatumFilter`

  Returns or sets the y min datum filter

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

  Getter Method

  Signature `YMinDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `YMinDatumFilter`

  Parameters: | yMinDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## YMinOffset

`ShipSectionBuilder.``YMinOffset`

  Returns the y min offset

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

  Getter Method

  Signature `YMinOffset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## ZDatumFilter

`ShipSectionBuilder.``ZDatumFilter`

  Returns or sets the z datum filter

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

  Getter Method

  Signature `ZDatumFilter`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.ShipSectionBuilderZFilter`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ZDatumFilter`

  Parameters: | zDatumFilter (`NXOpen.Features.ShipDesign.ShipSectionBuilderZFilter`) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## ZMaxDatumFilter

`ShipSectionBuilder.``ZMaxDatumFilter`

  Returns or sets the z max datum filter

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

  Getter Method

  Signature `ZMaxDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ZMaxDatumFilter`

  Parameters: | zMaxDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## ZMaxOffset

`ShipSectionBuilder.``ZMaxOffset`

  Returns the z max offset

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

  Getter Method

  Signature `ZMaxOffset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## ZMinDatumFilter

`ShipSectionBuilder.``ZMinDatumFilter`

  Returns or sets the z min datum filter

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

  Getter Method

  Signature `ZMinDatumFilter`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ZMinDatumFilter`

  Parameters: | zMinDatumFilter (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_concept (“Ship Concept”) OR nx_ship_detail (“Ship Detail Design”)

## ZMinOffset

`ShipSectionBuilder.``ZMinOffset`

  Returns the z min offset

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

  Getter Method

  Signature `ZMinOffset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## SetDeckContainer

`ShipSectionBuilder.``SetDeckContainer`

  Sets the deck container flag

  Signature `SetDeckContainer(isDeckContainer)`

  Parameters: | isDeckContainer (bool) –

  New in version NX12.0.0.

  License requirements: None.

## Validate

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