StandardPartItemBuilder Class

class NXOpen.Features.ShipDesign.StandardPartItemBuilder

Bases: NXOpen.Builder

Represents the ship standard part item builder.

This class cannot be directly instantiated and has to be created by CreateStandardPartItem.

New in version NX8.0.0.

Properties

Property Description
FifthObject Returns the fifth selected object.
FirstAdoptionCurve Returns the first adoption curve.
FirstChainInstallDirection Returns or sets the flag to indicate whether to flip the direction of the first selected chain object or not.
FirstChainObject Returns the first chain selected object.
FirstObject Returns the first selected object.
FirstPlane Returns the first selected plane.
FourthObject Returns the fourth selected object.
InstallFifthDirection Returns or sets the flag to indicate whether to flip the direction of the fifth selected object or not.
InstallFirstDirection Returns or sets the flag to indicate whether to flip the direction of the first selected object or not.
InstallFourthDirection Returns or sets the flag to indicate whether to flip the direction of the fourth selected object or not.
InstallSecondDirection Returns or sets the flag to indicate whether to flip the direction of the second selected object or not.
InstallThirdDirection Returns or sets the flag to indicate whether to flip the direction of the third selected object or not.
SecondAdoptionCurve Returns the second adoption curve.
SecondChainInstallDirection Returns or sets the flag to indicate whether to flip the direction of the second selected chain object or not.
SecondChainObject Returns the second chain selected object.
SecondObject Returns the second selected object.
SecondPlane Returns the second selected plane.
Tag Returns the Tag for this object.
ThirdObject Returns the third selected object.

Methods

Method Description
AddAcrossObject Adds the specific object to the across object list.
AddDeselectedAcrossObject Adds the specific object to the deselected across object list.
CheckScallopSize Checks the scallop size by enabling the predefined requirement check inside the standard part, and resets to original state afterwards.
Commit Commits any edits that have been applied to the builder.
ConvertReferenceGeometry Converts the selected reference geometry.
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.
GetObject Returns the object currently being edited by this builder.
LookupRegistration Checks the registration context string when an object is selected.
RemoveAcrossObject Removes the specific object from the across object list.
RemoveDeselectedAcrossObject Removes the specific object from the deselected across object list.
ResetItem Resets the standard part item builder to its intial state.
SetOptionalGeometry Sets one geometry for input selection which has multiple options.
SetTransitionGeometry Sets the transition geometry given the index.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateReferences Updates and relinks the external references.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

StandardPartItemBuilderDirection Enumeration Represents the ship standard part installation direction and thickness direction.

Property Detail

FifthObject

StandardPartItemBuilder.FifthObject

Returns the fifth selected object.

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

Getter Method

Signature FifthObject

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

FirstAdoptionCurve

StandardPartItemBuilder.FirstAdoptionCurve

Returns the first adoption curve.

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

Getter Method

Signature FirstAdoptionCurve

Returns:
Return type:NXOpen.ScCollector

New in version NX9.0.2.

License requirements: None.

FirstChainInstallDirection

StandardPartItemBuilder.FirstChainInstallDirection

Returns or sets the flag to indicate whether to flip the direction of the first selected chain object or not.

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

Getter Method

Signature FirstChainInstallDirection

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

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature FirstChainInstallDirection

Parameters:firstChainInstallDirection (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX9.0.0.

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

FirstChainObject

StandardPartItemBuilder.FirstChainObject

Returns the first chain selected object.

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

Getter Method

Signature FirstChainObject

Returns:
Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

FirstObject

StandardPartItemBuilder.FirstObject

Returns the first selected object.

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

Getter Method

Signature FirstObject

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

FirstPlane

StandardPartItemBuilder.FirstPlane

Returns the first selected plane.

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

Getter Method

Signature FirstPlane

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

FourthObject

StandardPartItemBuilder.FourthObject

Returns the fourth selected object.

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

Getter Method

Signature FourthObject

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

InstallFifthDirection

StandardPartItemBuilder.InstallFifthDirection

Returns or sets the flag to indicate whether to flip the direction of the fifth selected object or not.

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

Getter Method

Signature InstallFifthDirection

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature InstallFifthDirection

Parameters:fifthDirectionInstall (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX8.5.0.

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

InstallFirstDirection

StandardPartItemBuilder.InstallFirstDirection

Returns or sets the flag to indicate whether to flip the direction of the first selected object or not.

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

Getter Method

Signature InstallFirstDirection

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature InstallFirstDirection

Parameters:firstDirectionInstall (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX8.5.0.

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

InstallFourthDirection

StandardPartItemBuilder.InstallFourthDirection

Returns or sets the flag to indicate whether to flip the direction of the fourth selected object or not.

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

Getter Method

Signature InstallFourthDirection

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature InstallFourthDirection

Parameters:fourthDirectionInstall (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX8.5.0.

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

InstallSecondDirection

StandardPartItemBuilder.InstallSecondDirection

Returns or sets the flag to indicate whether to flip the direction of the second selected object or not.

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

Getter Method

Signature InstallSecondDirection

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature InstallSecondDirection

Parameters:secondDirectionInstall (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX8.5.0.

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

InstallThirdDirection

StandardPartItemBuilder.InstallThirdDirection

Returns or sets the flag to indicate whether to flip the direction of the third selected object or not.

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

Getter Method

Signature InstallThirdDirection

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature InstallThirdDirection

Parameters:thirdDirectionInstall (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX8.5.0.

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

SecondAdoptionCurve

StandardPartItemBuilder.SecondAdoptionCurve

Returns the second adoption curve.

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

Getter Method

Signature SecondAdoptionCurve

Returns:
Return type:NXOpen.ScCollector

New in version NX9.0.2.

License requirements: None.

SecondChainInstallDirection

StandardPartItemBuilder.SecondChainInstallDirection

Returns or sets the flag to indicate whether to flip the direction of the second selected chain object or not.

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

Getter Method

Signature SecondChainInstallDirection

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

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SecondChainInstallDirection

Parameters:secondChainInstallDirection (NXOpen.Features.ShipDesign.StandardPartItemBuilderDirection) –

New in version NX9.0.0.

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

SecondChainObject

StandardPartItemBuilder.SecondChainObject

Returns the second chain selected object.

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

Getter Method

Signature SecondChainObject

Returns:
Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

SecondObject

StandardPartItemBuilder.SecondObject

Returns the second selected object.

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

Getter Method

Signature SecondObject

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

SecondPlane

StandardPartItemBuilder.SecondPlane

Returns the second selected plane.

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

Getter Method

Signature SecondPlane

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

ThirdObject

StandardPartItemBuilder.ThirdObject

Returns the third selected object.

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

Getter Method

Signature ThirdObject

Returns:
Return type:NXOpen.SelectDisplayableObject

New in version NX8.0.0.

License requirements: None.

Method Detail

AddAcrossObject

StandardPartItemBuilder.AddAcrossObject

Adds the specific object to the across object list.

Signature AddAcrossObject(acrossObject)

Parameters:acrossObject (NXOpen.DisplayableObject) – body, face or curve entity.

New in version NX9.0.0.

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

AddDeselectedAcrossObject

StandardPartItemBuilder.AddDeselectedAcrossObject

Adds the specific object to the deselected across object list.

Signature AddDeselectedAcrossObject(acrossObject)

Parameters:acrossObject (NXOpen.DisplayableObject) – body, face or curve.

New in version NX9.0.0.

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

CheckScallopSize

StandardPartItemBuilder.CheckScallopSize

Checks the scallop size by enabling the predefined requirement check inside the standard part, and resets to original state afterwards.

If there is no vialation of the requirement, nothing will happen.

Signature CheckScallopSize()

Returns:
Return type:bool

New in version NX8.0.0.

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

ConvertReferenceGeometry

StandardPartItemBuilder.ConvertReferenceGeometry

Converts the selected reference geometry.

For instance stiffener curve, which represents stiffener body, into an equivalent reference geometry such as molding face, opposing molding face, top face.

Signature ConvertReferenceGeometry(index, selObj)

Parameters:

New in version NX9.0.0.

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

LookupRegistration

StandardPartItemBuilder.LookupRegistration

Checks the registration context string when an object is selected.

Signature LookupRegistration()

Returns:
Return type:str

New in version NX8.0.0.

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

RemoveAcrossObject

StandardPartItemBuilder.RemoveAcrossObject

Removes the specific object from the across object list.

Signature RemoveAcrossObject(acrossObject)

Parameters:acrossObject (NXOpen.DisplayableObject) – body, face or curve.

New in version NX9.0.0.

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

RemoveDeselectedAcrossObject

StandardPartItemBuilder.RemoveDeselectedAcrossObject

Removes the specific object from the deselected across object list.

Signature RemoveDeselectedAcrossObject(acrossObject)

Parameters:acrossObject (NXOpen.DisplayableObject) – body, face or curve.

New in version NX9.0.0.

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

ResetItem

StandardPartItemBuilder.ResetItem

Resets the standard part item builder to its intial state.

Signature ResetItem()

New in version NX8.5.0.

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

SetOptionalGeometry

StandardPartItemBuilder.SetOptionalGeometry

Sets one geometry for input selection which has multiple options.

Multiple options could come from selection configuration setting, or several geometries with the same attributes.

Signature SetOptionalGeometry(selectedGeometry)

Parameters:selectedGeometry (NXOpen.DisplayableObject) –

New in version NX8.0.0.

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

SetTransitionGeometry

StandardPartItemBuilder.SetTransitionGeometry

Sets the transition geometry given the index.

Signature SetTransitionGeometry(index, transitionGeometry)

Parameters:

New in version NX8.5.0.

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

UpdateReferences

StandardPartItemBuilder.UpdateReferences

Updates and relinks the external references.

bToUpdateGeometry is used to decide if the input geometries need to be recalculated.

Signature UpdateReferences(bToUpdateGeometry)

Parameters:bToUpdateGeometry (bool) –

New in version NX8.0.0.

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

Validate

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