NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Tooling.ElectrodeEDMOutputBuilder Class Reference

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

Inheritance diagram for NXOpen.Tooling.ElectrodeEDMOutputBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  FileType { Txt, Xml }
 the attribute template file type More...
 
enum  NameOption { Template1, Template2 }
 the attribute template name option More...
 

Public Member Functions

unsafe void AnalyseAttributeTemplateData ()
 Analyse the attribute template data. More...
 
unsafe void CreateAttributeOutputFileName (NXOpen.TaggedObject blank)
 Create the attribute output file name. More...
 
unsafe string GetAttributeTemplateName ()
 Get the current attribute template file name. More...
 
unsafe void GetAttributeTemplateTitleNames (out string[] titleName)
 Get all the attribute template file names in template folder. More...
 
unsafe
NXOpen.Tooling.ElectrodeEDMOutputBuilder.FileType 
GetTemplateFileType ()
 Get the attribute template file type. More...
 
unsafe void PopulateAttributeTemplate (string attributeTemplateFolder)
 Populate the attribute template file. More...
 
unsafe void SetAttributeTemplateName (string attributeTemplateName)
 Set the attribute template file name. More...
 
unsafe void SetTemplateFileType (string attributeTemplateName)
 Set the attribute template file type. More...
 
unsafe void UpdateEwBlankAttributes ()
 Update blank attributes. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Tooling.ElectrodeEDMOutputBuilder.NameOption 
AttributeTemplate [get, set]
 Returns or sets the attribute template option. More...
 
unsafe
NXOpen.Assemblies.SelectComponentList 
Blank [get]
 Returns the blank to be edited. More...
 
unsafe string InputName [get, set]
 Returns or sets the input name as project name. More...
 
unsafe bool MultipleFile [get, set]
 Returns or sets the option that allow user output multiple files for each blank. More...
 
unsafe string NameRule [get, set]
 Returns or sets the name rule used to create output file. More...
 
unsafe string OutputFileFolderNames [get, set]
 Returns or sets the output file path browser. More...
 
unsafe bool ReplaceOption [get, set]
 Returns or sets the option that allow user replace the existing file. More...
 
unsafe string TemplateFolderNames [get, set]
 Returns or sets the template path browser. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

the attribute template file type

Enumerator
Txt 

text document

Xml 

XML document

the attribute template name option

Enumerator
Template1 

template1 name

Template2 

template2 name

Member Function Documentation

unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.AnalyseAttributeTemplateData ( )
inline

Analyse the attribute template data.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.CreateAttributeOutputFileName ( NXOpen.TaggedObject  blank)
inline

Create the attribute output file name.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

Parameters
blankthe first selected blank
unsafe string NXOpen.Tooling.ElectrodeEDMOutputBuilder.GetAttributeTemplateName ( )
inline

Get the current attribute template file name.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

Returns
unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.GetAttributeTemplateTitleNames ( out string[]  titleName)
inline

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
unsafe NXOpen.Tooling.ElectrodeEDMOutputBuilder.FileType NXOpen.Tooling.ElectrodeEDMOutputBuilder.GetTemplateFileType ( )
inline

Get the attribute template file type.

Created in NX12.0.1

License requirements: None.

Returns
unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.PopulateAttributeTemplate ( string  attributeTemplateFolder)
inline

Populate the attribute template file.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

Parameters
attributeTemplateFolder
unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.SetAttributeTemplateName ( string  attributeTemplateName)
inline

Set the attribute template file name.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

Parameters
attributeTemplateName
unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.SetTemplateFileType ( string  attributeTemplateName)
inline

Set the attribute template file type.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

Parameters
attributeTemplateName
unsafe void NXOpen.Tooling.ElectrodeEDMOutputBuilder.UpdateEwBlankAttributes ( )
inline

Update blank attributes.

Created in NX12.0.1

License requirements: nx_electrode_wizard ("NX Electrode Wizard")

Property Documentation

unsafe NXOpen.Tooling.ElectrodeEDMOutputBuilder.NameOption NXOpen.Tooling.ElectrodeEDMOutputBuilder.AttributeTemplate
getset

Returns or sets the attribute template option.

Created in NX12.0.1

License requirements to get this property: None.

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")

unsafe NXOpen.Assemblies.SelectComponentList NXOpen.Tooling.ElectrodeEDMOutputBuilder.Blank
get

Returns the blank to be edited.

Created in NX12.0.1

License requirements: None.

unsafe string NXOpen.Tooling.ElectrodeEDMOutputBuilder.InputName
getset

Returns or sets the input name as project name.

Created in NX12.0.1

License requirements to get this property: nx_electrode_wizard ("NX Electrode Wizard")

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")

unsafe bool NXOpen.Tooling.ElectrodeEDMOutputBuilder.MultipleFile
getset

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

Created in NX12.0.1

License requirements to get this property: nx_electrode_wizard ("NX Electrode Wizard")

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")

unsafe string NXOpen.Tooling.ElectrodeEDMOutputBuilder.NameRule
getset

Returns or sets the name rule used to create output file.

Created in NX12.0.1

License requirements to get this property: nx_electrode_wizard ("NX Electrode Wizard")

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")

unsafe string NXOpen.Tooling.ElectrodeEDMOutputBuilder.OutputFileFolderNames
getset

Returns or sets the output file path browser.

Created in NX12.0.1

License requirements to get this property: nx_electrode_wizard ("NX Electrode Wizard")

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")

unsafe bool NXOpen.Tooling.ElectrodeEDMOutputBuilder.ReplaceOption
getset

Returns or sets the option that allow user replace the existing file.

Created in NX12.0.1

License requirements to get this property: nx_electrode_wizard ("NX Electrode Wizard")

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")

unsafe string NXOpen.Tooling.ElectrodeEDMOutputBuilder.TemplateFolderNames
getset

Returns or sets the template path browser.

Created in NX12.0.1

License requirements to get this property: nx_electrode_wizard ("NX Electrode Wizard")

License requirements to set this property: nx_electrode_wizard ("NX Electrode Wizard")


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