ElectrodeBlankBuilder Class

class NXOpen.Tooling.ElectrodeBlankBuilder

Bases: NXOpen.Builder

Design electrode blank builder to create an electrode blank for the selected body.

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

Default values.

Property Value
Angle.Value 0
BlendRadius.Value 0 (millimeters part), 0 (inches part)
ExtensionHeight.Value 5 (millimeters part), 0.2 (inches part)
JointMethod Extrude
KeepSize 0
KeepZValueInSameMSet 0
Material Copper
ReferencePointPrecision 1
Rename 0
RotationAngle.Value 0
RoundCrossLinesPosition 0
Shape Block
UniteBodies 1
XRefValue.Value 0 (millimeters part), 0 (inches part)
YRefValue.Value 0 (millimeters part), 0 (inches part)
ZRefValue.Value 0 (millimeters part), 0 (inches part)

New in version NX8.0.0.

Properties

Property Description
Angle Returns the angle of the joint object.
Blank Returns the blank to be edited.
BlankMatrix Returns or sets the blank matrix.
BlendRadius Returns the default blend radius of blended edges.
CrossLinesRatio Returns or sets the ratio of cross center lines.
ExtensionHeight Returns the default extension height between head bodies and the blank.
HeadBodies Returns the head bodies to be used to create a blank.
JointFace Returns the face to create a joint object between the blank and head bodies.
JointMethod Returns or sets the joint object type.
KeepSize Returns or sets the option to keep size of the blank or not.
KeepZValueInSameMSet Returns or sets the option to specify whether to keep the Z values of all blanks in the current machine set CSYS.
Material Returns or sets the material of the blank.
MsetPart Returns or sets the current machine set under which a blank is added.
MultiPositionBuilder Returns or sets the multi position builder.
ReferenceCenter Returns or sets the blank reference point.
ReferencePointPrecision Returns or sets the precision of the reference coordinates in the machine set csys.
Rename Returns or sets the option to use the part name management dialog box or not.
ReusablePartBuilder Returns or sets the reusable part builder.
RotationAngle Returns the rotation angle of blank.
RoundCrossLinesPosition Returns or sets the option to round the position of cross lines or not.
Shape Returns or sets the shape of the blank.
Tag Returns the Tag for this object.
UniteBodies Returns or sets the option to unite head bodies, the extension and the blank or not.
XRefValue Returns the X value of the blank origin in the current machine set coordinator.
YRefValue Returns the Y value of the blank origin in the current machine set coordinator.
ZRefValue Returns the Z value of the blank origin in the current machine set coordinator.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreateCloneObject Creates clone object.
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.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateBlankData Update the data of the blank.
UpdateDisplayName Update display name of the blank.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ElectrodeBlankBuilderBlankMaterial Enumeration Represents the blank material option.
ElectrodeBlankBuilderBlankShape Enumeration Represents the electrode blank shape option.
ElectrodeBlankBuilderJointObject Enumeration Represents the transition type between head bodies and the blank.

Property Detail

Angle

ElectrodeBlankBuilder.Angle

Returns the angle of the joint object.

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

Getter Method

Signature Angle

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Blank

ElectrodeBlankBuilder.Blank

Returns the blank to be edited.

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

Getter Method

Signature Blank

Returns:
Return type:NXOpen.Assemblies.SelectComponent

New in version NX8.0.0.

License requirements: None.

BlankMatrix

ElectrodeBlankBuilder.BlankMatrix

Returns or sets the blank matrix.

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

Getter Method

Signature BlankMatrix

Returns:blank matrix
Return type:NXOpen.Matrix3x3

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature BlankMatrix

Parameters:matrix (NXOpen.Matrix3x3) – blank matrix

New in version NX8.5.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

BlendRadius

ElectrodeBlankBuilder.BlendRadius

Returns the default blend radius of blended edges.

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

Getter Method

Signature BlendRadius

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

CrossLinesRatio

ElectrodeBlankBuilder.CrossLinesRatio

Returns or sets the ratio of cross center lines.

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

Getter Method

Signature CrossLinesRatio

Returns:ratio
Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature CrossLinesRatio

Parameters:ratio (float) – ratio

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

ExtensionHeight

ElectrodeBlankBuilder.ExtensionHeight

Returns the default extension height between head bodies and the blank.

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

Getter Method

Signature ExtensionHeight

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

HeadBodies

ElectrodeBlankBuilder.HeadBodies

Returns the head bodies to be used to create a blank.

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

Getter Method

Signature HeadBodies

Returns:
Return type:NXOpen.SelectBodyList

New in version NX8.0.0.

License requirements: None.

JointFace

ElectrodeBlankBuilder.JointFace

Returns the face to create a joint object between the blank and head bodies.

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

Getter Method

Signature JointFace

Returns:
Return type:NXOpen.SelectFace

New in version NX8.0.0.

License requirements: None.

JointMethod

ElectrodeBlankBuilder.JointMethod

Returns or sets the joint object type.

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

Getter Method

Signature JointMethod

Returns:
Return type:NXOpen.Tooling.ElectrodeBlankBuilderJointObject

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature JointMethod

Parameters:jointMethod (NXOpen.Tooling.ElectrodeBlankBuilderJointObject) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

KeepSize

ElectrodeBlankBuilder.KeepSize

Returns or sets the option to keep size of the blank or not.

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

Getter Method

Signature KeepSize

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature KeepSize

Parameters:keepSize (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

KeepZValueInSameMSet

ElectrodeBlankBuilder.KeepZValueInSameMSet

Returns or sets the option to specify whether to keep the Z values of all blanks in the current machine set CSYS.

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

Getter Method

Signature KeepZValueInSameMSet

Returns:keep z value in machine set or not
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature KeepZValueInSameMSet

Parameters:keepValue (bool) – keep z value in machine set or not

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Material

ElectrodeBlankBuilder.Material

Returns or sets the material of the blank.

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

Getter Method

Signature Material

Returns:
Return type:NXOpen.Tooling.ElectrodeBlankBuilderBlankMaterial

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Material

Parameters:material (NXOpen.Tooling.ElectrodeBlankBuilderBlankMaterial) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

MsetPart

ElectrodeBlankBuilder.MsetPart

Returns or sets the current machine set under which a blank is added.

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

Getter Method

Signature MsetPart

Returns:the machine set part
Return type:NXOpen.TaggedObject

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature MsetPart

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

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

MultiPositionBuilder

ElectrodeBlankBuilder.MultiPositionBuilder

Returns or sets the multi position builder.

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

Getter Method

Signature MultiPositionBuilder

Returns:multi position builder tag
Return type:NXOpen.TaggedObject

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature MultiPositionBuilder

Parameters:builderTag (NXOpen.TaggedObject) – multi position builder tag

New in version NX8.5.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

ReferenceCenter

ElectrodeBlankBuilder.ReferenceCenter

Returns or sets the blank reference point.

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

Getter Method

Signature ReferenceCenter

Returns:blank position
Return type:NXOpen.Point3d

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ReferenceCenter

Parameters:point (NXOpen.Point3d) – blank position

New in version NX8.5.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

ReferencePointPrecision

ElectrodeBlankBuilder.ReferencePointPrecision

Returns or sets the precision of the reference coordinates in the machine set csys.

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

Getter Method

Signature ReferencePointPrecision

Returns:precision value
Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ReferencePointPrecision

Parameters:precision (float) – precision value

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Rename

ElectrodeBlankBuilder.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”)

ReusablePartBuilder

ElectrodeBlankBuilder.ReusablePartBuilder

Returns or sets the reusable part builder.

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

Getter Method

Signature ReusablePartBuilder

Returns:reusable part builder tag
Return type:NXOpen.TaggedObject

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ReusablePartBuilder

Parameters:builderTag (NXOpen.TaggedObject) – reusable part builder tag

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

RotationAngle

ElectrodeBlankBuilder.RotationAngle

Returns the rotation angle of blank.

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

Getter Method

Signature RotationAngle

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

RoundCrossLinesPosition

ElectrodeBlankBuilder.RoundCrossLinesPosition

Returns or sets the option to round the position of cross lines or not.

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

Getter Method

Signature RoundCrossLinesPosition

Returns:round cross lines or not
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature RoundCrossLinesPosition

Parameters:round (bool) – round cross lines or not

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Shape

ElectrodeBlankBuilder.Shape

Returns or sets the shape of the blank.

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

Getter Method

Signature Shape

Returns:
Return type:NXOpen.Tooling.ElectrodeBlankBuilderBlankShape

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Shape

Parameters:shape (NXOpen.Tooling.ElectrodeBlankBuilderBlankShape) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

UniteBodies

ElectrodeBlankBuilder.UniteBodies

Returns or sets the option to unite head bodies, the extension and the blank or not.

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

Getter Method

Signature UniteBodies

Returns:unite head, extension and blank together or not
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature UniteBodies

Parameters:unite (bool) – unite head, extension and blank together or not

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

XRefValue

ElectrodeBlankBuilder.XRefValue

Returns the X value of the blank origin in the current machine set coordinator.

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

Getter Method

Signature XRefValue

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

YRefValue

ElectrodeBlankBuilder.YRefValue

Returns the Y value of the blank origin in the current machine set coordinator.

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

Getter Method

Signature YRefValue

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ZRefValue

ElectrodeBlankBuilder.ZRefValue

Returns the Z value of the blank origin in the current machine set coordinator.

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

Getter Method

Signature ZRefValue

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

Method Detail

CreateCloneObject

ElectrodeBlankBuilder.CreateCloneObject

Creates clone object.

Signature CreateCloneObject(applicationType, installationMethod, partToBeInstalled, folderToSaveParts, projectName)

Parameters:
  • applicationType (int) –
  • installationMethod (int) –
  • partToBeInstalled (str) –
  • folderToSaveParts (str) –
  • projectName (str) –
Returns:

Return type:

NXOpen.Tooling.CloneObject

New in version NX12.0.0.

License requirements: None.

UpdateBlankData

ElectrodeBlankBuilder.UpdateBlankData

Update the data of the blank.

Signature UpdateBlankData(registerPath, dataPath, modelPath, bitmapPath, material, paraNames, paraValues)

Parameters:
  • registerPath (str) – register path of the blank part
  • dataPath (str) – data path of the blank part
  • modelPath (str) – model path of the blank part
  • bitmapPath (str) – bitmap path of the blank part
  • material (str) – material of the blank part
  • paraNames (list of str) – parameter name the blank part
  • paraValues (list of str) – parameter value the blank part

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

UpdateDisplayName

ElectrodeBlankBuilder.UpdateDisplayName

Update display name of the blank.

Signature UpdateDisplayName(displayName)

Parameters:displayName (str) – display name of the blank part

New in version NX12.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Validate

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