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

Represents a ExportWeldBuilder class  <br> To create a new instance of this class, use @link Weld::WeldManager::CreateExportWeldBuilder  Weld::WeldManager::CreateExportWeldBuilder @endlink  <br> 

Default values. More...

Inheritance diagram for NXOpen::Weld::ExportWeldBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Weld::ExportWeldJointBuilder

Public Types

enum  OutputType { OutputTypeIntermediateFile, OutputTypeInformationWindow }
 the Output Type enum More...
 

Public Member Functions

bool ConnectedPartAttrToggle ()
 Returns the connected part attribute toggle to control if read connected part attributes from weld points
Created in NX6.0.0.
 
NXString CsvFileName ()
 Returns the CSV file name
Created in NX6.0.0.
 
std::vector< NXStringGetConnectedPartAttributes ()
 Get the connected part attributes of weld points.
 
std::vector< NXStringGetExportedAttributes ()
 Get the attributes of weld points to be exported to CSV file.
 
void OpenFromFile ()
 Open a template file to update exported attributes.
 
NXOpen::Weld::ExportWeldBuilder::OutputType Output ()
 Returns the option defining where to write the output data.
 
void ReadAttributesFromWelds ()
 Read attributes from selected welds and save to exported attributes and connected part attributes
Created in NX6.0.0.
 
void RestoreDefault ()
 Restore default template to update exported attributes.
 
void SaveAsDefault ()
 Save exported attributes as default template.
 
void SaveToFile ()
 Save exported attributes to a template file.
 
void SetConnectedPartAttributes (std::vector< NXString > &connectedPartAttributes)
 Set the connected part attributes of weld points
Created in NX6.0.0.
 
void SetConnectedPartAttrToggle (bool connectedPartAttrToggle)
 Sets the connected part attribute toggle to control if read connected part attributes from weld points
Created in NX6.0.0.
 
void SetCsvFileName (const NXString &csvFileName)
 Sets the CSV file name
Created in NX6.0.0.
 
void SetCsvFileName (const char *csvFileName)
 Sets the CSV file name
Created in NX6.0.0.
 
void SetExportedAttributes (std::vector< NXString > &exportedAttributes)
 Set the attributes of weld points to be exported to CSV file
Created in NX6.0.0.
 
void SetOutput (NXOpen::Weld::ExportWeldBuilder::OutputType outputType)
 Sets the option defining where to write the output data.
 
void SetTemplateFileName (const NXString &templateFileName)
 Sets the template file name
Created in NX6.0.0.
 
void SetTemplateFileName (const char *templateFileName)
 Sets the template file name
Created in NX6.0.0.
 
NXString TemplateFileName ()
 Returns the template file name
Created in NX6.0.0.
 
NXOpen::SelectNXObjectListWeldPoints ()
 Returns the weld points to be exported to CSV file
Created in NX6.0.0.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a ExportWeldBuilder class  <br> To create a new instance of this class, use @link Weld::WeldManager::CreateExportWeldBuilder  Weld::WeldManager::CreateExportWeldBuilder @endlink  <br> 

Default values.

Property Value

Output

IntermediateFile


Created in NX6.0.0.

Member Enumeration Documentation

the Output Type enum

Enumerator:
OutputTypeIntermediateFile 

intermediate file

OutputTypeInformationWindow 

information window

Member Function Documentation

bool NXOpen::Weld::ExportWeldBuilder::ConnectedPartAttrToggle ( )

Returns the connected part attribute toggle to control if read connected part attributes from weld points
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

NXString NXOpen::Weld::ExportWeldBuilder::CsvFileName ( )

Returns the CSV file name
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

std::vector<NXString> NXOpen::Weld::ExportWeldBuilder::GetConnectedPartAttributes ( )

Get the connected part attributes of weld points.

Returns
Connected part attributes string
Created in NX6.0.0.

License requirements : ugweld ("UG WELD")
std::vector<NXString> NXOpen::Weld::ExportWeldBuilder::GetExportedAttributes ( )

Get the attributes of weld points to be exported to CSV file.

Returns
Exported attributes string
Created in NX6.0.0.

License requirements : ugweld ("UG WELD")
void NXOpen::Weld::ExportWeldBuilder::OpenFromFile ( )

Open a template file to update exported attributes.

Before use it, you must set template file name.
Created in NX6.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Weld::ExportWeldBuilder::OutputType NXOpen::Weld::ExportWeldBuilder::Output ( )

Returns the option defining where to write the output data.

Data will be written to either a comma seperated value file or the output window.
Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

void NXOpen::Weld::ExportWeldBuilder::ReadAttributesFromWelds ( )

Read attributes from selected welds and save to exported attributes and connected part attributes
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

void NXOpen::Weld::ExportWeldBuilder::RestoreDefault ( )

Restore default template to update exported attributes.

Before use it, you must set template file name.
Created in NX6.0.0.

License requirements : ugweld ("UG WELD")

void NXOpen::Weld::ExportWeldBuilder::SaveAsDefault ( )

Save exported attributes as default template.

Before use it, you must set template file name.
Created in NX6.0.0.

License requirements : ugweld ("UG WELD")

void NXOpen::Weld::ExportWeldBuilder::SaveToFile ( )

Save exported attributes to a template file.

Before use it, you must set template file name.
Created in NX6.0.0.

License requirements : ugweld ("UG WELD")

void NXOpen::Weld::ExportWeldBuilder::SetConnectedPartAttributes ( std::vector< NXString > &  connectedPartAttributes)

Set the connected part attributes of weld points
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
connectedPartAttributesConnected part attributes string
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Weld::ExportWeldBuilder::SetConnectedPartAttrToggle ( bool  connectedPartAttrToggle)

Sets the connected part attribute toggle to control if read connected part attributes from weld points
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
connectedPartAttrToggleConnected part attribute toggle value
void NXOpen::Weld::ExportWeldBuilder::SetCsvFileName ( const NXString csvFileName)

Sets the CSV file name
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
csvFileNameCSV file name
void NXOpen::Weld::ExportWeldBuilder::SetCsvFileName ( const char *  csvFileName)

Sets the CSV file name
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
csvFileNameCSV file name
void NXOpen::Weld::ExportWeldBuilder::SetExportedAttributes ( std::vector< NXString > &  exportedAttributes)

Set the attributes of weld points to be exported to CSV file
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
exportedAttributesExported attributes string
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Weld::ExportWeldBuilder::SetOutput ( NXOpen::Weld::ExportWeldBuilder::OutputType  outputType)

Sets the option defining where to write the output data.

Data will be written to either a comma seperated value file or the output window.
Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters
outputTypeoutputtype
void NXOpen::Weld::ExportWeldBuilder::SetTemplateFileName ( const NXString templateFileName)

Sets the template file name
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
templateFileNameTemplate file name
void NXOpen::Weld::ExportWeldBuilder::SetTemplateFileName ( const char *  templateFileName)

Sets the template file name
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

Parameters
templateFileNameTemplate file name
NXString NXOpen::Weld::ExportWeldBuilder::TemplateFileName ( )

Returns the template file name
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")

NXOpen::SelectNXObjectList* NXOpen::Weld::ExportWeldBuilder::WeldPoints ( )

Returns the weld points to be exported to CSV file
Created in NX6.0.0.



License requirements : ugweld ("UG WELD")


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