ProfileSystemBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ProfileSystemBuilder Class

class `NXOpen.Features.ShipDesign.``ProfileSystemBuilder`

  Bases: `NXOpen.Features.ShipDesign.FeatureParmsBuilder`

  This class is used to create or edit the information shared between all the Basic Design profile system features in the Ship Design application.

  Currently this includes the following features: `NXOpen.Features.ShipDesign.StiffenerSystem`, `NXOpen.Features.ShipDesign.PillarSystem`, and `NXOpen.Features.ShipDesign.EdgeReinforcement`.

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

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the tolerance, in degrees, used to determine when angles are zero.
Boundary1 | Returns the collector containing the plate system, profile system, or datum plane that will be used to trim the first end of the generated profile system.
Boundary1Plane | Returns or sets the defined plane that will be used to trim the first end of the generated profile system.
Boundary2 | Returns the collector containing the plate system, profile system, or datum plane that will be used to trim the second end of the generated profile system.
Boundary2Plane | Returns or sets the defined plane that will be used to trim the second end of the generated profile system.
BoundaryReverse | Returns or sets the indication if the side of a single boundary should be changed to the other side or not.
DistanceTolerance | Returns or sets the tolerance used to determine when distances are considered zero.
FirstIntersectionPoints | Returns the selected intersection points between the curves and the first boundary.
OrientationAngleRule | Returns or sets the angle rule to use when measuring angles.
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
ReversePathDirection | Returns or sets the flag that indicates if the default curve direction should be reversed or not.
SecondIntersectionPoints | Returns the selected intersection points between the curves and the second boundary.
SplitKnuckleLocations | Returns the collector containing the knuckle points that are to be used to create seams.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
UseNewDefaultSectionAlgorithm | Returns or sets the flag that indicates if the new default section algorithm is used.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreatePathCurves | Creates path curves for all the paths of the profile system.
CreatePlaneForList | Create a `NXOpen.Features.ShipDesign.PlaneListBuilder` to add a defined plane to a list.
DeleteLastPathCurves | Deletes the path curves returned from a call to `GetLastPathCurves()`.
DeletePathCurves | Deletes the path curves created from a call to `CreatePathCurves()`.
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.
GetLastPathCurves | Gets the path curves used by `NXOpen.Features.ShipDesign.OrientationDefinitionBuilder`.
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.
SetBoundaryOnePoints | Sets the selected intersection points for the first boundary.
SetBoundaryTwoPoints | Set the selected intersection points for the second boundary.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetRegionPoints | Sets the points that identify which regions of the curves will be used.
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

## Boundary1

`ProfileSystemBuilder.``Boundary1`

  Returns the collector containing the plate system, profile system, or datum plane that will be used to trim the first end of the generated profile system.

  Only one sheet body or one plane can be input.

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

  Getter Method

  Signature `Boundary1`

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

  New in version NX8.0.0.

  License requirements: None.

## Boundary1Plane

`ProfileSystemBuilder.``Boundary1Plane`

  Returns or sets the defined plane that will be used to trim the first end of the generated profile system.

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

  Getter Method

  Signature `Boundary1Plane`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Boundary1Plane`

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

  New in version NX8.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## Boundary2

`ProfileSystemBuilder.``Boundary2`

  Returns the collector containing the plate system, profile system, or datum plane that will be used to trim the second end of the generated profile system.

  Only one sheet body or one plane can be input.

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

  Getter Method

  Signature `Boundary2`

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

  New in version NX8.0.0.

  License requirements: None.

## Boundary2Plane

`ProfileSystemBuilder.``Boundary2Plane`

  Returns or sets the defined plane that will be used to trim the second end of the generated profile system.

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

  Getter Method

  Signature `Boundary2Plane`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Boundary2Plane`

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

  New in version NX8.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## BoundaryReverse

`ProfileSystemBuilder.``BoundaryReverse`

  Returns or sets the indication if the side of a single boundary should be changed to the other side or not.

  By default the side that is on the same side as the sheet body or plane normal is chosen.

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

  Getter Method

  Signature `BoundaryReverse`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BoundaryReverse`

  Parameters: | boundaryReverse (bool) –

  New in version NX8.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## FirstIntersectionPoints

`ProfileSystemBuilder.``FirstIntersectionPoints`

  Returns the selected intersection points between the curves and the first boundary.

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

  Getter Method

  Signature `FirstIntersectionPoints`

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

  New in version NX8.5.0.

  License requirements: None.

## ReversePathDirection

`ProfileSystemBuilder.``ReversePathDirection`

  Returns or sets the flag that indicates if the default curve direction should be reversed or not.

  By default curve’s direction is consistent with ship coordinate.

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

  Getter Method

  Signature `ReversePathDirection`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReversePathDirection`

  Parameters: | pathReverse (bool) –

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SecondIntersectionPoints

`ProfileSystemBuilder.``SecondIntersectionPoints`

  Returns the selected intersection points between the curves and the second boundary.

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

  Getter Method

  Signature `SecondIntersectionPoints`

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

  New in version NX8.5.0.

  License requirements: None.

## SplitKnuckleLocations

`ProfileSystemBuilder.``SplitKnuckleLocations`

  Returns the collector containing the knuckle points that are to be used to create seams.

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

  Getter Method

  Signature `SplitKnuckleLocations`

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

  New in version NX12.0.0.

  License requirements: None.

## UseNewDefaultSectionAlgorithm

`ProfileSystemBuilder.``UseNewDefaultSectionAlgorithm`

  Returns or sets the flag that indicates if the new default section algorithm is used.

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

  Getter Method

  Signature `UseNewDefaultSectionAlgorithm`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseNewDefaultSectionAlgorithm`

  Parameters: | useIt (bool) –

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

# Method Detail

## CreatePathCurves

`ProfileSystemBuilder.``CreatePathCurves`

  Creates path curves for all the paths of the profile system.

  Signature `CreatePathCurves()`

  Returns: | The curves defining all the paths of the profiles that are being created.
  Return type: | list of `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: None.

## DeleteLastPathCurves

`ProfileSystemBuilder.``DeleteLastPathCurves`

  Deletes the path curves returned from a call to `GetLastPathCurves()`.

  Signature `DeleteLastPathCurves()`

  New in version NX9.0.0.

  License requirements: None.

## DeletePathCurves

`ProfileSystemBuilder.``DeletePathCurves`

  Deletes the path curves created from a call to `CreatePathCurves()`.

  Signature `DeletePathCurves()`

  New in version NX9.0.0.

  License requirements: None.

## GetLastPathCurves

`ProfileSystemBuilder.``GetLastPathCurves`

  Gets the path curves used by `NXOpen.Features.ShipDesign.OrientationDefinitionBuilder`.

  Signature `GetLastPathCurves()`

  Returns: | The curves to be used for profile orientation.
  Return type: | list of `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: None.

## SetBoundaryOnePoints

`ProfileSystemBuilder.``SetBoundaryOnePoints`

  Sets the selected intersection points for the first boundary.

  Signature `SetBoundaryOnePoints(points)`

  Parameters: | points (list of `NXOpen.Point3d`) – The selected intersection points for boundary one.

  New in version NX8.5.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SetBoundaryTwoPoints

`ProfileSystemBuilder.``SetBoundaryTwoPoints`

  Set the selected intersection points for the second boundary.

  Signature `SetBoundaryTwoPoints(points)`

  Parameters: | points (list of `NXOpen.Point3d`) – The selected intersection points for boundary two.

  New in version NX8.5.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SetRegionPoints

`ProfileSystemBuilder.``SetRegionPoints`

  Sets the points that identify which regions of the curves will be used.

  Signature `SetRegionPoints(points)`

  Parameters: | points (list of `NXOpen.Point3d`) – The points that identify which regions of the curves are to be used.

  New in version NX11.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## Validate

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