EWDraftingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# EWDraftingBuilder Class

class `NXOpen.Tooling.``EWDraftingBuilder`

  Bases: `NXOpen.Builder`

  Represents the drafting builder which is used to create electrode drafting.

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

  Default values.

  Property | Value
  --- | ---
  CncOption | 0
  CncTemplate | CncTemplate1
  DraftingMode | Create
  DrawingType | MasterModel
  EdmOption | 1
  EdmTemplate | EdmTemplate1
  IncludeOption | 1
  OrdinateDimension | 0
  OutputPDF | 0
  OutputSameSheet | 0
  RenameComponent | 0
  SheetName | Sh1
  UseInstance | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
BlankComps | Returns the blank components used to create drafting.
CncOption | Returns or sets the option to create cnc sheet type drafting or not.
CncTemplate | Returns or sets the template of cnc sheet type to create drafting.
DraftingMode | Returns or sets the drafting mode: create, add or edit.
DrawingType | Returns or sets the drawing type used to create drafting.
EdmOption | Returns or sets the option to create edm sheet type drafting or not.
EdmTemplate | Returns or sets the template of edm sheet type to create drafting.
HideCsys | Returns or sets the option to hide the datum CSYS in the drawing sheet.
IncludeFixture | Returns or sets the option used to include fixture when creating drafting.
IncludeOption | Returns or sets the option used to include the working component when creating drafting.
MasterModelCncPartName | Returns or sets the name to create a master model part for CNC drawing.
MasterModelEdmPartName | Returns or sets the name to create a master model part for EDM drawing.
NameRule | Returns or sets the name rule used to create drafting part.
OrdinateDimension | Returns or sets the option used to set ordinate dimension.
OutputPDF | Returns or sets the option used to output pdf file when creating drafting.
OutputSameSheet | Returns or sets the option used to output all the blanks in the same sheet.
RenameComponent | Returns or sets the option used to rename the part which is created.
SheetName | Returns or sets the sheet name option used to edit drafting.
Tag | Returns the Tag for this object.
UseInstance | Returns or sets the option used to display and use instance of electrode to create drawing.

# 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.
SetCncTemplateName | The template name of cnc sheet type to create drafting.
SetEdmTemplateName | The template name of edm sheet type to create drafting.
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

EWDraftingBuilderCNCTemplateOption Enumeration | the template option of cnc sheet type
EWDraftingBuilderDrawingOption Enumeration | the drawing type
EWDraftingBuilderEDMTemplateOption Enumeration | the template option of edm sheet type
EWDraftingBuilderModeOption Enumeration | the drafting mode option
EWDraftingBuilderNameOption Enumeration | the drawing sheet name option

# Property Detail

## BlankComps

`EWDraftingBuilder.``BlankComps`

  Returns the blank components used to create drafting.

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

  Getter Method

  Signature `BlankComps`

  Returns: |
  Return type: | `NXOpen.Assemblies.SelectComponentList`

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CncOption

`EWDraftingBuilder.``CncOption`

  Returns or sets the option to create cnc sheet type drafting or not.

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

  Getter Method

  Signature `CncOption`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `CncOption`

  Parameters: | cncOption (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## CncTemplate

`EWDraftingBuilder.``CncTemplate`

  Returns or sets the template of cnc sheet type to create drafting.

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

  Getter Method

  Signature `CncTemplate`

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

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `CncTemplate`

  Parameters: | cncTemplate (`NXOpen.Tooling.EWDraftingBuilderCNCTemplateOption`) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## DraftingMode

`EWDraftingBuilder.``DraftingMode`

  Returns or sets the drafting mode: create, add or edit.

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

  Getter Method

  Signature `DraftingMode`

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

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `DraftingMode`

  Parameters: | draftingMode (`NXOpen.Tooling.EWDraftingBuilderModeOption`) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## DrawingType

`EWDraftingBuilder.``DrawingType`

  Returns or sets the drawing type used to create drafting.

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

  Getter Method

  Signature `DrawingType`

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

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `DrawingType`

  Parameters: | drawingType (`NXOpen.Tooling.EWDraftingBuilderDrawingOption`) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## EdmOption

`EWDraftingBuilder.``EdmOption`

  Returns or sets the option to create edm sheet type drafting or not.

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

  Getter Method

  Signature `EdmOption`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `EdmOption`

  Parameters: | edmOption (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## EdmTemplate

`EWDraftingBuilder.``EdmTemplate`

  Returns or sets the template of edm sheet type to create drafting.

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

  Getter Method

  Signature `EdmTemplate`

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

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `EdmTemplate`

  Parameters: | edmTemplate (`NXOpen.Tooling.EWDraftingBuilderEDMTemplateOption`) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## HideCsys

`EWDraftingBuilder.``HideCsys`

  Returns or sets the option to hide the datum CSYS in the drawing sheet.

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

  Getter Method

  Signature `HideCsys`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `HideCsys`

  Parameters: | hideCsys (bool) –

  New in version NX12.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## IncludeFixture

`EWDraftingBuilder.``IncludeFixture`

  Returns or sets the option used to include fixture when creating drafting.

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

  Getter Method

  Signature `IncludeFixture`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `IncludeFixture`

  Parameters: | includeFixture (bool) –

  New in version NX10.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## IncludeOption

`EWDraftingBuilder.``IncludeOption`

  Returns or sets the option used to include the working component when creating drafting.

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

  Getter Method

  Signature `IncludeOption`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `IncludeOption`

  Parameters: | includeOption (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## MasterModelCncPartName

`EWDraftingBuilder.``MasterModelCncPartName`

  Returns or sets the name to create a master model part for CNC drawing.

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

  Getter Method

  Signature `MasterModelCncPartName`

  Returns: |
  Return type: | str

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MasterModelCncPartName`

  Parameters: | masterModelPartName (str) –

  New in version NX10.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## MasterModelEdmPartName

`EWDraftingBuilder.``MasterModelEdmPartName`

  Returns or sets the name to create a master model part for EDM drawing.

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

  Getter Method

  Signature `MasterModelEdmPartName`

  Returns: |
  Return type: | str

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MasterModelEdmPartName`

  Parameters: | masterModelPartName (str) –

  New in version NX10.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## NameRule

`EWDraftingBuilder.``NameRule`

  Returns or sets the name rule used to create drafting part.

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

  Getter Method

  Signature `NameRule`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `NameRule`

  Parameters: | nameRule (str) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## OrdinateDimension

`EWDraftingBuilder.``OrdinateDimension`

  Returns or sets the option used to set ordinate dimension.

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

  Getter Method

  Signature `OrdinateDimension`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `OrdinateDimension`

  Parameters: | ordinateDimension (bool) –

  New in version NX11.0.1.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## OutputPDF

`EWDraftingBuilder.``OutputPDF`

  Returns or sets the option used to output pdf file when creating drafting.

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

  Getter Method

  Signature `OutputPDF`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `OutputPDF`

  Parameters: | outputPDF (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## OutputSameSheet

`EWDraftingBuilder.``OutputSameSheet`

  Returns or sets the option used to output all the blanks in the same sheet.

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

  Getter Method

  Signature `OutputSameSheet`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `OutputSameSheet`

  Parameters: | outputSameSheet (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## RenameComponent

`EWDraftingBuilder.``RenameComponent`

  Returns or sets the option used to rename the part which is created.

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

  Getter Method

  Signature `RenameComponent`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `RenameComponent`

  Parameters: | renameComponent (bool) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## SheetName

`EWDraftingBuilder.``SheetName`

  Returns or sets the sheet name option used to edit drafting.

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

  Getter Method

  Signature `SheetName`

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

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `SheetName`

  Parameters: | sheetName (`NXOpen.Tooling.EWDraftingBuilderNameOption`) –

  New in version NX8.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## UseInstance

`EWDraftingBuilder.``UseInstance`

  Returns or sets the option used to display and use instance of electrode to create drawing.

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

  Getter Method

  Signature `UseInstance`

  Returns: |
  Return type: | bool

  New in version NX9.0.2.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

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

  Setter Method

  Signature `UseInstance`

  Parameters: | useInstance (bool) –

  New in version NX9.0.2.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

# Method Detail

## SetCncTemplateName

`EWDraftingBuilder.``SetCncTemplateName`

  The template name of cnc sheet type to create drafting.

  Signature `SetCncTemplateName(cncTemplateName)`

  Parameters: | cncTemplateName (str) –

  New in version NX12.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## SetEdmTemplateName

`EWDraftingBuilder.``SetEdmTemplateName`

  The template name of edm sheet type to create drafting.

  Signature `SetEdmTemplateName(edmTemplateName)`

  Parameters: | edmTemplateName (str) –

  New in version NX12.0.0.

  License requirements: nx_electrode_wizard (“NX Electrode Wizard”)

## Validate

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