CustomBracketBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CustomBracketBuilder Class

class `NXOpen.Features.ShipDesign.``CustomBracketBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

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

  Default values.

  Property | Value
  --- | ---
  SketchBlock.Exp1.Value | 0
  SketchBlock.Exp10.Value | 0
  SketchBlock.Exp11.Value | 0
  SketchBlock.Exp12.Value | 0
  SketchBlock.Exp2.Value | 0
  SketchBlock.Exp3.Value | 0
  SketchBlock.Exp4.Value | 0
  SketchBlock.Exp5.Value | 0
  SketchBlock.Exp6.Value | 0
  SketchBlock.Exp7.Value | 0
  SketchBlock.Exp8.Value | 0
  SketchBlock.Exp9.Value | 0
  SketchBlock.Sketches | EndCut1

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AttributeMaterial | Returns or sets the material attribute
AttributeName | Returns or sets the name attribute value
CoordSystem | Returns or sets the placement csys of the bracket
HeelOffset | Returns the heel offset
HeelPoint | Returns or sets the heel point
KeepCoordSystem | Returns or sets the toggle which allows re-use of the previous coordinate system
KeepHeelPoint | Returns or sets the toggle which allows re-use of the previous heel point
KeepPlacementPlane | Returns or sets the toggle which allows re-use of the previous placement plane
KeepReferencePlane | Returns or sets the toggle which allows re-use of the previous reference plane
KeepReverseDirection | Returns or sets the toggle which allows re-use of the previous flip direction toggle
KeepSelectTrimFace | Returns or sets the keep select trim face A toggle used to remember the selected object(s) on apply.
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
PlacementPlane | Returns or sets the placement plane
PlacementType | Returns or sets the method used to define the placement of the bracket
ReferencePlane | Returns or sets the reference plane
ReverseDirection | Returns or sets the flip direction toggle for the extrude direction
SelectTrimFace | Returns the select trim face.
SketchBlock | Returns the sketch block
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Thickness | Returns the thickness of the bracket

# 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.
GetAvailableAttributeMaterials | Returns the list of available material attributes
GetAvailableAttributeNames | Returns the list of available name attributes
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

CustomBracketBuilderCreationMethod Enumeration | Creation method used to define the placement of the bracket

# Property Detail

## AttributeMaterial

`CustomBracketBuilder.``AttributeMaterial`

  Returns or sets the material attribute

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

  Getter Method

  Signature `AttributeMaterial`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AttributeMaterial`

  Parameters: | material (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## AttributeName

`CustomBracketBuilder.``AttributeName`

  Returns or sets the name attribute value

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

  Getter Method

  Signature `AttributeName`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AttributeName`

  Parameters: | name (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## CoordSystem

`CustomBracketBuilder.``CoordSystem`

  Returns or sets the placement csys of the bracket

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

  Getter Method

  Signature `CoordSystem`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CoordSystem`

  Parameters: | coordSystem (`NXOpen.CoordinateSystem`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## HeelOffset

`CustomBracketBuilder.``HeelOffset`

  Returns the heel offset

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

  Getter Method

  Signature `HeelOffset`

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

  New in version NX7.5.0.

  License requirements: None.

## HeelPoint

`CustomBracketBuilder.``HeelPoint`

  Returns or sets the heel point

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

  Getter Method

  Signature `HeelPoint`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HeelPoint`

  Parameters: | heelPoint (`NXOpen.Point`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepCoordSystem

`CustomBracketBuilder.``KeepCoordSystem`

  Returns or sets the toggle which allows re-use of the previous coordinate system

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

  Getter Method

  Signature `KeepCoordSystem`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepCoordSystem`

  Parameters: | keepCoordSystem (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepHeelPoint

`CustomBracketBuilder.``KeepHeelPoint`

  Returns or sets the toggle which allows re-use of the previous heel point

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

  Getter Method

  Signature `KeepHeelPoint`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepHeelPoint`

  Parameters: | keepHeelPoint (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepPlacementPlane

`CustomBracketBuilder.``KeepPlacementPlane`

  Returns or sets the toggle which allows re-use of the previous placement plane

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

  Getter Method

  Signature `KeepPlacementPlane`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepPlacementPlane`

  Parameters: | keepPlacementPlane (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepReferencePlane

`CustomBracketBuilder.``KeepReferencePlane`

  Returns or sets the toggle which allows re-use of the previous reference plane

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

  Getter Method

  Signature `KeepReferencePlane`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepReferencePlane`

  Parameters: | keepReferencePlane (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepReverseDirection

`CustomBracketBuilder.``KeepReverseDirection`

  Returns or sets the toggle which allows re-use of the previous flip direction toggle

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

  Getter Method

  Signature `KeepReverseDirection`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepReverseDirection`

  Parameters: | keepReverseDirection (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepSelectTrimFace

`CustomBracketBuilder.``KeepSelectTrimFace`

  Returns or sets the keep select trim face A toggle used to remember the selected object(s) on apply.

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

  Getter Method

  Signature `KeepSelectTrimFace`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepSelectTrimFace`

  Parameters: | keepSelectTrimFace (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## PlacementPlane

`CustomBracketBuilder.``PlacementPlane`

  Returns or sets the placement plane

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

  Getter Method

  Signature `PlacementPlane`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PlacementPlane`

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

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## PlacementType

`CustomBracketBuilder.``PlacementType`

  Returns or sets the method used to define the placement of the bracket

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

  Getter Method

  Signature `PlacementType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PlacementType`

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

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## ReferencePlane

`CustomBracketBuilder.``ReferencePlane`

  Returns or sets the reference plane

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

  Getter Method

  Signature `ReferencePlane`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ReferencePlane`

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

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## ReverseDirection

`CustomBracketBuilder.``ReverseDirection`

  Returns or sets the flip direction toggle for the extrude direction

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

  Getter Method

  Signature `ReverseDirection`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseDirection`

  Parameters: | reverseDirection (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## SelectTrimFace

`CustomBracketBuilder.``SelectTrimFace`

  Returns the select trim face.

  Specifies the face(s) to cut holes in.

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

  Getter Method

  Signature `SelectTrimFace`

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

  New in version NX7.5.0.

  License requirements: None.

## SketchBlock

`CustomBracketBuilder.``SketchBlock`

  Returns the sketch block

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

  Getter Method

  Signature `SketchBlock`

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

  New in version NX7.5.0.

  License requirements: None.

## Thickness

`CustomBracketBuilder.``Thickness`

  Returns the thickness of the bracket

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

  Getter Method

  Signature `Thickness`

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

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GetAvailableAttributeMaterials

`CustomBracketBuilder.``GetAvailableAttributeMaterials`

  Returns the list of available material attributes

  Signature `GetAvailableAttributeMaterials()`

  Returns: | Array of available attribute materials.

  These materials are specified in the customer defaults file. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## GetAvailableAttributeNames

`CustomBracketBuilder.``GetAvailableAttributeNames`

  Returns the list of available name attributes

  Signature `GetAvailableAttributeNames()`

  Returns: | Array of available attribute names.

  These names are specified in the customer defaults file. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## Validate

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