ExportWeldBuilder Class¶
-
class
NXOpen.Weld.
ExportWeldBuilder
¶ Bases:
NXOpen.Builder
Represents a ExportWeldBuilder class
To create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateExportWeldBuilder()
Default values.
Property Value AttributeOrigin Object Output IntermediateFile New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AttributeOrigin | Returns or sets the option indicating where the attributes are read from, welding object or corresponding Design Feature. |
ConnectedPartAttrToggle | Returns or sets the connected part attribute toggle to control if read connected part attributes from weld points |
CsvFileName | Returns or sets the CSV file name |
Output | Returns or sets the option defining where to write the output data. |
Tag | Returns the Tag for this object. |
TemplateFileName | Returns or sets the template file name |
WeldPoints | Returns the weld points to be exported to CSV file |
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. |
GetConnectedPartAttributes | Get the connected part attributes of weld points |
GetExportedAttributes | Get the attributes of weld points to be exported to CSV file |
GetObject | Returns the object currently being edited by this builder. |
OpenFromFile | Open a template file to update exported attributes. |
ReadAttributesFromWelds | Read attributes from selected welds and save to exported attributes and connected part attributes |
RestoreDefault | Restore default template to update exported attributes. |
SaveAsDefault | Save exported attributes as default template. |
SaveToFile | Save exported attributes to a template file. |
SetConnectedPartAttributes | Set the connected part attributes of weld points |
SetExportedAttributes | Set the attributes of weld points to be exported to CSV file |
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¶
ExportWeldBuilderAttributeOriginType Enumeration | the Attribute Origin enum |
ExportWeldBuilderOutputType Enumeration | the Output Type enum |
Property Detail¶
AttributeOrigin¶
-
ExportWeldBuilder.
AttributeOrigin
¶ Returns or sets the option indicating where the attributes are read from, welding object or corresponding Design Feature.
-------------------------------------
Getter Method
Signature
AttributeOrigin
Returns: Return type: NXOpen.Weld.ExportWeldBuilderAttributeOriginType
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
-------------------------------------
Setter Method
Signature
AttributeOrigin
Parameters: attributeOrigin ( NXOpen.Weld.ExportWeldBuilderAttributeOriginType
) –New in version NX10.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
ConnectedPartAttrToggle¶
-
ExportWeldBuilder.
ConnectedPartAttrToggle
¶ Returns or sets the connected part attribute toggle to control if read connected part attributes from weld points
-------------------------------------
Getter Method
Signature
ConnectedPartAttrToggle
Returns: Connected part attribute toggle value Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ConnectedPartAttrToggle
Parameters: connectedPartAttrToggle (bool) – Connected part attribute toggle value New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CsvFileName¶
-
ExportWeldBuilder.
CsvFileName
¶ Returns or sets the CSV file name
-------------------------------------
Getter Method
Signature
CsvFileName
Returns: CSV file name Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CsvFileName
Parameters: csvFileName (str) – CSV file name New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
Output¶
-
ExportWeldBuilder.
Output
¶ Returns or sets the option defining where to write the output data.
Data will be written to either a comma separated value file or the output window.
-------------------------------------
Getter Method
Signature
Output
Returns: Return type: NXOpen.Weld.ExportWeldBuilderOutputType
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
Output
Parameters: outputType ( NXOpen.Weld.ExportWeldBuilderOutputType
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
TemplateFileName¶
-
ExportWeldBuilder.
TemplateFileName
¶ Returns or sets the template file name
-------------------------------------
Getter Method
Signature
TemplateFileName
Returns: Template file name Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
TemplateFileName
Parameters: templateFileName (str) – Template file name New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
WeldPoints¶
-
ExportWeldBuilder.
WeldPoints
¶ Returns the weld points to be exported to CSV file
-------------------------------------
Getter Method
Signature
WeldPoints
Returns: Selected weld points list Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
Method Detail¶
GetConnectedPartAttributes¶
-
ExportWeldBuilder.
GetConnectedPartAttributes
¶ Get the connected part attributes of weld points
Signature
GetConnectedPartAttributes()
Returns: Connected part attributes string Return type: list of str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
GetExportedAttributes¶
-
ExportWeldBuilder.
GetExportedAttributes
¶ Get the attributes of weld points to be exported to CSV file
Signature
GetExportedAttributes()
Returns: Exported attributes string Return type: list of str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
OpenFromFile¶
-
ExportWeldBuilder.
OpenFromFile
¶ Open a template file to update exported attributes.
Before use it, you must set template file name.
Signature
OpenFromFile()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ReadAttributesFromWelds¶
-
ExportWeldBuilder.
ReadAttributesFromWelds
¶ Read attributes from selected welds and save to exported attributes and connected part attributes
Signature
ReadAttributesFromWelds()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
RestoreDefault¶
-
ExportWeldBuilder.
RestoreDefault
¶ Restore default template to update exported attributes.
Before use it, you must set template file name.
Signature
RestoreDefault()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SaveAsDefault¶
-
ExportWeldBuilder.
SaveAsDefault
¶ Save exported attributes as default template.
Before use it, you must set template file name.
Signature
SaveAsDefault()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SaveToFile¶
-
ExportWeldBuilder.
SaveToFile
¶ Save exported attributes to a template file.
Before use it, you must set template file name.
Signature
SaveToFile()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetConnectedPartAttributes¶
-
ExportWeldBuilder.
SetConnectedPartAttributes
¶ Set the connected part attributes of weld points
Signature
SetConnectedPartAttributes(connectedPartAttributes)
Parameters: connectedPartAttributes (list of str) – Connected part attributes string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetExportedAttributes¶
-
ExportWeldBuilder.
SetExportedAttributes
¶ Set the attributes of weld points to be exported to CSV file
Signature
SetExportedAttributes(exportedAttributes)
Parameters: exportedAttributes (list of str) – Exported attributes string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
Validate¶
-
ExportWeldBuilder.
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.