PlateSystemBuilder Class

class NXOpen.Features.ShipDesign.PlateSystemBuilder

Bases: NXOpen.Features.ShipDesign.FeatureParmsBuilder

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

Currently this includes the following features: NXOpen.Features.ShipDesign.Deck, NXOpen.Features.ShipDesign.Hull, NXOpen.Features.ShipDesign.GenericPlateSystem, NXOpen.Features.ShipDesign.LongitudinalBulkhead, and NXOpen.Features.ShipDesign.TransverseBulkhead.

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

Default values.

Property	Value
Offset.Value	0 (millimeters part), 0 (inches part)
Primary	FwdPortToInUp
PrimaryOnReference	FwdPortToInUp
Secondary1	FwdPortToInUp
Secondary1OnReference	FwdPortToInUp
Secondary2	FwdPortToInUp
Secondary2OnReference	FwdPortToInUp
Stock.KnuckleRatio	3.0
Stock.KnuckleSmoothAngle	3.0
Stock.MaterialOption	0
Stock.OppositeThickness.Value	0 (millimeters part), 0 (inches part)
Stock.RestrictThicknessToMaterial	true
Stock.ThickenOption	SingleSided
Stock.Thickness.Value	10 (millimeters part), 0.5 (inches part)
Stock.ThicknessSourceOption	List
ThicknessDirection.ThicknessDirection	FwdPortInUp
ThicknessDirection.ThicknessDirectionOnReference	FwdPortInUp

New in version NX8.0.0.

Properties

Property	Description
AngleTolerance	Returns or sets the tolerance, in degrees, used to determine when angles are zero.
BoundaryPlane	Returns or sets the plane defined to indicate the boundary of the plate system.
BoundarySection	Returns the section containing curves that define the boundary of the plate system.
BoundarySheets	Returns the sheet bodies or datum planes selected, or a face collector used to define the boundary of the plate system.
DistanceTolerance	Returns or sets the tolerance used to determine when distances are considered zero.
Offset	Returns the offset to apply to the selected mold face to produce the desired mold face.
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
Primary	Returns or sets the primary stiffener direction.
PrimaryOnReference	Returns or sets the primary stiffener direction when the plate system is located on a midship reference.
ProjectionDirection	Returns the direction used to project the boundary section curves onto the mold face.
Regions	Returns the regions selected from the sheet, that has the inscribed boundaries, to keep for the final plate system shape.
Secondary1	Returns or sets the direction of the stiffener flange.
Secondary1OnReference	Returns or sets the direction of the stiffener flange when the stiffener is located on a midship reference.
Secondary2	Returns or sets the direction of the stiffener flange.
Secondary2OnReference	Returns or sets the direction of the stiffener flange when the stiffener is located on a midship reference.
ShipNames	Returns the Ship Names builder, used to assign names to the Plate Systems created.
SplitKnuckleEdges	Returns the split knuckle edges, which are used to create seam feature to split a plate system into plate subsystem.
Stock	Returns the plate stock builder, used to define the plate material, grade, thickness, mass density, and thicken option.
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
ThicknessDirection	Returns the thickness direction builder, used to specify the thickness direction from the mold face.
Tightness	Returns or sets the tightness desired for the plate system.
Weld	Returns the welding characteristics builder, used to assign welding characteristics to the outermost edges of a plate system.

Methods

Method	Description
CleanUpTemporaryCurves	Cleans up the temp curves.
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
CreatePlaneForList	Create a NXOpen.Features.ShipDesign.PlaneListBuilder to add a defined plane to a list.
CreateRegionBody	Create the region body that has the inscribed boundaries.
DeletePreviewBody	Deletes the preview body.
DeleteRegionBody	Delete the current region body.
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.
SetKnuckleEdges	Sets the knuckle edges, which includes edges for both bend and split types.
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
SetPreviewOption	Sets the preview option.
SetRegionIndex	Sets the region index.
SetRegionPoints	Set the points derived from the regions of the sheet, that has the inscribed boundaries, to keep for the final plate system shape.
SetSplitEdgeUpdateFlag	Sets the flag to indicate that split knuckle edges are out of date and need to update.
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

PlateSystemBuilderStiffenerDirectionType Enumeration

Settings used to indicate the default primary and secondary stiffener direction.

Property Detail

BoundaryPlane

PlateSystemBuilder.BoundaryPlane

Returns or sets the plane defined to indicate the boundary of the plate system.

The defined plane is intersected with the specified mold face to define regions. The regions desired to form the plate system can then be selected.

-------------------------------------

Getter Method

Signature BoundaryPlane

Returns: Return type:NXOpen.Plane

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BoundaryPlane

Parameters:boundaryPlane (NXOpen.Plane) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

BoundarySection

PlateSystemBuilder.BoundarySection

Returns the section containing curves that define the boundary of the plate system.

The curves will be projected onto the mold face to define regions. The regions desired to form the plate system can then be selected.

-------------------------------------

Getter Method

Signature BoundarySection

Returns: Return type:NXOpen.Section

New in version NX8.0.0.

License requirements: None.

BoundarySheets

PlateSystemBuilder.BoundarySheets

Returns the sheet bodies or datum planes selected, or a face collector used to define the boundary of the plate system.

The selected objects are intersected with the specified mold face to define regions. The regions desired to form the plate system can then be selected.

-------------------------------------

Getter Method

Signature BoundarySheets

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: None.

Offset

PlateSystemBuilder.Offset

Returns the offset to apply to the selected mold face to produce the desired mold face.

The offset is applied in the thickness direction specified.

-------------------------------------

Getter Method

Signature Offset

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Primary

PlateSystemBuilder.Primary

Returns or sets the primary stiffener direction.

This indicates which side of the plate system the stiffener should be placed upon.

-------------------------------------

Getter Method

Signature Primary

Returns: Return type:NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Primary

Parameters:primary (NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

PrimaryOnReference

PlateSystemBuilder.PrimaryOnReference

Returns or sets the primary stiffener direction when the plate system is located on a midship reference.

This indicates which side of the plate system the stiffener should be placed upon.

-------------------------------------

Getter Method

Signature PrimaryOnReference

Returns: Return type:NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PrimaryOnReference

Parameters:primaryOnReference (NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

ProjectionDirection

PlateSystemBuilder.ProjectionDirection

Returns the direction used to project the boundary section curves onto the mold face.

-------------------------------------

Getter Method

Signature ProjectionDirection

Returns: Return type:NXOpen.GeometricUtilities.ProjectionOptions

New in version NX8.0.0.

License requirements: None.

Regions

PlateSystemBuilder.Regions

Returns the regions selected from the sheet, that has the inscribed boundaries, to keep for the final plate system shape.

-------------------------------------

Getter Method

Signature Regions

Returns: Return type:NXOpen.RegionPointList

New in version NX8.0.0.

License requirements: None.

Secondary1

PlateSystemBuilder.Secondary1

Returns or sets the direction of the stiffener flange.

The usage and settings depends on the type of plate system the stiffener is being placed upon, and the general direction of the stiffener itself. When the stiffener has the possibility of two general directions, then the value of Secondary2 may also be utilized.

-------------------------------------

Getter Method

Signature Secondary1

Returns: Return type:NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Secondary1

Parameters:secondary1 (NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Secondary1OnReference

PlateSystemBuilder.Secondary1OnReference

Returns or sets the direction of the stiffener flange when the stiffener is located on a midship reference.

The usage and settings depends on the type of plate system the stiffener is being placed upon, and the general direction of the stiffener itself. When the stiffener has the possibility of two general directions, then the value of Secondary2 may also be utilized.

-------------------------------------

Getter Method

Signature Secondary1OnReference

Returns: Return type:NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Secondary1OnReference

Parameters:secondary1OnReference (NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Secondary2

PlateSystemBuilder.Secondary2

Returns or sets the direction of the stiffener flange.

The usage and settings depends on the type of plate system the stiffener is being placed upon, and the general direction of the stiffener itself. When the stiffener has the possibility of two general directions, then the value of Secondary1 may also be utilized.

-------------------------------------

Getter Method

Signature Secondary2

Returns: Return type:NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Secondary2

Parameters:secondary2 (NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Secondary2OnReference

PlateSystemBuilder.Secondary2OnReference

Returns or sets the direction of the stiffener flange when the stiffener is located on a midship reference.

The usage and settings depends on the type of plate system the stiffener is being placed upon, and the general direction of the stiffener itself. When the stiffener has the possibility of two general directions, then the value of Secondary1 may also be utilized.

-------------------------------------

Getter Method

Signature Secondary2OnReference

Returns: Return type:NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Secondary2OnReference

Parameters:secondary2OnReference (NXOpen.Features.ShipDesign.PlateSystemBuilderStiffenerDirectionType) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

ShipNames

PlateSystemBuilder.ShipNames

Returns the Ship Names builder, used to assign names to the Plate Systems created.

-------------------------------------

Getter Method

Signature ShipNames

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

New in version NX9.0.2.

License requirements: None.

SplitKnuckleEdges

PlateSystemBuilder.SplitKnuckleEdges

Returns the split knuckle edges, which are used to create seam feature to split a plate system into plate subsystem.

-------------------------------------

Getter Method

Signature SplitKnuckleEdges

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Stock

PlateSystemBuilder.Stock

Returns the plate stock builder, used to define the plate material, grade, thickness, mass density, and thicken option.

-------------------------------------

Getter Method

Signature Stock

Returns:Plate Stock Builder Return type:NXOpen.Features.ShipDesign.PlateStockBuilder

New in version NX8.0.0.

License requirements: None.

ThicknessDirection

PlateSystemBuilder.ThicknessDirection

Returns the thickness direction builder, used to specify the thickness direction from the mold face.

-------------------------------------

Getter Method

Signature ThicknessDirection

Returns:Thickness Direction Builder Return type:NXOpen.Features.ShipDesign.ThicknessDirectionBuilder

New in version NX8.0.0.

License requirements: None.

Tightness

PlateSystemBuilder.Tightness

Returns or sets the tightness desired for the plate system.

-------------------------------------

Getter Method

Signature Tightness

Returns: Return type:int

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Tightness

Parameters:tightness (int) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Weld

PlateSystemBuilder.Weld

Returns the welding characteristics builder, used to assign welding characteristics to the outermost edges of a plate system.

-------------------------------------

Getter Method

Signature Weld

Returns: Return type:NXOpen.Weld.CharacteristicsBuilder

New in version NX8.0.0.

License requirements: None.

Method Detail

CleanUpTemporaryCurves

PlateSystemBuilder.CleanUpTemporaryCurves

Cleans up the temp curves.

Signature CleanUpTemporaryCurves()

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

CreateRegionBody

PlateSystemBuilder.CreateRegionBody

Create the region body that has the inscribed boundaries.

The region body is used to select the regions that are kept for the final plate system shape. Any region body created should be deleted by using the method NXOpen.Features.ShipDesign.PlateSystemBuilder.DeleteRegionBody(). If a region body is created when there is already a current region body, that current region body will be deleted. When the builder is committed, the region point coordinates from method NXOpen.Features.ShipDesign.PlateSystemBuilder.SetRegionPoints() will be used to identify the regions desired.

Signature CreateRegionBody()

Returns:Body associated with the select region point. Return type:NXOpen.Body

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

DeletePreviewBody

PlateSystemBuilder.DeletePreviewBody

Deletes the preview body.

Signature DeletePreviewBody(bDelete)

Parameters:bDelete (bool) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

DeleteRegionBody

PlateSystemBuilder.DeleteRegionBody

Delete the current region body.

Signature DeleteRegionBody()

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

SetKnuckleEdges

PlateSystemBuilder.SetKnuckleEdges

Sets the knuckle edges, which includes edges for both bend and split types.

Signature SetKnuckleEdges(knuckleEdges)

Parameters:knuckleEdges (list of NXOpen.TaggedObject) – G0 edges or camber curves with special attribute

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

SetPreviewOption

PlateSystemBuilder.SetPreviewOption

Sets the preview option.

Signature SetPreviewOption(bPreview)

Parameters:bPreview (bool) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

SetRegionIndex

PlateSystemBuilder.SetRegionIndex

Sets the region index.

Signature SetRegionIndex(indexArray)

Parameters:indexArray (list of int) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

SetRegionPoints

PlateSystemBuilder.SetRegionPoints

Set the points derived from the regions of the sheet, that has the inscribed boundaries, to keep for the final plate system shape.

Signature SetRegionPoints(regionPoints)

Parameters:regionPoints (list of NXOpen.Point3d) – Points representing the kept regions.

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

SetSplitEdgeUpdateFlag

PlateSystemBuilder.SetSplitEdgeUpdateFlag

Sets the flag to indicate that split knuckle edges are out of date and need to update.

Signature SetSplitEdgeUpdateFlag(isSplitEdgeUpdate)

Parameters:isSplitEdgeUpdate (bool) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Validate

PlateSystemBuilder.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.