ElectrodeInitializationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ElectrodeInitializationBuilder Class

class `NXOpen.Tooling.``ElectrodeInitializationBuilder`

  Bases: `NXOpen.Builder`

  Electrode initialize project builder to creates an electrode design assembly.

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

  Default values.

  Property | Value
  --- | ---
  ActionType | Original
  Rename | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
ActionType | Returns or sets the initialize method of initialize electrode project.
CurrentMset | Returns or sets the machine set part which is the working part.
Face | Returns the face whose center will be the origin of the machine set csys.
FaceList | Returns the face list whose center will be the origin of the machine set csys.
InputName | Returns or sets the input name as project name.
PathBrowser | Returns or sets the path browser.
Rename | Returns or sets the component name can be defined in the part name management.
Tag | Returns the Tag for this object.
Workpiece | Returns the utility to get the workpiece to create an electrode design project.
WorkpieceList | Returns the utility to get the workpiece list to create an electrode design project.

# Methods

Method | Description
--- | ---
BuildMemberPartName | Builds the name of a part which is a member of an electrode assembly.
Commit | Commits any edits that have been applied to the builder.
CreateCloneObjectOfMsetPart | Creates clone object of machine set part.
CreateCloneObjectOfTopPart | Creates clone object of top part.
CreateCloneObjectOfWorkingPart | Creates clone object of working part.
CreateMsetPart | Creates the mset part.
CreateProject | Creates the assembly structure of Electrode Wizard project.
CreateWorkingPart | Creates the working part.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
DisposeCloneObject | Disposes the clone object.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetMsetPart | Gets the machine set part in machine set tree list.
GetObject | Returns the object currently being edited by this builder.
GetWorkingPart | Gets the working part in mset.
InitLinkObjects | Links the selected objects to the working component of Electrode assembly.
InitalizeProjectParameter | Initialize the parameters of the project that need no machine set part.
RemoveSelectedMsetNode | Remove a selected machine set node.
SetCloneMethod | Set clone method.
SetConfigurationData | Sets details of the configuration data.
SetMsetCsysMatrixOrigin | Sets csys matrix and origin.
SetMsetCsysOriginToFaceCenter | Sets MSET CSYS origin to center of the selected faces.
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

ElectrodeInitializationBuilderMethod Enumeration | The initialize type: Original, No Working Part, No Machine Set Part and No Template.
ElectrodeInitializationBuilderType Enumeration | Clone a member of an electrode assembly, such as top part, machine set part, and working part.

# Property Detail

## ActionType

`ElectrodeInitializationBuilder.``ActionType`

  Returns or sets the initialize method of initialize electrode project.

  `-------------------------------------`

  Getter Method

  Signature `ActionType`

  Returns: |
  Return type: | `NXOpen.Tooling.ElectrodeInitializationBuilderMethod`

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ActionType`

  Parameters: | actionType (`NXOpen.Tooling.ElectrodeInitializationBuilderMethod`) –

  New in version NX11.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CurrentMset

`ElectrodeInitializationBuilder.``CurrentMset`

  Returns or sets the machine set part which is the working part.

  `-------------------------------------`

  Getter Method

  Signature `CurrentMset`

  Returns: | machine set part
  Return type: | `NXOpen.TaggedObject`

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

  `-------------------------------------`

  Setter Method

  Signature `CurrentMset`

  Parameters: | mset (`NXOpen.TaggedObject`) – machine set part

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## Face

`ElectrodeInitializationBuilder.``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.

  Deprecated since version NX11.0.0: This functionality is no longer supported.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## FaceList

`ElectrodeInitializationBuilder.``FaceList`

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

  `-------------------------------------`

  Getter Method

  Signature `FaceList`

  Returns: |
  Return type: | `NXOpen.SelectFaceList`

  New in version NX11.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## InputName

`ElectrodeInitializationBuilder.``InputName`

  Returns or sets the input name as project name.

  `-------------------------------------`

  Getter Method

  Signature `InputName`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

  `-------------------------------------`

  Setter Method

  Signature `InputName`

  Parameters: | inputName (str) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## PathBrowser

`ElectrodeInitializationBuilder.``PathBrowser`

  Returns or sets the path browser.

  `-------------------------------------`

  Getter Method

  Signature `PathBrowser`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

  `-------------------------------------`

  Setter Method

  Signature `PathBrowser`

  Parameters: | foldername (str) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## Rename

`ElectrodeInitializationBuilder.``Rename`

  Returns or sets the component name can be defined in the part name management.

  `-------------------------------------`

  Getter Method

  Signature `Rename`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

  `-------------------------------------`

  Setter Method

  Signature `Rename`

  Parameters: | rename (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## Workpiece

`ElectrodeInitializationBuilder.``Workpiece`

  Returns the utility to get the workpiece to create an electrode design project.

  `-------------------------------------`

  Getter Method

  Signature `Workpiece`

  Returns: |
  Return type: | `NXOpen.SelectBody`

  New in version NX8.0.0.

  License requirements: None.

## WorkpieceList

`ElectrodeInitializationBuilder.``WorkpieceList`

  Returns the utility to get the workpiece list to create an electrode design project.

  `-------------------------------------`

  Getter Method

  Signature `WorkpieceList`

  Returns: |
  Return type: | `NXOpen.SelectBodyList`

  New in version NX8.5.3.

  License requirements: None.

# Method Detail

## BuildMemberPartName

`ElectrodeInitializationBuilder.``BuildMemberPartName`

  Builds the name of a part which is a member of an electrode assembly.

  Signature `BuildMemberPartName(type)`

  Parameters: | type (`NXOpen.Tooling.ElectrodeInitializationBuilderType`) –
  Returns: |
  Return type: | str

  New in version NX11.0.2.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CreateCloneObjectOfMsetPart

`ElectrodeInitializationBuilder.``CreateCloneObjectOfMsetPart`

  Creates clone object of machine set part.

  Signature `CreateCloneObjectOfMsetPart()`

  Returns: |
  Return type: | `NXOpen.Tooling.CloneObject`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CreateCloneObjectOfTopPart

`ElectrodeInitializationBuilder.``CreateCloneObjectOfTopPart`

  Creates clone object of top part.

  Signature `CreateCloneObjectOfTopPart()`

  Returns: |
  Return type: | `NXOpen.Tooling.CloneObject`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CreateCloneObjectOfWorkingPart

`ElectrodeInitializationBuilder.``CreateCloneObjectOfWorkingPart`

  Creates clone object of working part.

  Signature `CreateCloneObjectOfWorkingPart()`

  Returns: |
  Return type: | `NXOpen.Tooling.CloneObject`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CreateMsetPart

`ElectrodeInitializationBuilder.``CreateMsetPart`

  Creates the mset part.

  Signature `CreateMsetPart(cloneObject)`

  Parameters: | cloneObject (`NXOpen.Tooling.CloneObject`) –
  Returns: |
  Return type: | `NXOpen.TaggedObject`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CreateProject

`ElectrodeInitializationBuilder.``CreateProject`

  Creates the assembly structure of Electrode Wizard project.

  Signature `CreateProject(cloneObject)`

  Parameters: | cloneObject (`NXOpen.Tooling.CloneObject`) –

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CreateWorkingPart

`ElectrodeInitializationBuilder.``CreateWorkingPart`

  Creates the working part.

  Signature `CreateWorkingPart(cloneObject, msetPartTag)`

  Parameters:

  - cloneObject (`NXOpen.Tooling.CloneObject`) –
  - msetPartTag (`NXOpen.TaggedObject`) –

  Returns: |
  Return type: | `NXOpen.TaggedObject`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## DisposeCloneObject

`ElectrodeInitializationBuilder.``DisposeCloneObject`

  Disposes the clone object.

  Signature `DisposeCloneObject(cloneObject)`

  Parameters: | cloneObject (`NXOpen.Tooling.CloneObject`) –

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## GetMsetPart

`ElectrodeInitializationBuilder.``GetMsetPart`

  Gets the machine set part in machine set tree list.

  Signature `GetMsetPart(listIndex)`

  Parameters: | listIndex (int) – index of machine set node in machine set tree list
  Returns: |
  Return type: | `NXOpen.TaggedObject`

  New in version NX11.0.2.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## GetWorkingPart

`ElectrodeInitializationBuilder.``GetWorkingPart`

  Gets the working part in mset.

  Signature `GetWorkingPart(msetPartTag)`

  Parameters: | msetPartTag (`NXOpen.TaggedObject`) –
  Returns: |
  Return type: | `NXOpen.TaggedObject`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## InitLinkObjects

`ElectrodeInitializationBuilder.``InitLinkObjects`

  Links the selected objects to the working component of Electrode assembly.

  Signature `InitLinkObjects(workingPartTag)`

  Parameters: | workingPartTag (`NXOpen.TaggedObject`) –

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## InitalizeProjectParameter

`ElectrodeInitializationBuilder.``InitalizeProjectParameter`

  Initialize the parameters of the project that need no machine set part.

  Signature `InitalizeProjectParameter(rootPartTag)`

  Parameters: | rootPartTag (`NXOpen.NXObject`) – root part object

  New in version NX11.0.2.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## RemoveSelectedMsetNode

`ElectrodeInitializationBuilder.``RemoveSelectedMsetNode`

  Remove a selected machine set node.

  Signature `RemoveSelectedMsetNode(msetPartTag)`

  Parameters: | msetPartTag (`NXOpen.TaggedObject`) –

  New in version NX12.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## SetCloneMethod

`ElectrodeInitializationBuilder.``SetCloneMethod`

  Set clone method.

  Signature `SetCloneMethod(cloneMethod)`

  Parameters: | cloneMethod (int) – clone method

  New in version NX11.0.2.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## SetConfigurationData

`ElectrodeInitializationBuilder.``SetConfigurationData`

  Sets details of the configuration data.

  Signature `SetConfigurationData(configName, topPartName, msetPartName, workingPartName, subdir, cloneMethod)`

  Parameters:

  - configName (str) – configuration name
  - topPartName (str) – top part name
  - msetPartName (str) – machine set part name
  - workingPartName (str) – working part name
  - subdir (str) – sub direction
  - cloneMethod (int) – cloning method

  New in version NX11.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## SetMsetCsysMatrixOrigin

`ElectrodeInitializationBuilder.``SetMsetCsysMatrixOrigin`

  Sets csys matrix and origin.

  Signature `SetMsetCsysMatrixOrigin(matrix, origin)`

  Parameters:

  - matrix (`NXOpen.Matrix3x3`) – csys matrix
  - origin (`NXOpen.Point3d`) – csys origin

  New in version NX8.5.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## SetMsetCsysOriginToFaceCenter

`ElectrodeInitializationBuilder.``SetMsetCsysOriginToFaceCenter`

  Sets MSET CSYS origin to center of the selected faces.

  Signature `SetMsetCsysOriginToFaceCenter()`

  New in version NX9.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## Validate

`ElectrodeInitializationBuilder.``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.