SteelCollarPlateBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SteelCollarPlateBuilder Class

class `NXOpen.Features.ShipDesign.``SteelCollarPlateBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

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

  Default values.

  Property | Value
  --- | ---
  IsInternal | 0
  KeepSelectFace | 0
  KeepSelectProfileBody | 0

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
IsInternal | Returns or sets the is internal toggle.
KeepSelectFace | Returns or sets the keep select face.
KeepSelectProfileBody | Returns or sets the keep select profile body.
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
PlateSize | Returns or sets the plate size.
SelectFace | Returns the select face.
SelectProfileBody | Returns the select profile body.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# 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.
GetAvailablePlateSizes | The list of available plate sizes.
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.

# Property Detail

## IsInternal

`SteelCollarPlateBuilder.``IsInternal`

  Returns or sets the is internal toggle.

  Is this plate inside the profile cutout, or slapped onto the outside of the placement face?

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

  Getter Method

  Signature `IsInternal`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `IsInternal`

  Parameters: | isInternal (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepSelectFace

`SteelCollarPlateBuilder.``KeepSelectFace`

  Returns or sets the keep select face.

  Determines whether or not we should reuse the same selected face on apply.

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

  Getter Method

  Signature `KeepSelectFace`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepSelectFace`

  Parameters: | keepSelectFace (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepSelectProfileBody

`SteelCollarPlateBuilder.``KeepSelectProfileBody`

  Returns or sets the keep select profile body.

  Determines whether or not we should reuse the same selected profile body on apply.

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

  Getter Method

  Signature `KeepSelectProfileBody`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepSelectProfileBody`

  Parameters: | keepSelectProfileBody (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## PlateSize

`SteelCollarPlateBuilder.``PlateSize`

  Returns or sets the plate size.

  Note: when the selected profile body changes, the available sizes will also change. Therefore, after changing the selected profile, you must call GetAvailablePlateSizes before you can set this PlateSize value.

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

  Getter Method

  Signature `PlateSize`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PlateSize`

  Parameters: | plateSize (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## SelectFace

`SteelCollarPlateBuilder.``SelectFace`

  Returns the select face.

  The face is used along with the profile body to determine the placement of the collar plate feature. Typically this face will already have a profile cutout feature and the collar plate is used to “fill the gap” caused by the profile cutout.

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

  Getter Method

  Signature `SelectFace`

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

  New in version NX7.5.0.

  License requirements: None.

## SelectProfileBody

`SteelCollarPlateBuilder.``SelectProfileBody`

  Returns the select profile body.

  The profile body determines what sizes of collar plate features are available, and where to place the collar plate feature.

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

  Getter Method

  Signature `SelectProfileBody`

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

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GetAvailablePlateSizes

`SteelCollarPlateBuilder.``GetAvailablePlateSizes`

  The list of available plate sizes.

  Note this list will change every time the selected profile body changes.

  Signature `GetAvailablePlateSizes()`

  Returns: | Array of available plate sizes.

  These names are specified by a special sketch naming convention for sketches loaded in the profile library. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## Validate

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