ElectrodeCheckingBuilder Class

class NXOpen.Tooling.ElectrodeCheckingBuilder

Bases: NXOpen.Builder

Electrode Checking builder to check the touch status of all electrode.

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

Default values.

Property	Value
InterSolid	1
MapFaceColor	1
SameParent	1
TouchArea	0
TouchBody	1

New in version NX8.0.0.

Properties

Property	Description
Electrode	Returns the electrode part to be checked with the workpiece part.
ElectrodeNameFilter	Returns or sets the wildcard string to filter out the electrode part name.
InterSolid	Returns or sets the option for generating the interference solid body.
MapFaceColor	Returns or sets the option for mapping color of the touched face pair from workpiece to electrode.
SameParent	Returns or sets the option for checking the workpiece and electrode part under the same part or not.
SaveResultsInPart	Returns or sets the option for saving checking results in part.
Tag	Returns the Tag for this object.
TouchArea	Returns or sets the option for calculating the area of the touch sheet body.
TouchBody	Returns or sets the option for generating the touch sheet body.
Workpiece	Returns the workpiece part to be checked with the electrode part.
WorkpieceNameFilter	Returns or sets the wildcard string to filter out the workpiece part name.

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

Property Detail

Electrode

ElectrodeCheckingBuilder.Electrode

Returns the electrode part to be checked with the workpiece part.

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

Getter Method

Signature Electrode

Returns: Return type:NXOpen.Assemblies.SelectComponentList

New in version NX8.0.0.

License requirements: None.

ElectrodeNameFilter

ElectrodeCheckingBuilder.ElectrodeNameFilter

Returns or sets the wildcard string to filter out the electrode part name.

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

Getter Method

Signature ElectrodeNameFilter

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ElectrodeNameFilter

Parameters:electrodeNameFilter (str) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

InterSolid

ElectrodeCheckingBuilder.InterSolid

Returns or sets the option for generating the interference solid body.

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

Getter Method

Signature InterSolid

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature InterSolid

Parameters:interSolid (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

MapFaceColor

ElectrodeCheckingBuilder.MapFaceColor

Returns or sets the option for mapping color of the touched face pair from workpiece to electrode.

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

Getter Method

Signature MapFaceColor

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature MapFaceColor

Parameters:mapFaceColor (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

SameParent

ElectrodeCheckingBuilder.SameParent

Returns or sets the option for checking the workpiece and electrode part under the same part or not.

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

Getter Method

Signature SameParent

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SameParent

Parameters:sameParent (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

SaveResultsInPart

ElectrodeCheckingBuilder.SaveResultsInPart

Returns or sets the option for saving checking results in part.

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

Getter Method

Signature SaveResultsInPart

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SaveResultsInPart

Parameters:saveResultsInPart (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

TouchArea

ElectrodeCheckingBuilder.TouchArea

Returns or sets the option for calculating the area of the touch sheet body.

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

Getter Method

Signature TouchArea

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature TouchArea

Parameters:touchArea (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

TouchBody

ElectrodeCheckingBuilder.TouchBody

Returns or sets the option for generating the touch sheet body.

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

Getter Method

Signature TouchBody

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature TouchBody

Parameters:touchBody (bool) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Workpiece

ElectrodeCheckingBuilder.Workpiece

Returns the workpiece part to be checked with the electrode part.

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

Getter Method

Signature Workpiece

Returns: Return type:NXOpen.Assemblies.SelectComponentList

New in version NX8.0.0.

License requirements: None.

WorkpieceNameFilter

ElectrodeCheckingBuilder.WorkpieceNameFilter

Returns or sets the wildcard string to filter out the workpiece part name.

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

Getter Method

Signature WorkpieceNameFilter

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature WorkpieceNameFilter

Parameters:workpieceNameFilter (str) –

New in version NX8.0.0.

License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

Method Detail

Validate

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