RunnerBuilder Class

class NXOpen.Tooling.RunnerBuilder

Bases: NXOpen.Builder

Mold Wizard runner management builder, select curves as runner guide, choose section type and edit section parameters, optional choose boolean type to create runner channel.

To create a new instance of this class, use NXOpen.Tooling.RunnerCollection.CreateRunnerBuilder()

Default values.

Property	Value
EndShape	Both
SectionShape	Circular
TransMotion.DeltaEnum	ReferenceWcsWorkPart
TransMotion.DeltaXc.Value	0.0
TransMotion.DeltaYc.Value	0.0
TransMotion.DeltaZc.Value	0.0

New in version NX7.5.0.

Properties

Property	Description
BooleanOperation	Returns the boolean operation to perform on the runner.
EndShape	Returns or sets the guide end shape type of runner.
GuideLines	Returns the runner guide lines to create runner channel.
RunnerBodies	Returns the runner bodies
SectionOffset	Returns the offset value of the runner section.
SectionShape	Returns or sets the section shape type of runner.
SectionVector	Returns or sets the vector indicating the runner section direction.
Tag	Returns the Tag for this object.
TransMotion	Returns the transform motion to rotate the section curves.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
DeleteRunner	Deletes the runner bodies.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
EditDataBase	Edits runner section data base.
EditRegisterFile	Edits runner section register file.
EditTemplateExpression	Edits expressions of runner section.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetDataFromRunnerFeature	Gets spreadsheet data from runner feature.
GetObject	Returns the object currently being edited by this builder.
ImportTemplate	Import runner section template part.
ReadSectionDataFromDatabase	Read section data from runner section database.
ReadSelectedSectionData	Reads selected section data from database.
SetParameterTreeData	Sets spreadsheet data.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
StoreSectionParameters	Stores current section parameters information.
UpdateGuideLoops	Restruct guide loops when guide curve selection updates.
UpdateGuideOrientation	Updates the orientation of the section in guide loops.
UpdateTemplatePart	Updates runner section.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

RunnerBuilderGuideEndType Enumeration	Represents the runner guide end type.
RunnerBuilderSectionType Enumeration	Represents the section type of runner channel.

Property Detail

BooleanOperation

RunnerBuilder.BooleanOperation

Returns the boolean operation to perform on the runner.

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

Getter Method

Signature BooleanOperation

Returns: Return type:NXOpen.GeometricUtilities.BooleanOperation

New in version NX7.5.0.

License requirements: None.

EndShape

RunnerBuilder.EndShape

Returns or sets the guide end shape type of runner.

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

Getter Method

Signature EndShape

Returns: Return type:NXOpen.Tooling.RunnerBuilderGuideEndType

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature EndShape

Parameters:endShape (NXOpen.Tooling.RunnerBuilderGuideEndType) –

New in version NX7.5.0.

License requirements: None.

GuideLines

RunnerBuilder.GuideLines

Returns the runner guide lines to create runner channel.

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

Getter Method

Signature GuideLines

Returns: Return type:NXOpen.Section

New in version NX7.5.0.

License requirements: None.

RunnerBodies

RunnerBuilder.RunnerBodies

Returns the runner bodies

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

Getter Method

Signature RunnerBodies

Returns: Return type:NXOpen.SelectBodyList

New in version NX7.5.0.

License requirements: None.

SectionOffset

RunnerBuilder.SectionOffset

Returns the offset value of the runner section.

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

Getter Method

Signature SectionOffset

Returns: Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: None.

SectionShape

RunnerBuilder.SectionShape

Returns or sets the section shape type of runner.

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

Getter Method

Signature SectionShape

Returns: Return type:NXOpen.Tooling.RunnerBuilderSectionType

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SectionShape

Parameters:sectionShape (NXOpen.Tooling.RunnerBuilderSectionType) –

New in version NX7.5.0.

License requirements: None.

SectionVector

RunnerBuilder.SectionVector

Returns or sets the vector indicating the runner section direction.

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

Getter Method

Signature SectionVector

Returns: Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SectionVector

Parameters:sectionVector (NXOpen.Direction) –

New in version NX7.5.0.

License requirements: None.

TransMotion

RunnerBuilder.TransMotion

Returns the transform motion to rotate the section curves.

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

Getter Method

Signature TransMotion

Returns: Return type:NXOpen.GeometricUtilities.ModlMotion

New in version NX7.5.0.

License requirements: None.

Method Detail

DeleteRunner

RunnerBuilder.DeleteRunner

Deletes the runner bodies.

Signature DeleteRunner()

New in version NX7.5.0.

License requirements: None.

EditDataBase

RunnerBuilder.EditDataBase

Edits runner section data base.

Signature EditDataBase()

New in version NX7.5.0.

License requirements: None.

EditRegisterFile

RunnerBuilder.EditRegisterFile

Edits runner section register file.

Signature EditRegisterFile()

New in version NX7.5.0.

License requirements: None.

EditTemplateExpression

RunnerBuilder.EditTemplateExpression

Edits expressions of runner section.

Signature EditTemplateExpression()

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

GetDataFromRunnerFeature

RunnerBuilder.GetDataFromRunnerFeature

Gets spreadsheet data from runner feature.

Signature GetDataFromRunnerFeature(sheetData)

Parameters:sheetData (NXOpen.Tooling.SpreadsheetData) – Spreadsheet data

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

ImportTemplate

RunnerBuilder.ImportTemplate

Import runner section template part.

Signature ImportTemplate()

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

ReadSectionDataFromDatabase

RunnerBuilder.ReadSectionDataFromDatabase

Read section data from runner section database.

Signature ReadSectionDataFromDatabase()

Returns:Section type name list in spreadsheet. Return type:list of str

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

ReadSelectedSectionData

RunnerBuilder.ReadSelectedSectionData

Reads selected section data from database.

Signature ReadSelectedSectionData(sectionName)

Parameters:sectionName (str) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

SetParameterTreeData

RunnerBuilder.SetParameterTreeData

Sets spreadsheet data.

Signature SetParameterTreeData(sheetData)

Parameters:sheetData (NXOpen.Tooling.SpreadsheetData) – Spreadsheet data

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

StoreSectionParameters

RunnerBuilder.StoreSectionParameters

Stores current section parameters information.

Signature StoreSectionParameters()

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

UpdateGuideLoops

RunnerBuilder.UpdateGuideLoops

Restruct guide loops when guide curve selection updates.

Signature UpdateGuideLoops()

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

UpdateGuideOrientation

RunnerBuilder.UpdateGuideOrientation

Updates the orientation of the section in guide loops.

Signature UpdateGuideOrientation()

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

UpdateTemplatePart

RunnerBuilder.UpdateTemplatePart

Updates runner section.

Signature UpdateTemplatePart()

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”)

Validate

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