NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::EWDraftingBuilder Class Reference

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

Inheritance diagram for NXOpen::Tooling::EWDraftingBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CNCTemplateOption { CNCTemplateOptionCncTemplate1, CNCTemplateOptionCncTemplate2 }
 the template option of cnc sheet type More...
 
enum  DrawingOption { DrawingOptionMasterModel, DrawingOptionSelfContained }
 the drawing type More...
 
enum  EDMTemplateOption { EDMTemplateOptionEdmTemplate1, EDMTemplateOptionEdmTemplate2 }
 the template option of edm sheet type More...
 
enum  ModeOption { ModeOptionCreate, ModeOptionAdd, ModeOptionEdit }
 the drafting mode option More...
 
enum  NameOption { NameOptionSh1, NameOptionSh2 }
 the drawing sheet name option More...
 

Public Member Functions

NXOpen::Assemblies::SelectComponentListBlankComps ()
 Returns the blank components used to create drafting. More...
 
bool CncOption ()
 Returns the option to create cnc sheet type drafting or not. More...
 
NXOpen::Tooling::EWDraftingBuilder::CNCTemplateOption CncTemplate ()
 Returns the template of cnc sheet type to create drafting. More...
 
NXOpen::Tooling::EWDraftingBuilder::ModeOption DraftingMode ()
 Returns the drafting mode: create, add or edit. More...
 
NXOpen::Tooling::EWDraftingBuilder::DrawingOption DrawingType ()
 Returns the drawing type used to create drafting. More...
 
bool EdmOption ()
 Returns the option to create edm sheet type drafting or not. More...
 
NXOpen::Tooling::EWDraftingBuilder::EDMTemplateOption EdmTemplate ()
 Returns the template of edm sheet type to create drafting. More...
 
bool HideCsys ()
 Returns the option to hide the datum CSYS in the drawing sheet. More...
 
bool IncludeFixture ()
 Returns the option used to include fixture when creating drafting. More...
 
bool IncludeOption ()
 Returns the option used to include the working component when creating drafting. More...
 
NXString MasterModelCncPartName ()
 Returns the name to create a master model part for CNC drawing. More...
 
NXString MasterModelEdmPartName ()
 Returns the name to create a master model part for EDM drawing. More...
 
NXString NameRule ()
 Returns the name rule used to create drafting part. More...
 
bool OrdinateDimension ()
 Returns the option used to set ordinate dimension. More...
 
bool OutputPDF ()
 Returns the option used to output pdf file when creating drafting. More...
 
bool OutputSameSheet ()
 Returns the option used to output all the blanks in the same sheet. More...
 
bool RenameComponent ()
 Returns the option used to rename the part which is created. More...
 
void SetCncOption (bool cncOption)
 Sets the option to create cnc sheet type drafting or not. More...
 
void SetCncTemplate (NXOpen::Tooling::EWDraftingBuilder::CNCTemplateOption cncTemplate)
 Sets the template of cnc sheet type to create drafting. More...
 
void SetCncTemplateName (const NXString &cncTemplateName)
 The template name of cnc sheet type to create drafting. More...
 
void SetCncTemplateName (const char *cncTemplateName)
 The template name of cnc sheet type to create drafting. More...
 
void SetDraftingMode (NXOpen::Tooling::EWDraftingBuilder::ModeOption draftingMode)
 Sets the drafting mode: create, add or edit. More...
 
void SetDrawingType (NXOpen::Tooling::EWDraftingBuilder::DrawingOption drawingType)
 Sets the drawing type used to create drafting. More...
 
void SetEdmOption (bool edmOption)
 Sets the option to create edm sheet type drafting or not. More...
 
void SetEdmTemplate (NXOpen::Tooling::EWDraftingBuilder::EDMTemplateOption edmTemplate)
 Sets the template of edm sheet type to create drafting. More...
 
void SetEdmTemplateName (const NXString &edmTemplateName)
 The template name of edm sheet type to create drafting. More...
 
void SetEdmTemplateName (const char *edmTemplateName)
 The template name of edm sheet type to create drafting. More...
 
void SetHideCsys (bool hideCsys)
 Sets the option to hide the datum CSYS in the drawing sheet. More...
 
void SetIncludeFixture (bool includeFixture)
 Sets the option used to include fixture when creating drafting. More...
 
void SetIncludeOption (bool includeOption)
 Sets the option used to include the working component when creating drafting. More...
 
void SetMasterModelCncPartName (const NXString &masterModelPartName)
 Sets the name to create a master model part for CNC drawing. More...
 
void SetMasterModelCncPartName (const char *masterModelPartName)
 Sets the name to create a master model part for CNC drawing. More...
 
void SetMasterModelEdmPartName (const NXString &masterModelPartName)
 Sets the name to create a master model part for EDM drawing. More...
 
void SetMasterModelEdmPartName (const char *masterModelPartName)
 Sets the name to create a master model part for EDM drawing. More...
 
void SetNameRule (const NXString &nameRule)
 Sets the name rule used to create drafting part. More...
 
void SetNameRule (const char *nameRule)
 Sets the name rule used to create drafting part. More...
 
void SetOrdinateDimension (bool ordinateDimension)
 Sets the option used to set ordinate dimension. More...
 
void SetOutputPDF (bool outputPDF)
 Sets the option used to output pdf file when creating drafting. More...
 
void SetOutputSameSheet (bool outputSameSheet)
 Sets the option used to output all the blanks in the same sheet. More...
 
void SetRenameComponent (bool renameComponent)
 Sets the option used to rename the part which is created. More...
 
void SetSheetName (NXOpen::Tooling::EWDraftingBuilder::NameOption sheetName)
 Sets the sheet name option used to edit drafting. More...
 
void SetUseInstance (bool useInstance)
 Sets the option used to display and use instance of electrode to create drawing. More...
 
NXOpen::Tooling::EWDraftingBuilder::NameOption SheetName ()
 Returns the sheet name option used to edit drafting. More...
 
bool UseInstance ()
 Returns the option used to display and use instance of electrode to create drawing. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX8.0.0.

Member Enumeration Documentation

the template option of cnc sheet type

Enumerator
CNCTemplateOptionCncTemplate1 

template1

CNCTemplateOptionCncTemplate2 

template2

the drawing type

Enumerator
DrawingOptionMasterModel 

master model

DrawingOptionSelfContained 

self contained

the template option of edm sheet type

Enumerator
EDMTemplateOptionEdmTemplate1 

template1

EDMTemplateOptionEdmTemplate2 

template2

the drafting mode option

Enumerator
ModeOptionCreate 

create drawing

ModeOptionAdd 

add drawing

ModeOptionEdit 

edit drawing

the drawing sheet name option

Enumerator
NameOptionSh1 

sh1 sheet name

NameOptionSh2 

sh2 sheet name

Member Function Documentation

NXOpen::Assemblies::SelectComponentList* NXOpen::Tooling::EWDraftingBuilder::BlankComps ( )

Returns the blank components used to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::CncOption ( )

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


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::Tooling::EWDraftingBuilder::CNCTemplateOption NXOpen::Tooling::EWDraftingBuilder::CncTemplate ( )

Returns the template of cnc sheet type to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::Tooling::EWDraftingBuilder::ModeOption NXOpen::Tooling::EWDraftingBuilder::DraftingMode ( )

Returns the drafting mode: create, add or edit.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::Tooling::EWDraftingBuilder::DrawingOption NXOpen::Tooling::EWDraftingBuilder::DrawingType ( )

Returns the drawing type used to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::EdmOption ( )

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


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::Tooling::EWDraftingBuilder::EDMTemplateOption NXOpen::Tooling::EWDraftingBuilder::EdmTemplate ( )

Returns the template of edm sheet type to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::HideCsys ( )

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


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::IncludeFixture ( )

Returns the option used to include fixture when creating drafting.


Created in NX10.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::IncludeOption ( )

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


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXString NXOpen::Tooling::EWDraftingBuilder::MasterModelCncPartName ( )

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


Created in NX10.0.0.

License requirements : None

NXString NXOpen::Tooling::EWDraftingBuilder::MasterModelEdmPartName ( )

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


Created in NX10.0.0.

License requirements : None

NXString NXOpen::Tooling::EWDraftingBuilder::NameRule ( )

Returns the name rule used to create drafting part.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::OrdinateDimension ( )

Returns the option used to set ordinate dimension.


Created in NX11.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::OutputPDF ( )

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


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::OutputSameSheet ( )

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


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::RenameComponent ( )

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


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::EWDraftingBuilder::SetCncOption ( bool  cncOption)

Sets the option to create cnc sheet type drafting or not.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cncOptioncncoption
void NXOpen::Tooling::EWDraftingBuilder::SetCncTemplate ( NXOpen::Tooling::EWDraftingBuilder::CNCTemplateOption  cncTemplate)

Sets the template of cnc sheet type to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cncTemplatecnctemplate
void NXOpen::Tooling::EWDraftingBuilder::SetCncTemplateName ( const NXString cncTemplateName)

The template name of cnc sheet type to create drafting.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cncTemplateNamecnctemplatename
void NXOpen::Tooling::EWDraftingBuilder::SetCncTemplateName ( const char *  cncTemplateName)

The template name of cnc sheet type to create drafting.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cncTemplateNamecnctemplatename
void NXOpen::Tooling::EWDraftingBuilder::SetDraftingMode ( NXOpen::Tooling::EWDraftingBuilder::ModeOption  draftingMode)

Sets the drafting mode: create, add or edit.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
draftingModedraftingmode
void NXOpen::Tooling::EWDraftingBuilder::SetDrawingType ( NXOpen::Tooling::EWDraftingBuilder::DrawingOption  drawingType)

Sets the drawing type used to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
drawingTypedrawingtype
void NXOpen::Tooling::EWDraftingBuilder::SetEdmOption ( bool  edmOption)

Sets the option to create edm sheet type drafting or not.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
edmOptionedmoption
void NXOpen::Tooling::EWDraftingBuilder::SetEdmTemplate ( NXOpen::Tooling::EWDraftingBuilder::EDMTemplateOption  edmTemplate)

Sets the template of edm sheet type to create drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
edmTemplateedmtemplate
void NXOpen::Tooling::EWDraftingBuilder::SetEdmTemplateName ( const NXString edmTemplateName)

The template name of edm sheet type to create drafting.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
edmTemplateNameedmtemplatename
void NXOpen::Tooling::EWDraftingBuilder::SetEdmTemplateName ( const char *  edmTemplateName)

The template name of edm sheet type to create drafting.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
edmTemplateNameedmtemplatename
void NXOpen::Tooling::EWDraftingBuilder::SetHideCsys ( bool  hideCsys)

Sets the option to hide the datum CSYS in the drawing sheet.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
hideCsyshidecsys
void NXOpen::Tooling::EWDraftingBuilder::SetIncludeFixture ( bool  includeFixture)

Sets the option used to include fixture when creating drafting.


Created in NX10.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
includeFixtureincludefixture
void NXOpen::Tooling::EWDraftingBuilder::SetIncludeOption ( bool  includeOption)

Sets the option used to include the working component when creating drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
includeOptionincludeoption
void NXOpen::Tooling::EWDraftingBuilder::SetMasterModelCncPartName ( const NXString masterModelPartName)

Sets the name to create a master model part for CNC drawing.


Created in NX10.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
masterModelPartNamemastermodelpartname
void NXOpen::Tooling::EWDraftingBuilder::SetMasterModelCncPartName ( const char *  masterModelPartName)

Sets the name to create a master model part for CNC drawing.


Created in NX10.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
masterModelPartNamemastermodelpartname
void NXOpen::Tooling::EWDraftingBuilder::SetMasterModelEdmPartName ( const NXString masterModelPartName)

Sets the name to create a master model part for EDM drawing.


Created in NX10.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
masterModelPartNamemastermodelpartname
void NXOpen::Tooling::EWDraftingBuilder::SetMasterModelEdmPartName ( const char *  masterModelPartName)

Sets the name to create a master model part for EDM drawing.


Created in NX10.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
masterModelPartNamemastermodelpartname
void NXOpen::Tooling::EWDraftingBuilder::SetNameRule ( const NXString nameRule)

Sets the name rule used to create drafting part.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
nameRulenamerule
void NXOpen::Tooling::EWDraftingBuilder::SetNameRule ( const char *  nameRule)

Sets the name rule used to create drafting part.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
nameRulenamerule
void NXOpen::Tooling::EWDraftingBuilder::SetOrdinateDimension ( bool  ordinateDimension)

Sets the option used to set ordinate dimension.


Created in NX11.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
ordinateDimensionordinatedimension
void NXOpen::Tooling::EWDraftingBuilder::SetOutputPDF ( bool  outputPDF)

Sets the option used to output pdf file when creating drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
outputPDFoutputpdf
void NXOpen::Tooling::EWDraftingBuilder::SetOutputSameSheet ( bool  outputSameSheet)

Sets the option used to output all the blanks in the same sheet.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
outputSameSheetoutputsamesheet
void NXOpen::Tooling::EWDraftingBuilder::SetRenameComponent ( bool  renameComponent)

Sets the option used to rename the part which is created.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
renameComponentrenamecomponent
void NXOpen::Tooling::EWDraftingBuilder::SetSheetName ( NXOpen::Tooling::EWDraftingBuilder::NameOption  sheetName)

Sets the sheet name option used to edit drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
sheetNamesheetname
void NXOpen::Tooling::EWDraftingBuilder::SetUseInstance ( bool  useInstance)

Sets the option used to display and use instance of electrode to create drawing.


Created in NX9.0.2.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
useInstanceuseinstance
NXOpen::Tooling::EWDraftingBuilder::NameOption NXOpen::Tooling::EWDraftingBuilder::SheetName ( )

Returns the sheet name option used to edit drafting.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::EWDraftingBuilder::UseInstance ( )

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


Created in NX9.0.2.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.