CollarPlateBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CollarPlateBuilder Class

class `NXOpen.Features.ShipDesign.``CollarPlateBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

  This builder is used to create and edit collar plate feature. The collar plate feature can be created from a profile cutout feature.

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

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
AngularTolerance | Returns or sets the angular tolerance (degrees)
DistanceTolerance | Returns or sets the distance tolerance (part units)
InstallDirection | Returns or sets the install direction.
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
ProfileCutout | Returns the profile cutout.
SectionData | Returns the section data.
ShipNames | Returns the ship name.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
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
UpdateCollarPlateSizeInformation | Updates collar plate size from the context information.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AngularTolerance

`CollarPlateBuilder.``AngularTolerance`

  Returns or sets the angular tolerance (degrees)

  The angular tolerance is used for:

  > - collar plate placement orign and orientation evaluation
  > - collar plate 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”)

## DistanceTolerance

`CollarPlateBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance (part units)

  The distance tolerance is used for:

  > - collar plate placement orign and orientation evaluation
  > - collar plate 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”)

## InstallDirection

`CollarPlateBuilder.``InstallDirection`

  Returns or sets the install direction.

  The install direction defines which side (molding face side or opposite molding face side) the collar plate is attached to the plate.

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

  Getter Method

  Signature `InstallDirection`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InstallDirection`

  Parameters: | installDirection (`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”)

## ManufacturingStock

`CollarPlateBuilder.``ManufacturingStock`

  Returns the manufacturing stock.

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

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

  Getter Method

  Signature `ManufacturingStock`

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

  New in version NX11.0.0.

  License requirements: None.

## ProfileCutout

`CollarPlateBuilder.``ProfileCutout`

  Returns the profile cutout.

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

  Getter Method

  Signature `ProfileCutout`

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

  New in version NX11.0.0.

  License requirements: None.

## SectionData

`CollarPlateBuilder.``SectionData`

  Returns the section data.

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

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

  Getter Method

  Signature `SectionData`

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

  New in version NX11.0.0.

  License requirements: None.

## ShipNames

`CollarPlateBuilder.``ShipNames`

  Returns the ship name.

  The ship name is used to assign name to the collar plate.

  It is only used in Ship Structure Basic Design Application.

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

  Getter Method

  Signature `ShipNames`

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

  New in version NX11.0.0.

  License requirements: None.

## WeldCharacteristics

`CollarPlateBuilder.``WeldCharacteristics`

  Returns the weld characteristics.

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

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

  Getter Method

  Signature `WeldCharacteristics`

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

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## UpdateCollarPlateSizeInformation

`CollarPlateBuilder.``UpdateCollarPlateSizeInformation`

  Updates collar plate size from the context information.

  The collar plate size depends on the profile cutout size.

  Signature `UpdateCollarPlateSizeInformation()`

  New in version NX11.0.0.

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

## Validate

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