ElectrodeCopyBuilder Class

class NXOpen.Tooling.ElectrodeCopyBuilder

Bases: NXOpen.Builder

The ElectrodeCopy builder

To create a new instance of this class, use NXOpen.Tooling.ElectrodeCopyCollection.CreateElectrodeCopyBuilder()

Default values.

Property Value
DefNum 1
SelType Transform

New in version NX6.0.0.

Properties

Property Description
CloneObject Returns the clone client data.
CopyInstance Returns or sets the setting indicates the copy is a new part or an instance.
DefNum Returns or sets the number of transform
ElectrodeBlankBuilder Returns or sets the electrode blank builder.
MirrorPlane Returns the mirror plane
Rename Returns or sets the new electrode name
SelToFace Returns the selected ‘to’ face
SelType Returns or sets the copy type
SelectElectrode Returns the selected electrode
SelectFromFace Returns the selected ‘from’ face
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CopyElectrode Copy an electrode blank from one face to another face.
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.
SetBlankPartName The part name of electrode blank.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateParameterData Update parameter data to electrode blank builder.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ElectrodeCopyBuilderCopy Enumeration Represents an index to copy type

Property Detail

CloneObject

ElectrodeCopyBuilder.CloneObject

Returns the clone client data.

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

Getter Method

Signature CloneObject

Returns:A NXOpen.Tooling.CloneObject instance
Return type:NXOpen.Tooling.CloneObject

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

CopyInstance

ElectrodeCopyBuilder.CopyInstance

Returns or sets the setting indicates the copy is a new part or an instance.

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

Getter Method

Signature CopyInstance

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature CopyInstance

Parameters:copyInstance (bool) –

New in version NX7.5.0.

License requirements: None.

DefNum

ElectrodeCopyBuilder.DefNum

Returns or sets the number of transform

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

Getter Method

Signature DefNum

Returns:
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DefNum

Parameters:defNum (int) –

New in version NX6.0.0.

License requirements: None.

ElectrodeBlankBuilder

ElectrodeCopyBuilder.ElectrodeBlankBuilder

Returns or sets the electrode blank builder.

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

Getter Method

Signature ElectrodeBlankBuilder

Returns:electrode blank builder tag
Return type:NXOpen.TaggedObject

New in version NX10.0.1.

License requirements: None.

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

Setter Method

Signature ElectrodeBlankBuilder

Parameters:builderTag (NXOpen.TaggedObject) – electrode blank builder tag

New in version NX10.0.1.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

MirrorPlane

ElectrodeCopyBuilder.MirrorPlane

Returns the mirror plane

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

Getter Method

Signature MirrorPlane

Returns:
Return type:NXOpen.SelectDatumPlaneList

New in version NX6.0.0.

License requirements: None.

Rename

ElectrodeCopyBuilder.Rename

Returns or sets the new electrode name

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

Getter Method

Signature Rename

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Rename

Parameters:rename (bool) –

New in version NX6.0.0.

License requirements: None.

SelToFace

ElectrodeCopyBuilder.SelToFace

Returns the selected ‘to’ face

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

Getter Method

Signature SelToFace

Returns:
Return type:NXOpen.SelectFaceList

New in version NX6.0.0.

License requirements: None.

SelType

ElectrodeCopyBuilder.SelType

Returns or sets the copy type

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

Getter Method

Signature SelType

Returns:
Return type:NXOpen.Tooling.ElectrodeCopyBuilderCopy

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SelType

Parameters:selType (NXOpen.Tooling.ElectrodeCopyBuilderCopy) –

New in version NX6.0.0.

License requirements: None.

SelectElectrode

ElectrodeCopyBuilder.SelectElectrode

Returns the selected electrode

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

Getter Method

Signature SelectElectrode

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

SelectFromFace

ElectrodeCopyBuilder.SelectFromFace

Returns the selected ‘from’ face

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

Getter Method

Signature SelectFromFace

Returns:
Return type:NXOpen.SelectFaceList

New in version NX6.0.0.

License requirements: None.

Method Detail

CopyElectrode

ElectrodeCopyBuilder.CopyElectrode

Copy an electrode blank from one face to another face.

Signature CopyElectrode(copyType, eleBody, fromface, toface)

Parameters:
Returns:

new part tag
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

SetBlankPartName

ElectrodeCopyBuilder.SetBlankPartName

The part name of electrode blank.

Signature SetBlankPartName(blankPartName)

Parameters:blankPartName (str) – blank part name

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

UpdateParameterData

ElectrodeCopyBuilder.UpdateParameterData

Update parameter data to electrode blank builder.

Signature UpdateParameterData(blankBuilderTag, partTag)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (modelPath, paraNames) modelPath is a str. model path paraNames is a list of str. parameter name

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Validate

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