AlongGuideCutBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AlongGuideCutBuilder Class

class `NXOpen.Features.ShipDesign.``AlongGuideCutBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

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

  Default values.

  Property | Value
  --- | ---
  ArrowHeadAngle.Value | 60.0
  ArrowHeadHeight.Value | 5.0 (millimeters part), 0.2 (inches part)
  ArrowHeight.Value | 20.0 (millimeters part), 0.8 (inches part)
  DistanceTolerance | 0.0254 (millimeters part), 0.001 (inches part)
  LeftOffsetDistance.Value | 150.0 (millimeters part), 6.0 (inches part)
  RightOffsetDistance.Value | 150.0 (millimeters part), 6.0 (inches part)

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
ArrowHeadAngle | Returns the arrow head angle when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.EggBox < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>` in NX ship basic design.
ArrowHeadHeight | Returns the arrow head height when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.EggBox < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>` in NX ship basic design.
ArrowHeight | Returns the arrow height when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.EggBox < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>` in NX ship basic design.
DistanceTolerance | Returns or sets the distance tolerance.
GuideCurve | Returns the guide curve when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WeldClearance < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.
GuideCurveList | Returns the guide curve list when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WeldClearance < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.
LeftOffsetDistance | Returns the left offset distance when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod.Asymmetric < NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod>`, or the offset distance for both side when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod.Symmetric < NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod>`.
ManufacturingInformation | Returns the manufacturing stock builder that holds the manufacturing data.
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
PlacementType | Returns or sets the method used to define the placement of the along guide cut
RightOffsetDistance | Returns the right offset distance when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod.Asymmetric < NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod>`.
ShipStructure | Returns the target plate or stiffener when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WeldClearance < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.
ShipStructureEdge | Returns the target edge when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.
Spreadsheet | Returns the spreadsheet builder, `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`, which defines the along guide cut cross section type and parameters.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
WaterStopOffsetOption | Returns or sets the offset option when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.
WaterStopShape | Returns the tool object when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.
WaterStopShapeList | Returns the tool object list when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

# 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.
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

AlongGuideCutBuilderCreationMethod Enumeration | Creation method used to define the placement of the along guide cut
AlongGuideCutBuilderWaterStopOffsetMethod Enumeration | Offset option used to define the placement of the water stop guide cut

# Property Detail

## ArrowHeadAngle

`AlongGuideCutBuilder.``ArrowHeadAngle`

  Returns the arrow head angle when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.EggBox < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>` in NX ship basic design.

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

  Getter Method

  Signature `ArrowHeadAngle`

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

  New in version NX12.0.0.

  License requirements: None.

## ArrowHeadHeight

`AlongGuideCutBuilder.``ArrowHeadHeight`

  Returns the arrow head height when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.EggBox < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>` in NX ship basic design.

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

  Getter Method

  Signature `ArrowHeadHeight`

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

  New in version NX12.0.0.

  License requirements: None.

## ArrowHeight

`AlongGuideCutBuilder.``ArrowHeight`

  Returns the arrow height when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.EggBox < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>` in NX ship basic design.

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

  Getter Method

  Signature `ArrowHeight`

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

  New in version NX12.0.0.

  License requirements: None.

## DistanceTolerance

`AlongGuideCutBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX8.5.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## GuideCurve

`AlongGuideCutBuilder.``GuideCurve`

  Returns the guide curve when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WeldClearance < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `GuideCurve`

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

  New in version NX8.5.0.

  License requirements: None.

## GuideCurveList

`AlongGuideCutBuilder.``GuideCurveList`

  Returns the guide curve list when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WeldClearance < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `GuideCurveList`

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

  New in version NX11.0.0.

  License requirements: None.

## LeftOffsetDistance

`AlongGuideCutBuilder.``LeftOffsetDistance`

  Returns the left offset distance when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod.Asymmetric < NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod>`, or the offset distance for both side when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod.Symmetric < NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod>`.

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

  Getter Method

  Signature `LeftOffsetDistance`

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

  New in version NX8.5.0.

  License requirements: None.

## ManufacturingInformation

`AlongGuideCutBuilder.``ManufacturingInformation`

  Returns the manufacturing stock builder that holds the manufacturing data.

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

  Getter Method

  Signature `ManufacturingInformation`

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

  New in version NX8.5.1.

  License requirements: None.

## PlacementType

`AlongGuideCutBuilder.``PlacementType`

  Returns or sets the method used to define the placement of the along guide cut

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

  Getter Method

  Signature `PlacementType`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PlacementType`

  Parameters: | placementType (`NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod`) –

  New in version NX8.5.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## RightOffsetDistance

`AlongGuideCutBuilder.``RightOffsetDistance`

  Returns the right offset distance when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod.Asymmetric < NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod>`.

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

  Getter Method

  Signature `RightOffsetDistance`

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

  New in version NX8.5.0.

  License requirements: None.

## ShipStructure

`AlongGuideCutBuilder.``ShipStructure`

  Returns the target plate or stiffener when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WeldClearance < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `ShipStructure`

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

  New in version NX8.5.0.

  License requirements: None.

## ShipStructureEdge

`AlongGuideCutBuilder.``ShipStructureEdge`

  Returns the target edge when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `ShipStructureEdge`

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

  New in version NX8.5.0.

  License requirements: None.

## Spreadsheet

`AlongGuideCutBuilder.``Spreadsheet`

  Returns the spreadsheet builder, `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`, which defines the along guide cut cross section type and parameters.

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

  Getter Method

  Signature `Spreadsheet`

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

  New in version NX8.5.0.

  License requirements: None.

## WaterStopOffsetOption

`AlongGuideCutBuilder.``WaterStopOffsetOption`

  Returns or sets the offset option when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `WaterStopOffsetOption`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `WaterStopOffsetOption`

  Parameters: | offsetOption (`NXOpen.Features.ShipDesign.AlongGuideCutBuilderWaterStopOffsetMethod`) –

  New in version NX8.5.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## WaterStopShape

`AlongGuideCutBuilder.``WaterStopShape`

  Returns the tool object when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `WaterStopShape`

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

  New in version NX8.5.0.

  License requirements: None.

## WaterStopShapeList

`AlongGuideCutBuilder.``WaterStopShapeList`

  Returns the tool object list when the `NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod` is :py:class:` NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod.WaterStop < NXOpen.Features.ShipDesign.AlongGuideCutBuilderCreationMethod>`.

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

  Getter Method

  Signature `WaterStopShapeList`

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

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## Validate

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