Design electrode attribute transport builder to input and output an electrode attribute. More...

Inheritance diagram for NXOpen::Tooling::ElectrodeEDMOutputBuilder:

Public Types
enum	FileType { FileTypeTxt, FileTypeXml }
	the attribute template file type More...

enum	NameOption { NameOptionTemplate1, NameOptionTemplate2 }
	the attribute template name option More...

Public Member Functions
void	AnalyseAttributeTemplateData ()
	Analyse the attribute template data. More...

NXOpen::Tooling::ElectrodeEDMOutputBuilder::NameOption	AttributeTemplate ()
	Returns the attribute template option. More...

NXOpen::Assemblies::SelectComponentList *	Blank ()
	Returns the blank to be edited. More...

void	CreateAttributeOutputFileName (NXOpen::TaggedObject *blank)
	Create the attribute output file name. More...

NXString	GetAttributeTemplateName ()
	Get the current attribute template file name. More...

void	GetAttributeTemplateTitleNames (std::vector< NXString > &titleName)
	Get all the attribute template file names in template folder. More...

NXOpen::Tooling::ElectrodeEDMOutputBuilder::FileType	GetTemplateFileType ()
	Get the attribute template file type. More...

NXString	InputName ()
	Returns the input name as project name. More...

bool	MultipleFile ()
	Returns the option that allow user output multiple files for each blank. More...

NXString	NameRule ()
	Returns the name rule used to create output file. More...

NXString	OutputFileFolderNames ()
	Returns the output file path browser. More...

void	PopulateAttributeTemplate (const NXString &attributeTemplateFolder)
	Populate the attribute template file. More...

void	PopulateAttributeTemplate (const char *attributeTemplateFolder)
	Populate the attribute template file. More...

bool	ReplaceOption ()
	Returns the option that allow user replace the existing file. More...

void	SetAttributeTemplate (NXOpen::Tooling::ElectrodeEDMOutputBuilder::NameOption attributeTemplate)
	Sets the attribute template option. More...

void	SetAttributeTemplateName (const NXString &attributeTemplateName)
	Set the attribute template file name. More...

void	SetAttributeTemplateName (const char *attributeTemplateName)
	Set the attribute template file name. More...

void	SetInputName (const NXString &inputName)
	Sets the input name as project name. More...

void	SetInputName (const char *inputName)
	Sets the input name as project name. More...

void	SetMultipleFile (bool multipleFile)
	Sets the option that allow user output multiple files for each blank. More...

void	SetNameRule (const NXString &nameRule)
	Sets the name rule used to create output file. More...

void	SetNameRule (const char *nameRule)
	Sets the name rule used to create output file. More...

void	SetOutputFileFolderNames (const NXString &foldername)
	Sets the output file path browser. More...

void	SetOutputFileFolderNames (const char *foldername)
	Sets the output file path browser. More...

void	SetReplaceOption (bool replaceOption)
	Sets the option that allow user replace the existing file. More...

void	SetTemplateFileType (const NXString &attributeTemplateName)
	Set the attribute template file type. More...

void	SetTemplateFileType (const char *attributeTemplateName)
	Set the attribute template file type. More...

void	SetTemplateFolderNames (const NXString &foldername)
	Sets the template path browser. More...

void	SetTemplateFolderNames (const char *foldername)
	Sets the template path browser. More...

NXString	TemplateFolderNames ()
	Returns the template path browser. More...

void	UpdateEwBlankAttributes ()
	Update blank attributes. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

Design electrode attribute transport builder to input and output an electrode attribute.

To create a new instance of this class, use NXOpen::Tooling::ElectrodeDesignCollection::CreateEDMOutputBuilder
Default values.

Property

Value

AttributeTemplate

Template1

InputName

Template1

MultipleFile

0

ReplaceOption

1

Created in NX12.0.1.

Member Enumeration Documentation

enum NXOpen::Tooling::ElectrodeEDMOutputBuilder::FileType

the attribute template file type

Enumerator
FileTypeTxt	text document
FileTypeXml	XML document.

enum NXOpen::Tooling::ElectrodeEDMOutputBuilder::NameOption

the attribute template name option

Enumerator
NameOptionTemplate1	template1 name
NameOptionTemplate2	template2 name

Member Function Documentation

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::AnalyseAttributeTemplateData ( )

Analyse the attribute template data.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::Tooling::ElectrodeEDMOutputBuilder::NameOption NXOpen::Tooling::ElectrodeEDMOutputBuilder::AttributeTemplate ( )

Returns the attribute template option.

Created in NX12.0.1.

License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Tooling::ElectrodeEDMOutputBuilder::Blank ( )

Returns the blank to be edited.

Created in NX12.0.1.

License requirements : None

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::CreateAttributeOutputFileName ( NXOpen::TaggedObject * blank )

Create the attribute output file name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

blank the first selected blank

NXString NXOpen::Tooling::ElectrodeEDMOutputBuilder::GetAttributeTemplateName ( )

Get the current attribute template file name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::GetAttributeTemplateTitleNames ( std::vector< NXString > & titleName )

Get all the attribute template file names in template folder.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

titleName titlename

NXOpen::Tooling::ElectrodeEDMOutputBuilder::FileType NXOpen::Tooling::ElectrodeEDMOutputBuilder::GetTemplateFileType ( )

Get the attribute template file type.

Created in NX12.0.1.

License requirements : None

NXString NXOpen::Tooling::ElectrodeEDMOutputBuilder::InputName ( )

Returns the input name as project name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

bool NXOpen::Tooling::ElectrodeEDMOutputBuilder::MultipleFile ( )

Returns the option that allow user output multiple files for each blank.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXString NXOpen::Tooling::ElectrodeEDMOutputBuilder::NameRule ( )

Returns the name rule used to create output file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXString NXOpen::Tooling::ElectrodeEDMOutputBuilder::OutputFileFolderNames ( )

Returns the output file path browser.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::PopulateAttributeTemplate ( const NXString & attributeTemplateFolder )

Populate the attribute template file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplateFolder attributetemplatefolder

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::PopulateAttributeTemplate ( const char * attributeTemplateFolder )

Populate the attribute template file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplateFolder attributetemplatefolder

bool NXOpen::Tooling::ElectrodeEDMOutputBuilder::ReplaceOption ( )

Returns the option that allow user replace the existing file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetAttributeTemplate ( NXOpen::Tooling::ElectrodeEDMOutputBuilder::NameOption attributeTemplate )

Sets the attribute template option.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplate attributetemplate

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetAttributeTemplateName ( const NXString & attributeTemplateName )

Set the attribute template file name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplateName attributetemplatename

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetAttributeTemplateName ( const char * attributeTemplateName )

Set the attribute template file name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplateName attributetemplatename

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetInputName ( const NXString & inputName )

Sets the input name as project name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

inputName inputname

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetInputName ( const char * inputName )

Sets the input name as project name.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

inputName inputname

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetMultipleFile ( bool multipleFile )

Sets the option that allow user output multiple files for each blank.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

multipleFile multiplefile

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetNameRule ( const NXString & nameRule )

Sets the name rule used to create output file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

nameRule namerule

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetNameRule ( const char * nameRule )

Sets the name rule used to create output file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

nameRule namerule

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetOutputFileFolderNames ( const NXString & foldername )

Sets the output file path browser.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

foldername foldername

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetOutputFileFolderNames ( const char * foldername )

Sets the output file path browser.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

foldername foldername

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetReplaceOption ( bool replaceOption )

Sets the option that allow user replace the existing file.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

replaceOption replaceoption

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetTemplateFileType ( const NXString & attributeTemplateName )

Set the attribute template file type.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplateName attributetemplatename

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetTemplateFileType ( const char * attributeTemplateName )

Set the attribute template file type.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

attributeTemplateName attributetemplatename

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetTemplateFolderNames ( const NXString & foldername )

Sets the template path browser.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

foldername foldername

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::SetTemplateFolderNames ( const char * foldername )

Sets the template path browser.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters

foldername foldername

NXString NXOpen::Tooling::ElectrodeEDMOutputBuilder::TemplateFolderNames ( )

Returns the template path browser.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeEDMOutputBuilder::UpdateEwBlankAttributes ( )

Update blank attributes.

Created in NX12.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

The documentation for this class was generated from the following file:

Tooling_ElectrodeEDMOutputBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation