StandardPartFrameworkBuilder Class¶

class NXOpen.Features.ShipDesign.StandardPartFrameworkBuilder¶

Bases: NXOpen.Builder

Represents the standard part framework builder to add or edit ship standard part.

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

Default values.

Property	Value
Thickness.Value (deprecated)	5 (millimeters part), 0.02 (inches part)

New in version NX8.0.0.

Properties¶

Property	Description
ConfigAttribute	Returns or sets the configure attribute, which is read from the design environment by the settings in the configuration XML file.
FirstCompartment	Returns or sets the first compartment option.
ManufacturingStock	Returns the manufacturing stock builder that holds the manufacturing data.
PartCategory	Returns or sets the part category, which is defined in registration file.
PartCreationType	Returns or sets the creation type.
PartSubType	Returns or sets the part sub type, which is the sub category of sub type.
PartType	Returns or sets the part type, which is the sub category of part type.
ReverseDirection	Returns or sets the option whether to reverse direction.
SecondCompartment	Returns or sets the second compartment option.
ShipNames	Returns the Ship Names builder, used to assign names to the Standard Parts created.
StandardPartGroupOption	Returns or sets the option whether to group multiple standard parts together to share the same parameters during the update when editing.
StandardPartItem	Returns the standard part item, which is the builder of the selection item.
StandardPartList	Returns the standard part list, which supports to add more than one standard part at one time.
Tag	Returns the Tag for this object.
Thickness	Returns the standard part thickness.
ThicknessDirection	Returns or sets the option whether to change thickness direction.
WeldCharacteristics	Returns the weld characteristics.

Methods¶

Method	Description
AddStandardPart	Adds a standard part into the assembly context, restores the broken wave links and renames the standard part when all external references are defined.
ApplySmartRuleResult	Applies the smart rule results to the spreadsheet data block.
CheckInterference	Checks the clearance between the standard parts and the other components in current assembly.
CheckSpreadsheetInput	Looks for the parameter values that are owned by reference geometeries(Attributes) and/or template parts(attributes or expressions) and used as inputs to look for the parameter values in spreadsheet.
Commit	Commits any edits that have been applied to the builder.
CopyFromWeldCharacteristics	Copies the weld characteristics from the specific standard part item builder.
CopyToWeldCharacteristics	Copies the weld characteristics to the specific standard part item builder.
CreateStandardPartItem	Creates a new StandardPartItemBuilder and intialize the builder with data from the reference builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
EndRunSmartRule	End run the smart rules.
FlipThicknessDirection	Flips the standard part thickness direction.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetDataFile	Retrieves the data file name from the registration spread sheet.
GetModelFile	Retrieves the model file name from the registration spread sheet.
GetObject	Returns the object currently being edited by this builder.
GetStandardPartName	Returns the default name of the added standard part name
ModifySpreadsheetData	Modifies specific parameter values without change parameter statuses.
PostUpdate	Does the final check to finish the process of updating standar parts.
RemoveInstance	Removes the standard part instance.
ResetPartIndex	Resets the standard part index so that the next standard part would be added with the index in its name starting from 1.
ResetRuleInputCache	Resets rule trigger source cache so the rule trigger evaluation can start from original point.
RunSmartRule	Runs the smart rule engine to get the inference result.
SetCurrentStandardPartItem	Sets the current standard part item that is edited.
SetStandardPartVersion	Set the standard part version.
SetView	Sets the current view normal to the main plane, which is the base plane to construct the primary sketch in the template part.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateModel	Updates all standard parts
UpdateShipNames	Update Ship Names builder when change part category.
UpdateSpreadsheetData	Updates the parameter values which are defined in the parameter spreadsheet.
UpdateSpreadsheetDataNoUpdate	Updates the parameter values which are defined in the parameter spreadsheet but not update the standard parts.
UpdateThickness	Updates the user input thickness to the standard parts.
UpdateThicknessDirection	Updates the standard part thickness direction.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

StandardPartFrameworkBuilderCreationType Enumeration	Indicates the creation type
StandardPartFrameworkBuilderSmartRuleStage Enumeration	Indicates the stage of the smart rule.

Property Detail¶

ConfigAttribute¶

StandardPartFrameworkBuilder.ConfigAttribute¶

Returns or sets the configure attribute, which is read from the design environment by the settings in the configuration XML file.

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

Getter Method

Signature ConfigAttribute

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ConfigAttribute

Parameters:	strConfigAttr (str) –

New in version NX8.0.0.

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

FirstCompartment¶

StandardPartFrameworkBuilder.FirstCompartment¶

Returns or sets the first compartment option.

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

Getter Method

Signature FirstCompartment

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature FirstCompartment

Parameters:	firstOption (str) –

New in version NX8.0.0.

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

ManufacturingStock¶

StandardPartFrameworkBuilder.ManufacturingStock¶

Returns the manufacturing stock builder that holds the manufacturing data.

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

Getter Method

Signature ManufacturingStock

Returns:
Return type:	`NXOpen.Features.ShipDesign.ManufacturingStockBuilder`

New in version NX8.5.0.

License requirements: None.

PartCategory¶

StandardPartFrameworkBuilder.PartCategory¶

Returns or sets the part category, which is defined in registration file.

The typical standard part types include stiffener end bracket, collar plate, tripping bracket, flat bar etc.

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

Getter Method

Signature PartCategory

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature PartCategory

Parameters:	partType (str) –

New in version NX8.0.0.

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

PartCreationType¶

StandardPartFrameworkBuilder.PartCreationType¶

Returns or sets the creation type.

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

Getter Method

Signature PartCreationType

Returns:
Return type:	`NXOpen.Features.ShipDesign.StandardPartFrameworkBuilderCreationType`

New in version NX9.0.2.

License requirements: None.

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

Setter Method

Signature PartCreationType

Parameters:	creationType (`NXOpen.Features.ShipDesign.StandardPartFrameworkBuilderCreationType`) –

New in version NX9.0.2.

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

PartSubType¶

StandardPartFrameworkBuilder.PartSubType¶

Returns or sets the part sub type, which is the sub category of sub type.

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

Getter Method

Signature PartSubType

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature PartSubType

Parameters:	partLeafType (str) –

New in version NX8.0.0.

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

PartType¶

StandardPartFrameworkBuilder.PartType¶

Returns or sets the part type, which is the sub category of part type.

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

Getter Method

Signature PartType

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature PartType

Parameters:	partSubType (str) –

New in version NX8.0.0.

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

ReverseDirection¶

StandardPartFrameworkBuilder.ReverseDirection¶

Returns or sets the option whether to reverse direction.

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

Getter Method

Signature ReverseDirection

Returns:
Return type:	bool

New in version NX8.0.0.

Deprecated since version NX8.0.3: Removed with no replacement

License requirements: None.

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

Setter Method

Signature ReverseDirection

Parameters:	reverseDirectionOption (bool) –

New in version NX8.0.0.

Deprecated since version NX8.0.3: Use NXOpen.Features.ShipDesign.StandardPartFrameworkBuilder.ModifySpreadSheetData() instead.

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

SecondCompartment¶

StandardPartFrameworkBuilder.SecondCompartment¶

Returns or sets the second compartment option.

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

Getter Method

Signature SecondCompartment

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SecondCompartment

Parameters:	secondOption (str) –

New in version NX8.0.0.

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

ShipNames¶

StandardPartFrameworkBuilder.ShipNames¶

Returns the Ship Names builder, used to assign names to the Standard Parts created.

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

Getter Method

Signature ShipNames

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

New in version NX9.0.2.

License requirements: None.

StandardPartGroupOption¶

StandardPartFrameworkBuilder.StandardPartGroupOption¶

Returns or sets the option whether to group multiple standard parts together to share the same parameters during the update when editing.

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

Getter Method

Signature StandardPartGroupOption

Returns:
Return type:	bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature StandardPartGroupOption

Parameters:	stdPartGroupOption (bool) –

New in version NX8.0.0.

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

StandardPartItem¶

StandardPartFrameworkBuilder.StandardPartItem¶

Returns the standard part item, which is the builder of the selection item.

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

Getter Method

Signature StandardPartItem

Returns:
Return type:	`NXOpen.Features.ShipDesign.StandardPartItemBuilder`

New in version NX8.0.0.

License requirements: None.

StandardPartList¶

StandardPartFrameworkBuilder.StandardPartList¶

Returns the standard part list, which supports to add more than one standard part at one time.

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

Getter Method

Signature StandardPartList

Returns:
Return type:	`NXOpen.Features.ShipDesign.StandardPartItemBuilderList`

New in version NX8.0.0.

License requirements: None.

Thickness¶

StandardPartFrameworkBuilder.Thickness¶

Returns the standard part thickness.

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

Getter Method

Signature Thickness

Returns:
Return type:	`NXOpen.Expression`

New in version NX8.0.0.

Deprecated since version NX8.0.3: Removed with no replacement

License requirements: None.

ThicknessDirection¶

StandardPartFrameworkBuilder.ThicknessDirection¶

Returns or sets the option whether to change thickness direction.

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

Getter Method

Signature ThicknessDirection

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ThicknessDirection

Parameters:	thicknessDirectionOption (`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”)

WeldCharacteristics¶

StandardPartFrameworkBuilder.WeldCharacteristics¶

Returns the weld characteristics.

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

Getter Method

Signature WeldCharacteristics

Returns:
Return type:	`NXOpen.Weld.CharacteristicsBuilder`

New in version NX8.0.0.

License requirements: None.

Method Detail¶

AddStandardPart¶

StandardPartFrameworkBuilder.AddStandardPart¶

Adds a standard part into the assembly context, restores the broken wave links and renames the standard part when all external references are defined.

Signature AddStandardPart()

New in version NX8.0.0.

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

ApplySmartRuleResult¶

StandardPartFrameworkBuilder.ApplySmartRuleResult¶

Applies the smart rule results to the spreadsheet data block.

Signature ApplySmartRuleResult(pStrParamName, pStrParamValue)

Parameters:	pStrParamName (list of str) – pStrParamValue (list of str) –

New in version NX8.0.0.

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

CheckInterference¶

StandardPartFrameworkBuilder.CheckInterference¶

Checks the clearance between the standard parts and the other components in current assembly.

There are two types of interference to be checked. 1) Interference between standard part and other componenets, and 2) interference between standard part and cutouts.

Signature CheckInterference()

New in version NX8.0.0.

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

CheckSpreadsheetInput¶

StandardPartFrameworkBuilder.CheckSpreadsheetInput¶

Looks for the parameter values that are owned by reference geometeries(Attributes) and/or template parts(attributes or expressions) and used as inputs to look for the parameter values in spreadsheet.

Signature CheckSpreadsheetInput(pItemBuilder)

Parameters:	pItemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –
Returns:	a tuple
Return type:	A tuple consisting of (ppStrParamName, ppStrParamValue) ppStrParamName is a list of str. ppStrParamValue is a list of str.

New in version NX8.0.0.

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

CopyFromWeldCharacteristics¶

StandardPartFrameworkBuilder.CopyFromWeldCharacteristics¶

Copies the weld characteristics from the specific standard part item builder.

Signature CopyFromWeldCharacteristics(stdPartItemBuilder)

Parameters:	stdPartItemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –

New in version NX9.0.1.

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

CopyToWeldCharacteristics¶

StandardPartFrameworkBuilder.CopyToWeldCharacteristics¶

Copies the weld characteristics to the specific standard part item builder.

Signature CopyToWeldCharacteristics(stdPartItemBuilder)

Parameters:	stdPartItemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –

New in version NX9.0.1.

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

CreateStandardPartItem¶

StandardPartFrameworkBuilder.CreateStandardPartItem¶

Creates a new StandardPartItemBuilder and intialize the builder with data from the reference builder.

Signature CreateStandardPartItem(refBuilder)

Parameters:	refBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –
Returns:
Return type:	`NXOpen.Features.ShipDesign.StandardPartItemBuilder`

New in version NX8.0.0.

License requirements: None.

EndRunSmartRule¶

StandardPartFrameworkBuilder.EndRunSmartRule¶

End run the smart rules.

Signature EndRunSmartRule(pItemBuilder)

Parameters:	pItemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –

New in version NX8.0.0.

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

FlipThicknessDirection¶

StandardPartFrameworkBuilder.FlipThicknessDirection¶

Flips the standard part thickness direction.

If bUpdateModel is true, the model will be updated. If it is false, the thickness direction will be flipped but the model will not be updated.

Signature FlipThicknessDirection(bUpdateModel)

Parameters:	bUpdateModel (bool) –

New in version NX8.0.0.

Deprecated since version NX8.0.3: Use NXOpen.Features.ShipDesign.StandardPartFrameworkBuilder.ModifySpreadSheetData() instead.

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

GetDataFile¶

StandardPartFrameworkBuilder.GetDataFile¶

Retrieves the data file name from the registration spread sheet.

Signature GetDataFile(updateConfiguration)

Parameters:	updateConfiguration (bool) – Whether to update the selection configuration

New in version NX8.0.0.

License requirements: None.

GetModelFile¶

StandardPartFrameworkBuilder.GetModelFile¶

Retrieves the model file name from the registration spread sheet.

Signature GetModelFile()

Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

GetStandardPartName¶

StandardPartFrameworkBuilder.GetStandardPartName¶

Returns the default name of the added standard part name

Signature GetStandardPartName(bFullName)

Parameters:	bFullName (bool) –
Returns:
Return type:	str

New in version NX8.0.0.

License requirements: None.

ModifySpreadsheetData¶

StandardPartFrameworkBuilder.ModifySpreadsheetData¶

Modifies specific parameter values without change parameter statuses.

This could be used to apply smart rule result.

Signature ModifySpreadsheetData(strParamName, strParamValue)

Parameters:	strParamName (list of str) – strParamValue (list of str) –

New in version NX8.0.0.

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

PostUpdate¶

StandardPartFrameworkBuilder.PostUpdate¶

Does the final check to finish the process of updating standar parts.

Signature PostUpdate()

New in version NX8.0.0.

License requirements: None.

RemoveInstance¶

StandardPartFrameworkBuilder.RemoveInstance¶

Removes the standard part instance.

Signature RemoveInstance(itemBuilder)

Parameters:	itemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –

New in version NX8.0.0.

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

ResetPartIndex¶

StandardPartFrameworkBuilder.ResetPartIndex¶

Resets the standard part index so that the next standard part would be added with the index in its name starting from 1.

Signature ResetPartIndex()

New in version NX8.5.0.

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

ResetRuleInputCache¶

StandardPartFrameworkBuilder.ResetRuleInputCache¶

Resets rule trigger source cache so the rule trigger evaluation can start from original point.

Signature ResetRuleInputCache()

New in version NX8.0.0.

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

RunSmartRule¶

StandardPartFrameworkBuilder.RunSmartRule¶

Runs the smart rule engine to get the inference result.

Signature RunSmartRule(pItemBuilder, stage)

Parameters:	pItemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) – stage (`NXOpen.Features.ShipDesign.StandardPartFrameworkBuilderSmartRuleStage`) –
Returns:	a tuple
Return type:	A tuple consisting of (ppStrParamName, ppStrParamValue, ppStrParamDescription) ppStrParamName is a list of str. ppStrParamValue is a list of str. ppStrParamDescription is a list of str.

New in version NX8.0.0.

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

SetCurrentStandardPartItem¶

StandardPartFrameworkBuilder.SetCurrentStandardPartItem¶

Sets the current standard part item that is edited.

This is useful if standard part framework works in non-group mode.

Signature SetCurrentStandardPartItem(pCurItemBuilder)

Parameters:	pCurItemBuilder (`NXOpen.Features.ShipDesign.StandardPartItemBuilder`) –

New in version NX8.5.0.

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

SetStandardPartVersion¶

StandardPartFrameworkBuilder.SetStandardPartVersion¶

Set the standard part version.

Signature SetStandardPartVersion(standardPartVersion)

Parameters:	standardPartVersion (float) –

New in version NX9.0.1.

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

SetView¶

StandardPartFrameworkBuilder.SetView¶

Sets the current view normal to the main plane, which is the base plane to construct the primary sketch in the template part.

If there is no sketch found, nothing will be done.

Signature SetView()

New in version NX8.0.0.

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

UpdateModel¶

StandardPartFrameworkBuilder.UpdateModel¶

Updates all standard parts

Signature UpdateModel()

New in version NX8.0.0.

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

UpdateShipNames¶

StandardPartFrameworkBuilder.UpdateShipNames¶

Update Ship Names builder when change part category.

Signature UpdateShipNames(shipNamesType)

Parameters:	shipNamesType (`NXOpen.Features.ShipDesign.ShipnamesBuilderType`) –

New in version NX11.0.1.

License requirements: None.

UpdateSpreadsheetData¶

StandardPartFrameworkBuilder.UpdateSpreadsheetData¶

Updates the parameter values which are defined in the parameter spreadsheet.

It also updates the standard parts.

Signature UpdateSpreadsheetData(strParamName, strParamValue, pnParamStatus)

Parameters:	strParamName (list of str) – strParamValue (list of str) – pnParamStatus (list of int) –

New in version NX8.0.0.

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

UpdateSpreadsheetDataNoUpdate¶

StandardPartFrameworkBuilder.UpdateSpreadsheetDataNoUpdate¶

Updates the parameter values which are defined in the parameter spreadsheet but not update the standard parts.

Signature UpdateSpreadsheetDataNoUpdate(strParamName, strParamValue, pnParamStatus)

Parameters:	strParamName (list of str) – strParamValue (list of str) – pnParamStatus (list of int) –

New in version NX8.0.0.

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

UpdateThickness¶

StandardPartFrameworkBuilder.UpdateThickness¶

Updates the user input thickness to the standard parts.

If bUpdateModel is true, the model will be updated. If it is false, the thickness value will be changed but the model will not be updated.

Signature UpdateThickness(bUpdateModel)

Parameters:	bUpdateModel (bool) –

New in version NX8.0.0.

Deprecated since version NX8.0.3: Use NXOpen.Features.ShipDesign.StandardPartFrameworkBuilder.ModifySpreadSheetData() instead.

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

UpdateThicknessDirection¶

StandardPartFrameworkBuilder.UpdateThicknessDirection¶

Updates the standard part thickness direction.

If bUpdateModel is true, the model will be updated. If it is false, the thickness direction will be flipped but the model will not be updated.

Signature UpdateThicknessDirection(bUpdateModel)

Parameters:	bUpdateModel (bool) –

New in version NX8.5.0.

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

Validate¶

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