AssignPatchBuilder Class

class NXOpen.Tooling.AssignPatchBuilder

Bases: NXOpen.Builder

Represents a builder to be used to add sheet bodies as patch surfaces or delete patch surfaces.

To create a new instance of this class, use NXOpen.Tooling.AssignPatchCollection.CreateBuilder()

Default values.

Property	Value
ConvertType	WithCopies
KeepSheet	1

New in version NX7.5.0.

Properties

Property	Description
ConvertType	Returns or sets the option to convert to have copies or no copies for all selected sheets.
KeepSheet	Returns or sets the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface.
PartingColor	Returns or sets the parting surface color
PatchColor	Returns or sets the patch surface color.
PatchSurfaces	Returns the selected surfaces added as patch surfaces or deleted from patch surfaces.
Tag	Returns the Tag for this object.
Type	Returns or sets the type for editing patch or parting

Methods

Method	Description
AddSelectFace	Add selected face to select list.
ClearAddingCandidates	Clear the m_addingCandidates list.
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.
InitOnEnter	Get initial patched and parting faces to do delete surface function.
PrepareAllRemovingSheets	Get all the related sheets in one feature set.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateInitialCandidates	Update initial candidates after changing sheet type.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

AssignPatchBuilderConvertTypeOption Enumeration	The option to convert to have copies or no copies for all selected sheets.
AssignPatchBuilderTypes Enumeration	The types for assigning sheets.

Property Detail

ConvertType

AssignPatchBuilder.ConvertType

Returns or sets the option to convert to have copies or no copies for all selected sheets.

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

Getter Method

Signature ConvertType

Returns: Return type:NXOpen.Tooling.AssignPatchBuilderConvertTypeOption

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ConvertType

Parameters:convertType (NXOpen.Tooling.AssignPatchBuilderConvertTypeOption) –

New in version NX11.0.0.

License requirements: None.

KeepSheet

AssignPatchBuilder.KeepSheet

Returns or sets the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface.

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

Getter Method

Signature KeepSheet

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature KeepSheet

Parameters:keepSheet (bool) –

New in version NX7.5.0.

License requirements: None.

PartingColor

AssignPatchBuilder.PartingColor

Returns or sets the parting surface color

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

Getter Method

Signature PartingColor

Returns: Return type:Id

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature PartingColor

Parameters:partingColor (Id) –

New in version NX11.0.0.

License requirements: None.

PatchColor

AssignPatchBuilder.PatchColor

Returns or sets the patch surface color.

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

Getter Method

Signature PatchColor

Returns: Return type:Id

New in version NX7.5.5.

License requirements: None.

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

Setter Method

Signature PatchColor

Parameters:patchColor (Id) –

New in version NX7.5.5.

License requirements: None.

PatchSurfaces

AssignPatchBuilder.PatchSurfaces

Returns the selected surfaces added as patch surfaces or deleted from patch surfaces.

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

Getter Method

Signature PatchSurfaces

Returns: Return type:NXOpen.SelectBodyList

New in version NX7.5.0.

License requirements: None.

Type

AssignPatchBuilder.Type

Returns or sets the type for editing patch or parting

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

Getter Method

Signature Type

Returns: Return type:NXOpen.Tooling.AssignPatchBuilderTypes

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Tooling.AssignPatchBuilderTypes) –

New in version NX11.0.0.

License requirements: None.

Method Detail

AddSelectFace

AssignPatchBuilder.AddSelectFace

Add selected face to select list.

Signature AddSelectFace(addFace)

Parameters:addFace (NXOpen.Body) – face to add to user selected face list

New in version NX7.5.0.

License requirements: None.

ClearAddingCandidates

AssignPatchBuilder.ClearAddingCandidates

Clear the m_addingCandidates list.

Signature ClearAddingCandidates()

New in version NX7.5.0.

License requirements: None.

InitOnEnter

AssignPatchBuilder.InitOnEnter

Get initial patched and parting faces to do delete surface function.

Signature InitOnEnter()

New in version NX7.5.0.

License requirements: None.

PrepareAllRemovingSheets

AssignPatchBuilder.PrepareAllRemovingSheets

Get all the related sheets in one feature set.

Signature PrepareAllRemovingSheets(sheets)

Parameters:sheets (list of NXOpen.Body) – The sheets to find their related originals

New in version NX7.5.0.

License requirements: None.

UpdateInitialCandidates

AssignPatchBuilder.UpdateInitialCandidates

Update initial candidates after changing sheet type.

Signature UpdateInitialCandidates()

New in version NX11.0.0.

License requirements: None.

Validate

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