BracketBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BracketBuilder Class

class `NXOpen.Features.ShipDesign.``BracketBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

  This builder is used to create and edit bracket feature.

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

  Default values.

  Property | Value
  --- | ---
  AlignmentAngle.Value | 0
  AlignmentType | DatumPlaneAlignment
  BracketOffset.Value | 0 (millimeters part), 0 (inches part)
  LimitType | NoLimit

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
AlignmentAngle | Returns the alignment angle along attachment entity.
AlignmentPlane | Returns the alignment plane.
AlignmentType | Returns or sets the bracket alignment type.
AngularTolerance | Returns or sets the angular tolerance (degrees)
AttachmentDirection | Returns or sets the install direction on attachment face.
AttachmentFace | Returns the attachment face.
AttachmentStiffener | Returns the attachment stiffener.
BracketOffset | Returns the offset to the alignment plane or attachment stiffener molding face.
DistanceTolerance | Returns or sets the distance tolerance (part units)
EndAttachment | Returns the end attachment.
LimitType | Returns or sets the limit type.
ManufacturingStock | Returns the manufacturing stock.
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
PickPointOnAttachment | Returns or sets the pick point on attachment face.
PickPointOnReinforcement | Returns or sets the pick point on reinforcement face.
ReinforcementDirection | Returns or sets the install direction on reinforcement face.
ReinforcementFace | Returns the reinforcement face.
ReinforcementStiffener | Returns the reinforcement stiffener.
SectionData | Returns the section data.
ShipNames | Returns the ship name.
StartAttachment | Returns the start attachment.
StartAttachmentLimit | Returns the start attachment limit.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
ThicknessDirection | Returns or sets the thickness direction.
WeldCharacteristics | Returns the weld characteristics.

# 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

BracketBuilderAlignmentTypes Enumeration | The alignment types.
BracketBuilderLimitTypes Enumeration | The limit types.

# Property Detail

## AlignmentAngle

`BracketBuilder.``AlignmentAngle`

  Returns the alignment angle along attachment entity.

  The bracket edge on reinforcement face side is rotated by this angle along the bracket edge on the attachment side.

  The unit is in degree.

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

  Getter Method

  Signature `AlignmentAngle`

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

  New in version NX11.0.0.

  License requirements: None.

## AlignmentPlane

`BracketBuilder.``AlignmentPlane`

  Returns the alignment plane.

  The bracket molding face is aligned to the alignment plane if no offset is set in `NXOpen.Features.ShipDesign.BracketBuilder.BracketOffset()`

  It is only used when `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentType`()` is set to `Features.ShipDesign.BracketBuilderAlignmentTypes.DatumPlaneAlignment`.

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

  Getter Method

  Signature `AlignmentPlane`

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

  New in version NX11.0.0.

  License requirements: None.

## AlignmentType

`BracketBuilder.``AlignmentType`

  Returns or sets the bracket alignment type.

  If you set the alignment type to `Features.ShipDesign.BracketBuilderAlignmentTypes.DatumPlaneAlignment`, then please also set values for below properties:

  > - `NXOpen.Features.ShipDesign.BracketBuilder.ReinforcementFace()`
  > - `NXOpen.Features.ShipDesign.BracketBuilder.AttachmentFace()`
  > - `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentPlane()`

  If you set the alignment type to `Features.ShipDesign.BracketBuilderAlignmentTypes.AutoAlignment`, then please also set values for below properties:

  > - `NXOpen.Features.ShipDesign.BracketBuilder.ReinforcementFace()`
  > - `NXOpen.Features.ShipDesign.BracketBuilder.AttachmentStiffener()`

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

  Getter Method

  Signature `AlignmentType`

  Returns: | Alignment type
  Return type: | `NXOpen.Features.ShipDesign.BracketBuilderAlignmentTypes`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AlignmentType`

  Parameters: | alignmentType (`NXOpen.Features.ShipDesign.BracketBuilderAlignmentTypes`) – Alignment type

  New in version NX11.0.0.

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

## AngularTolerance

`BracketBuilder.``AngularTolerance`

  Returns or sets the angular tolerance (degrees)

  The angular tolerance is used for:

  > - bracket placement orign and orientation evaluation
  > - bracket geometry construction

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

  Getter Method

  Signature `AngularTolerance`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngularTolerance`

  Parameters: | angularTolerance (float) –

  New in version NX11.0.0.

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

## AttachmentDirection

`BracketBuilder.``AttachmentDirection`

  Returns or sets the install direction on attachment face.

  The attachment direction defines which side the bracket is attached to the attachment face. You can either place the bracket on the attachment face normal side or the opposite side. The install directions are ship orientations based on the attachment face normal. For example: If the attachment face normal is in ‘For’ direction, then you should set the install direction to either ‘For’ or ‘Aft’.

  It is only used in Ship Structure Basic Design Application.

  It is only used when `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentType`()` is set to `Features.ShipDesign.BracketBuilderAlignmentTypes.DatumPlaneAlignment`.

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

  Getter Method

  Signature `AttachmentDirection`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AttachmentDirection`

  Parameters: | attachmentDirection (`NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection`) –

  New in version NX11.0.0.

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

## AttachmentFace

`BracketBuilder.``AttachmentFace`

  Returns the attachment face.

  The attachment face defines the faces which the bracket is attached to. You can attach the bracket to more than one faces.

  The attachment face is only used when `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentType`()` is set to `Features.ShipDesign.BracketBuilderAlignmentTypes.DatumPlaneAlignment`.

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

  Getter Method

  Signature `AttachmentFace`

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

  New in version NX11.0.0.

  License requirements: None.

## AttachmentStiffener

`BracketBuilder.``AttachmentStiffener`

  Returns the attachment stiffener.

  The bracket is attached to the stiffener body top face and aligned to the stiffener molding face if no offset is set in `NXOpen.Features.ShipDesign.BracketBuilder.BracketOffset()`

  It is only used when `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentType`()` is set to `Features.ShipDesign.BracketBuilderAlignmentTypes.AutoAlignment`.

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

  Getter Method

  Signature `AttachmentStiffener`

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

  New in version NX11.0.0.

  License requirements: None.

## BracketOffset

`BracketBuilder.``BracketOffset`

  Returns the offset to the alignment plane or attachment stiffener molding face.

  If offset is zero, the bracket molding face is aligned to the alignment plane or attachment stiffener molding face.

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

  Getter Method

  Signature `BracketOffset`

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

  New in version NX11.0.0.

  License requirements: None.

## DistanceTolerance

`BracketBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance (part units)

  The distance tolerance is used for:

  > - bracket placement orign and orientation evaluation
  > - bracket geometry construction

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX11.0.0.

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

## EndAttachment

`BracketBuilder.``EndAttachment`

  Returns the end attachment.

  This defines the limit object on the end side.

  It is used when `NXOpen.Features.ShipDesign.BracketBuilder.LimitType`()` is set to `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.TwoLimit` or `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.ThreeLimit`.

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

  Getter Method

  Signature `EndAttachment`

  Returns: | End attachment
  Return type: | `NXOpen.ScCollector`

  New in version NX11.0.0.

  License requirements: None.

## LimitType

`BracketBuilder.``LimitType`

  Returns or sets the limit type.

  If you set the limit type to `Features.ShipDesign.BracketBuilderLimitTypes.NoLimit`, you don’t need to set any limit object.

  If you set the limit type to `Features.ShipDesign.BracketBuilderLimitTypes.OneLimit`, then please also set value for `NXOpen.Features.ShipDesign.BracketBuilder.StartAttachment()`.

  If you set the alignment type to `Features.ShipDesign.BracketBuilderLimitTypes.TwoLimit`, then please also set values for below properties:

  > - `NXOpen.Features.ShipDesign.BracketBuilder.StartAttachment()`
  > - `NXOpen.Features.ShipDesign.BracketBuilder.EndAttachment()`

  If you set the alignment type to `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.ThreeLimit`, then please also set values for below properties:

  > - `NXOpen.Features.ShipDesign.BracketBuilder.StartAttachment()`
  > - `NXOpen.Features.ShipDesign.BracketBuilder.EndAttachment()`
  > - `NXOpen.Features.ShipDesign.BracketBuilder.StartAttachmentLimit()`

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

  Getter Method

  Signature `LimitType`

  Returns: | Limit type
  Return type: | `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LimitType`

  Parameters: | limitType (`NXOpen.Features.ShipDesign.BracketBuilderLimitTypes`) – Limit type

  New in version NX11.0.0.

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

## ManufacturingStock

`BracketBuilder.``ManufacturingStock`

  Returns the manufacturing stock.

  The manufacturing stock defines data that is to be applied to the bracket.

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

  Getter Method

  Signature `ManufacturingStock`

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

  New in version NX11.0.0.

  License requirements: None.

## PickPointOnAttachment

`BracketBuilder.``PickPointOnAttachment`

  Returns or sets the pick point on attachment face.

  When the attachment face is curved (such as a cylindrical face), the bracket can be placed at multiple locations, then the pick point is used. The position which is closest to the pick point is used.

  It is optional. If there are multiple candidate locations and this is not set, a random location is chosen.

  It is only used when `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentType`()` is set to `Features.ShipDesign.BracketBuilderAlignmentTypes.DatumPlaneAlignment`.

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

  Getter Method

  Signature `PickPointOnAttachment`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PickPointOnAttachment`

  Parameters: | pickPoint (`NXOpen.Point3d`) –

  New in version NX11.0.0.

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

## PickPointOnReinforcement

`BracketBuilder.``PickPointOnReinforcement`

  Returns or sets the pick point on reinforcement face.

  When the reinforcement face is curved (such as a cylindrical face), the bracket can be placed at multiple locations, then the pick point is used. The location which is closest to the pick point is used.

  It is optional. If there are multiple candidate locations and this is not set, a random location is chosen.

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

  Getter Method

  Signature `PickPointOnReinforcement`

  Returns: | Pick Point type
  Return type: | `NXOpen.Point3d`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PickPointOnReinforcement`

  Parameters: | pickPoint (`NXOpen.Point3d`) – Pick Point type

  New in version NX11.0.0.

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

## ReinforcementDirection

`BracketBuilder.``ReinforcementDirection`

  Returns or sets the install direction on reinforcement face.

  The reinforcement direction defines which side the bracket is placed on the reinforcement face. You can either place the bracket on the reinforcement face normal side or the opposite side. The install directions are ship orientations based on the reinforcement face normal. For example: If the reinforcement face normal is in ‘For’ direction, then you should set the install direction to either ‘For’ or ‘Aft’.

  It is only used in Ship Structure Basic Design Application.

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

  Getter Method

  Signature `ReinforcementDirection`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReinforcementDirection`

  Parameters: | reinforcementDirection (`NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection`) –

  New in version NX11.0.0.

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

## ReinforcementFace

`BracketBuilder.``ReinforcementFace`

  Returns the reinforcement face.

  The reinforcement face defines the objects which need to be reinforced. More than one faces can be reinforced by the bracket.

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

  Getter Method

  Signature `ReinforcementFace`

  Returns: | Reinforcement face
  Return type: | `NXOpen.ScCollector`

  New in version NX11.0.0.

  License requirements: None.

## ReinforcementStiffener

`BracketBuilder.``ReinforcementStiffener`

  Returns the reinforcement stiffener.

  The reinforcement stiffener defines the objects which need to be reinforced.

  It is only used when `NXOpen.Features.ShipDesign.BracketBuilder.AlignmentType`()` is set to `Features.ShipDesign.BracketBuilderAlignmentTypes.Lapped`.

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

  Getter Method

  Signature `ReinforcementStiffener`

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

  New in version NX12.0.0.

  License requirements: None.

## SectionData

`BracketBuilder.``SectionData`

  Returns the section data.

  The section data defines the shape of the bracket and expressions to control the size of the bracket.

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

  Getter Method

  Signature `SectionData`

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

  New in version NX11.0.0.

  License requirements: None.

## ShipNames

`BracketBuilder.``ShipNames`

  Returns the ship name.

  The ship name is used to assign name to the bracket.

  It is only used in Ship Structure Basic Design Application.

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

  Getter Method

  Signature `ShipNames`

  Returns: | Ship names
  Return type: | `NXOpen.Features.ShipDesign.ShipNamesBuilder`

  New in version NX11.0.0.

  License requirements: None.

## StartAttachment

`BracketBuilder.``StartAttachment`

  Returns the start attachment.

  This defines the limit object on the start side.

  It is used when `NXOpen.Features.ShipDesign.BracketBuilder.LimitType`()` is set to `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.OneLimit` or `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.TwoLimit` or `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.ThreeLimit`.

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

  Getter Method

  Signature `StartAttachment`

  Returns: | Start attachment
  Return type: | `NXOpen.ScCollector`

  New in version NX11.0.0.

  License requirements: None.

## StartAttachmentLimit

`BracketBuilder.``StartAttachmentLimit`

  Returns the start attachment limit.

  This defines the limit object on the start attachment entity.

  It is used when `NXOpen.Features.ShipDesign.BracketBuilder.LimitType`()` is set to `NXOpen.Features.ShipDesign.BracketBuilderLimitTypes.ThreeLimit`.

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

  Getter Method

  Signature `StartAttachmentLimit`

  Returns: | Start attachment limit
  Return type: | `NXOpen.ScCollector`

  New in version NX11.0.0.

  License requirements: None.

## ThicknessDirection

`BracketBuilder.``ThicknessDirection`

  Returns or sets the thickness direction.

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

  Getter Method

  Signature `ThicknessDirection`

  Returns: | Thickness direction
  Return type: | `NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ThicknessDirection`

  Parameters: | thicknessDirection (`NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection`) – Thickness direction

  New in version NX11.0.0.

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

## WeldCharacteristics

`BracketBuilder.``WeldCharacteristics`

  Returns the weld characteristics.

  The weld characteristics defines data that is to be applied to the bracket weld edges.

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

  Getter Method

  Signature `WeldCharacteristics`

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

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## Validate

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