PillarSystemBuilder Class

class NXOpen.Features.ShipDesign.PillarSystemBuilder

Bases: NXOpen.Features.ShipDesign.ProfileSystemBuilder

Represents a NXOpen.Features.ShipDesign.PillarSystem builder which is used to create or edit a pillar system feature.

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

Default values.

Property	Value
OrientationAngle.Value	0
SectionType	Profile

New in version NX8.0.0.

Properties

Property	Description
AnchorPoint	Returns or sets the anchor point.
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.
BuildSolid	Returns or sets the indication of whether to build a solid for the pillar system or just the curve.
BuiltUpStock	Returns the stock used to build the builtUp from.
Direction	Returns or sets the direction of the pillar.
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.
IntersectingShipStructure	Returns the ship structure to intersect with each other that defines the start of a pillar.
LimitingShipStructure	Returns the ship sructure that defines the end of the pillar.
OrientationAngle	Returns the angle at which to orient the stock shape.
OrientationAngleRule	Returns or sets the angle rule to use when measuring angles.
OrientationLine	Returns the orientation line, used only if the creation method is Specify Line.
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
PointPairList	Returns the list of pairs of points that define the ends of the pillars.
ReverseOrientationDirection	Returns or sets the reverse orientation direction
ReversePathDirection	Returns or sets the flag that indicates if the default curve direction should be reversed or not.
ReverseReferenceDirection	Returns or sets the reverse reference direction
SecondIntersectionPoints	Returns the selected intersection points between the curves and the second boundary.
SectionType	Returns or sets the section type (profile or plate)
ShipNames	Returns the Ship Names builder, used to assign names to the Pillar Systems created.
SplitKnuckleLocations	Returns the collector containing the knuckle points that are to be used to create seams.
StockData	Returns the stock data used to define the stock information of the stiffener.
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
Type	Returns or sets the type of input used to define the pillar location.
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.
CreatePointPairBuilder	Creates a NXOpen.Features.ShipDesign.PointPairBuilder.
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.
GetAvailableAnchorPointNames	The list of available anchor points
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.
PopulateAnchorPointList	Update anchor points
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.

Enumerations

PillarSystemBuilderStockSectionType Enumeration	SpreadSheet Type Profile or BuiltUp
PillarSystemBuilderTypes Enumeration	Used to specify how the pillar system is defined.

Property Detail

AnchorPoint

PillarSystemBuilder.AnchorPoint

Returns or sets the anchor point.

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

Getter Method

Signature AnchorPoint

Returns: Return type:int

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature AnchorPoint

Parameters:anchorPoint (int) –

New in version NX9.0.3.

License requirements: nx_ship_basic (“Ship Basic Design”)

BuildSolid

PillarSystemBuilder.BuildSolid

Returns or sets the indication of whether to build a solid for the pillar system or just the curve.

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

Getter Method

Signature BuildSolid

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature BuildSolid

Parameters:buildSolid (bool) –

New in version NX11.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

BuiltUpStock

PillarSystemBuilder.BuiltUpStock

Returns the stock used to build the builtUp from.

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

Getter Method

Signature BuiltUpStock

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

New in version NX9.0.0.

License requirements: None.

Direction

PillarSystemBuilder.Direction

Returns or sets the direction of the pillar.

Only used when Type is Features.ShipDesign.PillarSystemBuilder.Types.ShipStructure.

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

Getter Method

Signature Direction

Returns: Return type:NXOpen.Direction

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Direction

Parameters:direction (NXOpen.Direction) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

IntersectingShipStructure

PillarSystemBuilder.IntersectingShipStructure

Returns the ship structure to intersect with each other that defines the start of a pillar.

Only used when Type is Features.ShipDesign.PillarSystemBuilder.Types.ShipStructure.

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

Getter Method

Signature IntersectingShipStructure

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: None.

LimitingShipStructure

PillarSystemBuilder.LimitingShipStructure

Returns the ship sructure that defines the end of the pillar.

Only used when Type is Features.ShipDesign.PillarSystemBuilder.Types.ShipStructure.

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

Getter Method

Signature LimitingShipStructure

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: None.

OrientationAngle

PillarSystemBuilder.OrientationAngle

Returns the angle at which to orient the stock shape.

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

Getter Method

Signature OrientationAngle

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

OrientationLine

PillarSystemBuilder.OrientationLine

Returns the orientation line, used only if the creation method is “Specify Line”.

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

Getter Method

Signature OrientationLine

Returns: Return type:NXOpen.SelectTaggedObject

New in version NX8.5.0.

License requirements: None.

PointPairList

PillarSystemBuilder.PointPairList

Returns the list of pairs of points that define the ends of the pillars.

Only used when Type is Features.ShipDesign.PillarSystemBuilder.Types.Points.

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

Getter Method

Signature PointPairList

Returns: Return type:NXOpen.NXObjectList

New in version NX8.0.0.

License requirements: None.

ReverseOrientationDirection

PillarSystemBuilder.ReverseOrientationDirection

Returns or sets the reverse orientation direction

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

Getter Method

Signature ReverseOrientationDirection

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ReverseOrientationDirection

Parameters:reverseOrientationDirection (bool) –

New in version NX10.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

ReverseReferenceDirection

PillarSystemBuilder.ReverseReferenceDirection

Returns or sets the reverse reference direction

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

Getter Method

Signature ReverseReferenceDirection

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ReverseReferenceDirection

Parameters:reverseReferenceDirection (bool) –

New in version NX10.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

SectionType

PillarSystemBuilder.SectionType

Returns or sets the section type (profile or plate)

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

Getter Method

Signature SectionType

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

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SectionType

Parameters:sectionType (NXOpen.Features.ShipDesign.PillarSystemBuilderStockSectionType) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

ShipNames

PillarSystemBuilder.ShipNames

Returns the Ship Names builder, used to assign names to the Pillar 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.

StockData

PillarSystemBuilder.StockData

Returns the stock data used to define the stock information of the stiffener.

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

Getter Method

Signature StockData

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

New in version NX8.0.0.

License requirements: None.

Type

PillarSystemBuilder.Type

Returns or sets the type of input used to define the pillar location.

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

Getter Method

Signature Type

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

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Features.ShipDesign.PillarSystemBuilderTypes) –

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

Method Detail

CreatePointPairBuilder

PillarSystemBuilder.CreatePointPairBuilder

Creates a NXOpen.Features.ShipDesign.PointPairBuilder.

Signature CreatePointPairBuilder()

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

New in version NX8.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”)

GetAvailableAnchorPointNames

PillarSystemBuilder.GetAvailableAnchorPointNames

The list of available anchor points

Signature GetAvailableAnchorPointNames()

Returns:Array of available anchor point names.

These names are read from the current reuse sketch :rtype: list of str

New in version NX9.0.3.

License requirements: None.

PopulateAnchorPointList

PillarSystemBuilder.PopulateAnchorPointList

Update anchor points

Signature PopulateAnchorPointList()

New in version NX9.0.3.

License requirements: None.

Validate

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