ElectrodeComponentBuilder Class

class NXOpen.Tooling.ElectrodeComponentBuilder

Bases: NXOpen.Builder

Electrode component builder to install holder and pallet.

To create a new instance of this class, use NXOpen.Tooling.ElectrodeDesignCollection.CreateComponentBuilder()

Default values.

Property Value
ReferPart 0
Rename 0

New in version NX8.0.0.

Properties

Property Description
ChuckType Returns or sets the electrode chuck type.
ComponentMatrix Returns or sets the component matrix.
Face Returns the face whose center will be the origin of the machine set csys.
Fixture Returns the part which is an electrode fixture to be edited.
MateCsys Returns or sets the current machine set CSYS.
Parent Returns the part which is the assembly parent to install an electrode chuck.
ReferPart Returns or sets the option to install a chuck by referring to the template part directly or not.
ReferenceCenter Returns or sets the component reference point.
Rename Returns or sets the option to use the part name management dialog box or not.
StandardData Returns or sets the electrode standard data spraedsheet.
StandardPart Returns or sets the electrode standard part to be installed.
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
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.
InstallComponentPart Install a holder or a pallet part.
SetTemplateDataName The template data name of holder or pallet.
SetTemplatePartName The template part name of holder or pallet.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ElectrodeComponentBuilderChuck Enumeration Represents the electrode chuck type.

Property Detail

ChuckType

ElectrodeComponentBuilder.ChuckType

Returns or sets the electrode chuck type.

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

Getter Method

Signature ChuckType

Returns:
Return type:NXOpen.Tooling.ElectrodeComponentBuilderChuck

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ChuckType

Parameters:chuck (NXOpen.Tooling.ElectrodeComponentBuilderChuck) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

ComponentMatrix

ElectrodeComponentBuilder.ComponentMatrix

Returns or sets the component matrix.

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

Getter Method

Signature ComponentMatrix

Returns:component matrix
Return type:NXOpen.Matrix3x3

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature ComponentMatrix

Parameters:matrix (NXOpen.Matrix3x3) – component matrix

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Face

ElectrodeComponentBuilder.Face

Returns the face whose center will be the origin of the machine set csys.

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

Getter Method

Signature Face

Returns:
Return type:NXOpen.SelectFace

New in version NX8.0.0.

License requirements: None.

Fixture

ElectrodeComponentBuilder.Fixture

Returns the part which is an electrode fixture to be edited.

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

Getter Method

Signature Fixture

Returns:
Return type:NXOpen.Assemblies.SelectComponent

New in version NX8.0.0.

License requirements: None.

MateCsys

ElectrodeComponentBuilder.MateCsys

Returns or sets the current machine set CSYS.

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

Getter Method

Signature MateCsys

Returns:
Return type:NXOpen.NXObject

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature MateCsys

Parameters:csys (NXOpen.NXObject) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Parent

ElectrodeComponentBuilder.Parent

Returns the part which is the assembly parent to install an electrode chuck.

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

Getter Method

Signature Parent

Returns:
Return type:NXOpen.Assemblies.SelectComponent

New in version NX8.0.0.

License requirements: None.

ReferPart

ElectrodeComponentBuilder.ReferPart

Returns or sets the option to install a chuck by referring to the template part directly or not.

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

Getter Method

Signature ReferPart

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ReferPart

Parameters:referPart (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

ReferenceCenter

ElectrodeComponentBuilder.ReferenceCenter

Returns or sets the component reference point.

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

Getter Method

Signature ReferenceCenter

Returns:component position
Return type:NXOpen.Point3d

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature ReferenceCenter

Parameters:point (NXOpen.Point3d) – component position

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Rename

ElectrodeComponentBuilder.Rename

Returns or sets the option to use the part name management dialog box or not.

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

Getter Method

Signature Rename

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Rename

Parameters:rename (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

StandardData

ElectrodeComponentBuilder.StandardData

Returns or sets the electrode standard data spraedsheet.

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

Getter Method

Signature StandardData

Returns:
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature StandardData

Parameters:standardData (str) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

StandardPart

ElectrodeComponentBuilder.StandardPart

Returns or sets the electrode standard part to be installed.

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

Getter Method

Signature StandardPart

Returns:
Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature StandardPart

Parameters:standardPart (str) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Method Detail

InstallComponentPart

ElectrodeComponentBuilder.InstallComponentPart

Install a holder or a pallet part.

Signature InstallComponentPart(templateData, libraryName, catalogName, classificationName, titleName)

Parameters:
  • templateData (NXOpen.Tooling.SpreadsheetData) – spread sheet data of the standard part
  • libraryName (str) – library name of the standard part
  • catalogName (str) – catalog name of the standard part
  • classificationName (str) – classification name of the standard part
  • titleName (str) – title name of the standard part
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

SetTemplateDataName

ElectrodeComponentBuilder.SetTemplateDataName

The template data name of holder or pallet.

Signature SetTemplateDataName(templateDataName)

Parameters:templateDataName (str) –

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

SetTemplatePartName

ElectrodeComponentBuilder.SetTemplatePartName

The template part name of holder or pallet.

Signature SetTemplatePartName(templatePartName)

Parameters:templatePartName (str) –

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Validate

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