ProfileBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ProfileBuilder Class

class `NXOpen.Features.ShipDesign.``ProfileBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

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

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

  Default values.

  Property | Value
  --- | ---
  AngleOfRotation.Value | 0
  AngularTolerance | 0.5
  BeltAlignment | Center
  DistanceTolerance | 0.0254 (millimeters part), 0.001 (inches part)
  EndCutType | None
  EndEndCutBlock.Angle.Value | 0
  EndEndCutBlock.Offset.Value | 0
  EndEndCutBlock.SketchBlock.Exp1.Value | 0
  EndEndCutBlock.SketchBlock.Exp10.Value | 0
  EndEndCutBlock.SketchBlock.Exp11.Value | 0
  EndEndCutBlock.SketchBlock.Exp12.Value | 0
  EndEndCutBlock.SketchBlock.Exp2.Value | 0
  EndEndCutBlock.SketchBlock.Exp3.Value | 0
  EndEndCutBlock.SketchBlock.Exp4.Value | 0
  EndEndCutBlock.SketchBlock.Exp5.Value | 0
  EndEndCutBlock.SketchBlock.Exp6.Value | 0
  EndEndCutBlock.SketchBlock.Exp7.Value | 0
  EndEndCutBlock.SketchBlock.Exp8.Value | 0
  EndEndCutBlock.SketchBlock.Exp9.Value | 0
  EndEndCutBlock.SketchBlock.Sketches | EndCut1
  EndEndCutBlock.TaperType | Trim
  FaceOffsetExpression.Value | 0
  GuideOffsetExpression.Value | 0
  KeepFace | 0
  KeepGuide | 0
  OrientType | FaceNormal
  PlateHeight.Value | 0
  PlateWIdth.Value | 0
  SectionType | Profile

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AngleOfRotation | Returns the angle of rotation
AngularTolerance | Returns or sets the angular tolerance (degrees).
AttributeMaterial | Returns or sets the material attribute
AttributeName | Returns or sets the name attribute value
BeltAlignment | Returns or sets the belt alignment
BeltSize | Returns or sets the belt size options
BeltType | Returns or sets the belt type options
CurveLengthData | Returns the curve length data
DistanceTolerance | Returns or sets the distance tolerance (part units).
EndCutType | Returns or sets the end cut type
EndEndCutBlock | Returns the end end cut block
FaceOffsetExpression | Returns the face offset expression
FaceOffsetVector | Returns or sets the face offset vector
GuideOffsetExpression | Returns the guide offset expression
GuideOffsetVector | Returns or sets the guide offset vector
GuideSection | Returns the select edge
KeepFace | Returns or sets the toggle which allows re-use of the selected faces
KeepGuide | Returns or sets the toggle which allows re-use of the selected edges or curves
OrientType | Returns or sets the orient type
OrientationVector | Returns or sets the orientation vector
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
PlateHeight | Returns the plate height
PlateWIdth | Returns the plate width
ProfileSize | Returns or sets the profile size options
ProfileType | Returns or sets the profile type options
SectionType | Returns or sets the section type
SelectCsys | Returns the select csys
SelectFace | Returns the placement faces or datum plane
StartEndCutBlock | Returns the start end cut block
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the type belt or profile

# 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
GetAvailableBeltSizes | Returns the list of available material attributes
GetAvailableBeltTypes | Returns the list of available material attributes
GetAvailableProfileSizes | Returns the list of available material attributes
GetAvailableProfileTypes | Returns the list of available material 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

ProfileBuilderAlignment Enumeration | Creation method used to define the placement of the belt this is disabled for profiles
ProfileBuilderEndCutOption Enumeration | Creation method used to define the end cut type
ProfileBuilderOrientationOption Enumeration | Creation method used to define the placement of the profile this is disabled for belt creation
ProfileBuilderSectionOption Enumeration | Creation of profile from the library or a plate
ProfileBuilderTypeOption Enumeration | Creation type either a belt or a profile

# Property Detail

## AngleOfRotation

`ProfileBuilder.``AngleOfRotation`

  Returns the angle of rotation

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

  Getter Method

  Signature `AngleOfRotation`

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

  New in version NX7.5.1.

  License requirements: None.

## AngularTolerance

`ProfileBuilder.``AngularTolerance`

  Returns or sets the angular tolerance (degrees).

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

  Getter Method

  Signature `AngularTolerance`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngularTolerance`

  Parameters: | angularTolerance (float) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## AttributeMaterial

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

`ProfileBuilder.``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”)

## BeltAlignment

`ProfileBuilder.``BeltAlignment`

  Returns or sets the belt alignment

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

  Getter Method

  Signature `BeltAlignment`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BeltAlignment`

  Parameters: | beltAlignment (`NXOpen.Features.ShipDesign.ProfileBuilderAlignment`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## BeltSize

`ProfileBuilder.``BeltSize`

  Returns or sets the belt size options

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

  Getter Method

  Signature `BeltSize`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BeltSize`

  Parameters: | size (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## BeltType

`ProfileBuilder.``BeltType`

  Returns or sets the belt type options

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

  Getter Method

  Signature `BeltType`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BeltType`

  Parameters: | type (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## CurveLengthData

`ProfileBuilder.``CurveLengthData`

  Returns the curve length data

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

  Getter Method

  Signature `CurveLengthData`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.CurveLengthData`

  New in version NX7.5.0.

  License requirements: None.

## DistanceTolerance

`ProfileBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance (part units).

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX8.0.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## EndCutType

`ProfileBuilder.``EndCutType`

  Returns or sets the end cut type

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

  Getter Method

  Signature `EndCutType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EndCutType`

  Parameters: | endCutType (`NXOpen.Features.ShipDesign.ProfileBuilderEndCutOption`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## EndEndCutBlock

`ProfileBuilder.``EndEndCutBlock`

  Returns the end end cut block

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

  Getter Method

  Signature `EndEndCutBlock`

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

  New in version NX7.5.0.

  License requirements: None.

## FaceOffsetExpression

`ProfileBuilder.``FaceOffsetExpression`

  Returns the face offset expression

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

  Getter Method

  Signature `FaceOffsetExpression`

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

  New in version NX7.5.0.

  License requirements: None.

## FaceOffsetVector

`ProfileBuilder.``FaceOffsetVector`

  Returns or sets the face offset vector

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

  Getter Method

  Signature `FaceOffsetVector`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FaceOffsetVector`

  Parameters: | faceOffsetVector (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## GuideOffsetExpression

`ProfileBuilder.``GuideOffsetExpression`

  Returns the guide offset expression

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

  Getter Method

  Signature `GuideOffsetExpression`

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

  New in version NX7.5.0.

  License requirements: None.

## GuideOffsetVector

`ProfileBuilder.``GuideOffsetVector`

  Returns or sets the guide offset vector

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

  Getter Method

  Signature `GuideOffsetVector`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `GuideOffsetVector`

  Parameters: | guideOffsetVector (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## GuideSection

`ProfileBuilder.``GuideSection`

  Returns the select edge

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

  Getter Method

  Signature `GuideSection`

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

  New in version NX7.5.0.

  License requirements: None.

## KeepFace

`ProfileBuilder.``KeepFace`

  Returns or sets the toggle which allows re-use of the selected faces

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

  Getter Method

  Signature `KeepFace`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepFace`

  Parameters: | keepFace (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## KeepGuide

`ProfileBuilder.``KeepGuide`

  Returns or sets the toggle which allows re-use of the selected edges or curves

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

  Getter Method

  Signature `KeepGuide`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepGuide`

  Parameters: | keepGuide (bool) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## OrientType

`ProfileBuilder.``OrientType`

  Returns or sets the orient type

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

  Getter Method

  Signature `OrientType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OrientType`

  Parameters: | orientType (`NXOpen.Features.ShipDesign.ProfileBuilderOrientationOption`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## OrientationVector

`ProfileBuilder.``OrientationVector`

  Returns or sets the orientation vector

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

  Getter Method

  Signature `OrientationVector`

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

  New in version NX7.5.4.

  License requirements: None.

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

  Setter Method

  Signature `OrientationVector`

  Parameters: | orientationVector (`NXOpen.Direction`) –

  New in version NX7.5.4.

  License requirements: nx_ship_concept (“Ship Concept”)

## PlateHeight

`ProfileBuilder.``PlateHeight`

  Returns the plate height

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

  Getter Method

  Signature `PlateHeight`

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

  New in version NX7.5.0.

  License requirements: None.

## PlateWIdth

`ProfileBuilder.``PlateWIdth`

  Returns the plate width

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

  Getter Method

  Signature `PlateWIdth`

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

  New in version NX7.5.0.

  License requirements: None.

## ProfileSize

`ProfileBuilder.``ProfileSize`

  Returns or sets the profile size options

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

  Getter Method

  Signature `ProfileSize`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ProfileSize`

  Parameters: | size (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## ProfileType

`ProfileBuilder.``ProfileType`

  Returns or sets the profile type options

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

  Getter Method

  Signature `ProfileType`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ProfileType`

  Parameters: | type (int) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## SectionType

`ProfileBuilder.``SectionType`

  Returns or sets the section type

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

  Getter Method

  Signature `SectionType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionType`

  Parameters: | sectionType (`NXOpen.Features.ShipDesign.ProfileBuilderSectionOption`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## SelectCsys

`ProfileBuilder.``SelectCsys`

  Returns the select csys

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

  Getter Method

  Signature `SelectCsys`

  Returns: |
  Return type: | `NXOpen.Features.SelectFeatureList`

  New in version NX7.5.0.

  License requirements: None.

## SelectFace

`ProfileBuilder.``SelectFace`

  Returns the placement faces or datum plane

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

  Getter Method

  Signature `SelectFace`

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

  New in version NX7.5.0.

  License requirements: None.

## StartEndCutBlock

`ProfileBuilder.``StartEndCutBlock`

  Returns the start end cut block

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

  Getter Method

  Signature `StartEndCutBlock`

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

  New in version NX7.5.0.

  License requirements: None.

## Type

`ProfileBuilder.``Type`

  Returns or sets the type belt or profile

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

  Getter Method

  Signature `Type`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.ShipDesign.ProfileBuilderTypeOption`) –

  New in version NX7.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

# Method Detail

## GetAvailableAttributeMaterials

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

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

## GetAvailableBeltSizes

`ProfileBuilder.``GetAvailableBeltSizes`

  Returns the list of available material attributes

  Signature `GetAvailableBeltSizes()`

  Returns: | Array of available belt types derived

  from the belt library. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## GetAvailableBeltTypes

`ProfileBuilder.``GetAvailableBeltTypes`

  Returns the list of available material attributes

  Signature `GetAvailableBeltTypes()`

  Returns: | Array of available belt types derived

  from the belt library. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## GetAvailableProfileSizes

`ProfileBuilder.``GetAvailableProfileSizes`

  Returns the list of available material attributes

  Signature `GetAvailableProfileSizes()`

  Returns: | Array of available profile types derived

  from the profile library. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## GetAvailableProfileTypes

`ProfileBuilder.``GetAvailableProfileTypes`

  Returns the list of available material attributes

  Signature `GetAvailableProfileTypes()`

  Returns: | Array of available profile types derived

  from the profile library. :rtype: list of str

  New in version NX7.5.0.

  License requirements: None.

## Validate

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