EndCutBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# EndCutBuilder Class

class `NXOpen.Features.ShipDesign.``EndCutBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

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

  Default values.

  Property | Value
  --- | ---
  ConnectionType | Connected
  DraftAngle.Value | 0
  DraftOffset.Value | 0 (millimeters part), 0 (inches part)
  DraftType | Trim
  LimitType | Value
  Offset.Value | 0 (millimeters part), 0 (inches part)
  SelectionType | FacesWithAttributes
  ShearAngle.Value | 0
  TiltAngle.Value | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
ConnectionType | Returns or sets the connection type.
DraftAngle | Returns the draft angle
DraftOffset | Returns the draft offset.
DraftType | Returns or sets the draft type.
FlangeBoundary | Returns the flange boundary.
FlangeSketchData | Returns the flange sketch data.
LimitGeometry | Returns the limit geometry.
LimitType | Returns or sets the limit type.
Offset | Returns the offset.
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
PlacementEdge | Returns the select placement edges.
PlacementFaces | Returns the select placement faces.
Plane | Returns or sets the plane.
SelectionType | Returns or sets the selection type.
ShearAngle | Returns the shear angle.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TiltAngle | Returns the tilt angle
ToeSketchData | Returns the toe sketch data.
WebSketchData | Returns the web sketch data.

# 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.
InheritParametersFromEndcutFace | Copy the parameters from the endcut face to this endcut.
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

EndCutBuilderConnectionTypes Enumeration | <para> This enum defines the different ways a limiting geometry can connect to the endcut face.
EndCutBuilderDraftTypes Enumeration | This enum defines the types of draft to be applied.
EndCutBuilderLimitTypes Enumeration | This enum defines the different ways users can trim the ends of a profile or a plate.
EndCutBuilderSelectionTypes Enumeration | This enum defines the Placement Face and Placement Edge Selection Type.

# Property Detail

## ConnectionType

`EndCutBuilder.``ConnectionType`

  Returns or sets the connection type.

  If the Limit Type is `NXOpen.Features.ShipDesign.EndCutBuilderLimitTypes.NeatTrim`, users can define the connection type between the endcut face and the limiting geometry. Users can control the available flange, web or toe section types using the connection type in the rules.

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

  Getter Method

  Signature `ConnectionType`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ConnectionType`

  Parameters: | connectionType (`NXOpen.Features.ShipDesign.EndCutBuilderConnectionTypes`) –

  New in version NX9.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## DraftAngle

`EndCutBuilder.``DraftAngle`

  Returns the draft angle

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

  Getter Method

  Signature `DraftAngle`

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

  New in version NX8.0.0.

  License requirements: None.

## DraftOffset

`EndCutBuilder.``DraftOffset`

  Returns the draft offset.

  This is the distance from the end of the Placement Edge where the Stiffener end face will be split.

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

  Getter Method

  Signature `DraftOffset`

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

  New in version NX8.0.0.

  License requirements: None.

## DraftType

`EndCutBuilder.``DraftType`

  Returns or sets the draft type.

  A partial taper can be applied to the end face of a Stiffener. The end face will be split and the Draft Type defines which split face is tapered.

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

  Getter Method

  Signature `DraftType`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DraftType`

  Parameters: | draftType (`NXOpen.Features.ShipDesign.EndCutBuilderDraftTypes`) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## FlangeBoundary

`EndCutBuilder.``FlangeBoundary`

  Returns the flange boundary.

  This input is required when the Limit Type is `NXOpen.Features.ShipDesign.EndCutBuilderLimitTypes.NeatTrim`. Only a single body may be specified and it must have at least one face with MK_TYPE=MOLDINGLINE and one face with MK_TYPE=OPPOSINGMOLDINGLINE attributes. This input is applicable only when an endcut is applied to a Builtup stiffener. It will be ignored for all other cases. This input will let users define a plate or a stiffener without flange as a limit geometry and specify an edge reinforcement as a flange boundary. Users can also specify a plate as a flange boundary.

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

  Getter Method

  Signature `FlangeBoundary`

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

  New in version NX9.0.2.

  License requirements: None.

## FlangeSketchData

`EndCutBuilder.``FlangeSketchData`

  Returns the flange sketch data.

  Users can specify the EndCut using upto three sketches. The sketch type and its parameters are controlled by the `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`.

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

  Getter Method

  Signature `FlangeSketchData`

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

  New in version NX9.0.0.

  License requirements: None.

## LimitGeometry

`EndCutBuilder.``LimitGeometry`

  Returns the limit geometry.

  This input is required when the Limit Type is `NXOpen.Features.ShipDesign.EndCutBuilderLimitTypes.NeatTrim`. Valid types are Plane, Face or a Body. If a Body is specified, it must have at least one face with MK_TYPE=MOLDINGLINE and one face with MK_TYPE=OPPOSINGMOLDINGLINE attributes.

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

  Getter Method

  Signature `LimitGeometry`

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

  New in version NX8.0.0.

  License requirements: None.

## LimitType

`EndCutBuilder.``LimitType`

  Returns or sets the limit type.

  The Tilt and Shear angles can be supplied as expressions or can be inferred from a Plane. Users can also limit the ends using a face or a body.

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

  Getter Method

  Signature `LimitType`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LimitType`

  Parameters: | limitType (`NXOpen.Features.ShipDesign.EndCutBuilderLimitTypes`) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## Offset

`EndCutBuilder.``Offset`

  Returns the offset.

  The Offset is always applied after the Tilt and Shear Angles.

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

  Getter Method

  Signature `Offset`

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

  New in version NX8.0.0.

  License requirements: None.

## PlacementEdge

`EndCutBuilder.``PlacementEdge`

  Returns the select placement edges.

  This input is only required when the Selection Type is `NXOpen.Features.ShipDesign.EndCutBuilderSelectionTypes.FaceAndEdge`. This edge must belong to the face specified as Placement Face.

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

  Getter Method

  Signature `PlacementEdge`

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

  New in version NX8.0.0.

  License requirements: None.

## PlacementFaces

`EndCutBuilder.``PlacementFaces`

  Returns the select placement faces.

  If the Selection Type is `NXOpen.Features.ShipDesign.EndCutBuilderSelectionTypes.FacesWithAttributes` this list can contain multiple faces and each face must be a valid endcut face, i.e. faces with SAW_SIZE and SAW_SIZE2 attributes whose value is same as the Perpendicular EndCut Name defined in the customer defaults. If the Selection Type is `NXOpen.Features.ShipDesign.EndCutBuilderSelectionTypes.FaceAndEdge`, this list must contain a single face. Each face will result in a separate EndCut feature. If an existing EndCut feature is queried, it will contain a single face in this list.

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

  Getter Method

  Signature `PlacementFaces`

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

  New in version NX8.0.0.

  License requirements: None.

## Plane

`EndCutBuilder.``Plane`

  Returns or sets the plane.

  If the Limit Type is `NXOpen.Features.ShipDesign.EndCutBuilderLimitTypes.Plane`, the Tilt and Shear angle will be inferred automatically from this plane.

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

  Getter Method

  Signature `Plane`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Plane`

  Parameters: | plane (`NXOpen.Plane`) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## SelectionType

`EndCutBuilder.``SelectionType`

  Returns or sets the selection type.

  Users can provide a set of faces where the edge can be inferred automatically or specify a single pair of a Face and an edge(Placement Edge).

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

  Getter Method

  Signature `SelectionType`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectionType`

  Parameters: | selectionType (`NXOpen.Features.ShipDesign.EndCutBuilderSelectionTypes`) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## ShearAngle

`EndCutBuilder.``ShearAngle`

  Returns the shear angle.

  The Shear Angle is always applied after the Tilt Angle.

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

  Getter Method

  Signature `ShearAngle`

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

  New in version NX8.0.0.

  License requirements: None.

## TiltAngle

`EndCutBuilder.``TiltAngle`

  Returns the tilt angle

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

  Getter Method

  Signature `TiltAngle`

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

  New in version NX8.0.0.

  License requirements: None.

## ToeSketchData

`EndCutBuilder.``ToeSketchData`

  Returns the toe sketch data.

  Users can specify the EndCut using upto three sketches. The sketch type and its parameters are controlled by the `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`.

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

  Getter Method

  Signature `ToeSketchData`

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

  New in version NX8.0.0.

  License requirements: None.

## WebSketchData

`EndCutBuilder.``WebSketchData`

  Returns the web sketch data.

  Users can specify the EndCut using upto three sketches. The sketch type and its parameters are controlled by the `NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder`.

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

  Getter Method

  Signature `WebSketchData`

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

  New in version NX8.0.0.

  License requirements: None.

# Method Detail

## InheritParametersFromEndcutFace

`EndCutBuilder.``InheritParametersFromEndcutFace`

  Copy the parameters from the endcut face to this endcut.

  The input face must belong to an endcut feature and should have all the attributes. All the builder parameters will be replaced with copies of parameters from the input face. If any change is made after this call, the copied parameter value will be overwritten.

  Signature `InheritParametersFromEndcutFace(endcutFace)`

  Parameters: | endcutFace (`NXOpen.Face`) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”)

## Validate

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