SplitStandardPartBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SplitStandardPartBuilder Class

class `NXOpen.Features.ShipDesign.``SplitStandardPartBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.ShipDesign.SplitStandardPartBuilder`.

  This class is for splitting ship standard part

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

  Default values.

  Property | Value
  --- | ---
  AngularTolerance | 0.5
  BaseCornerCut.DistanceTolerance | 0.0254 (millimeters part), 0.001 (inches part)
  DistanceTolerance | 0.0254
  LocationOffset.Value | 0 (millimeters part), 0 (inches part)
  OrientationAngle.Value | 0
  ReinforceOffset.Value | 0 (millimeters part), 0 (inches part)
  SplitReinforcement | 1

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AngularTolerance | Returns or sets the tolerance, in degrees, used to determine when angles are zero.
BaseCornerCut | Returns the corner cut at the base point on the standard part.
DistanceTolerance | Returns or sets the tolerance used to determine when distances are considered zero.
LocationOffset | Returns the offset value to the split location on the standard part base.
OrientationAngle | Returns the orientation angle relative to the split curve or plane to split the standard part.
ReinforceOffset | Returns the offset value to the split location on the standard part reinforcement.
ReinforcementCornerCut | Returns the corner cut at the reinforcement point.
ReverseSplitDirection | Returns or sets the flag to indicate whether to reverse the split direction or not.
SplitReinforcement | Returns or sets the flag to indicate whether to split the reinforcement part on the standard part.
Tag | Returns the Tag for this object.
ToolCurve | Returns the tool curve which used to split the standard part.
ToolFacePlane | Returns the tool face or plane used to split the standard part.
ToolType | Returns or sets the split tool type to split the standard part.
WeldCharacteristics | Returns the weld characteristics assigned to the split edges.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
ConvertObjectsToAdd | Converts the selected objects to acceptable one and add to the selection list.
ConvertObjectsToRemove | Converts the selected objects to acceptable one and remove it from the selection list.
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.
Reset | Resets the calculation results of standard part split when tool object changes.
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

SplitStandardPartBuilderToolTypes Enumeration | Represents the split tool types.

# Property Detail

## AngularTolerance

`SplitStandardPartBuilder.``AngularTolerance`

  Returns or sets the tolerance, in degrees, used to determine when angles are zero.

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

  Getter Method

  Signature `AngularTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngularTolerance`

  Parameters: | angularTolerance (float) –

  New in version NX9.0.0.

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

## BaseCornerCut

`SplitStandardPartBuilder.``BaseCornerCut`

  Returns the corner cut at the base point on the standard part.

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

  Getter Method

  Signature `BaseCornerCut`

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

  New in version NX9.0.0.

  License requirements: None.

## DistanceTolerance

`SplitStandardPartBuilder.``DistanceTolerance`

  Returns or sets the tolerance used to determine when distances are considered zero.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX9.0.0.

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

## LocationOffset

`SplitStandardPartBuilder.``LocationOffset`

  Returns the offset value to the split location on the standard part base.

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

  Getter Method

  Signature `LocationOffset`

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

  New in version NX9.0.0.

  License requirements: None.

## OrientationAngle

`SplitStandardPartBuilder.``OrientationAngle`

  Returns the orientation angle relative to the split curve or plane to split the standard part.

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

  Getter Method

  Signature `OrientationAngle`

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

  New in version NX9.0.0.

  License requirements: None.

## ReinforceOffset

`SplitStandardPartBuilder.``ReinforceOffset`

  Returns the offset value to the split location on the standard part reinforcement.

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

  Getter Method

  Signature `ReinforceOffset`

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

  New in version NX9.0.0.

  License requirements: None.

## ReinforcementCornerCut

`SplitStandardPartBuilder.``ReinforcementCornerCut`

  Returns the corner cut at the reinforcement point.

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

  Getter Method

  Signature `ReinforcementCornerCut`

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

  New in version NX9.0.0.

  License requirements: None.

## ReverseSplitDirection

`SplitStandardPartBuilder.``ReverseSplitDirection`

  Returns or sets the flag to indicate whether to reverse the split direction or not.

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

  Getter Method

  Signature `ReverseSplitDirection`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseSplitDirection`

  Parameters: | reverseSplitDirection (bool) –

  New in version NX9.0.0.

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

## SplitReinforcement

`SplitStandardPartBuilder.``SplitReinforcement`

  Returns or sets the flag to indicate whether to split the reinforcement part on the standard part.

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

  Getter Method

  Signature `SplitReinforcement`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SplitReinforcement`

  Parameters: | splitReinforcement (bool) –

  New in version NX9.0.0.

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

## ToolCurve

`SplitStandardPartBuilder.``ToolCurve`

  Returns the tool curve which used to split the standard part.

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

  Getter Method

  Signature `ToolCurve`

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

  New in version NX9.0.0.

  License requirements: None.

## ToolFacePlane

`SplitStandardPartBuilder.``ToolFacePlane`

  Returns the tool face or plane used to split the standard part.

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

  Getter Method

  Signature `ToolFacePlane`

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

  New in version NX9.0.0.

  License requirements: None.

## ToolType

`SplitStandardPartBuilder.``ToolType`

  Returns or sets the split tool type to split the standard part.

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

  Getter Method

  Signature `ToolType`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToolType`

  Parameters: | toolType (int) –

  New in version NX9.0.0.

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

## WeldCharacteristics

`SplitStandardPartBuilder.``WeldCharacteristics`

  Returns the weld characteristics assigned to the split edges.

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

  Getter Method

  Signature `WeldCharacteristics`

  Returns: |
  Return type: | `NXOpen.Weld.CharacteristicsBuilder`

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## ConvertObjectsToAdd

`SplitStandardPartBuilder.``ConvertObjectsToAdd`

  Converts the selected objects to acceptable one and add to the selection list.

  Signature `ConvertObjectsToAdd(selectedObjectTags)`

  Parameters: | selectedObjectTags (list of `NXOpen.DisplayableObject`) –

  New in version NX9.0.0.

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

## ConvertObjectsToRemove

`SplitStandardPartBuilder.``ConvertObjectsToRemove`

  Converts the selected objects to acceptable one and remove it from the selection list.

  Signature `ConvertObjectsToRemove(selectedObjectTags)`

  Parameters: | selectedObjectTags (list of `NXOpen.DisplayableObject`) –

  New in version NX9.0.0.

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

## Reset

`SplitStandardPartBuilder.``Reset`

  Resets the calculation results of standard part split when tool object changes.

  Signature `Reset()`

  New in version NX9.0.0.

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

## Validate

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