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

This class is used by "Fabrication Information" to output fabrication objects information. More...

Inheritance diagram for NXOpen::Weld::InformationBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AttributeOriginType { AttributeOriginTypeObject, AttributeOriginTypeDf }
 the Object Type enum More...
 

Public Member Functions

NXOpen::Weld::InformationBuilder::AttributeOriginType AttributeOrigin ()
 Returns the option indicating where the attributes are read from, welding object or corresponding Design Feature. More...
 
bool ConnectedToInformation ()
 Returns the option to specify if the connected to information should be displayed in the output. More...
 
NXOpen::SelectNXObjectListFabricationObjects ()
 Returns the list of weld fabrication objects to create the output. More...
 
double GetTotalLength ()
 Get the total length of the selection weld objects. More...
 
double GetTotalVolume ()
 Get the total volume of the selection weld objects. More...
 
bool OutputAttributes ()
 Returns the option to specify if the weld attributes should be included in the output. More...
 
bool OutputLengthAndVolume ()
 Returns the option to specify if the weld length and volume should be calculated for the output. More...
 
void SetAttributeOrigin (NXOpen::Weld::InformationBuilder::AttributeOriginType attributeOrigin)
 Sets the option indicating where the attributes are read from, welding object or corresponding Design Feature. More...
 
void SetConnectedToInformation (bool connectedToInformation)
 Sets the option to specify if the connected to information should be displayed in the output. More...
 
void SetOutputAttributes (bool outputAttributes)
 Sets the option to specify if the weld attributes should be included in the output. More...
 
void SetOutputLengthAndVolume (bool outputLengthAndVolume)
 Sets the option to specify if the weld length and volume should be calculated for the output. 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

This class is used by "Fabrication Information" to output fabrication objects information.

When commit is called, attributes and total weld length and volume of selected objects will be output into a list window. No objects are returned when Commit is called.
To create a new instance of this class, use NXOpen::Weld::WeldManager::CreateInformationBuilder
Default values.

Property Value

AttributeOrigin

Object

OutputAttributes

1

OutputLengthAndVolume

0


Created in NX9.0.0.

Member Enumeration Documentation

the Object Type enum

Enumerator
AttributeOriginTypeObject 

object

AttributeOriginTypeDf 

df

Member Function Documentation

NXOpen::Weld::InformationBuilder::AttributeOriginType NXOpen::Weld::InformationBuilder::AttributeOrigin ( )

Returns the option indicating where the attributes are read from, welding object or corresponding Design Feature.


Created in NX10.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

bool NXOpen::Weld::InformationBuilder::ConnectedToInformation ( )

Returns the option to specify if the connected to information should be displayed in the output.


Created in NX11.0.1.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

NXOpen::SelectNXObjectList* NXOpen::Weld::InformationBuilder::FabricationObjects ( )

Returns the list of weld fabrication objects to create the output.


Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

double NXOpen::Weld::InformationBuilder::GetTotalLength ( )

Get the total length of the selection weld objects.

This function may be time intensive and should be used after all weld data has been defined.

Returns

Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")
double NXOpen::Weld::InformationBuilder::GetTotalVolume ( )

Get the total volume of the selection weld objects.

This function may be time intensive and should be used after all weld data has been defined.

Returns

Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")
bool NXOpen::Weld::InformationBuilder::OutputAttributes ( )

Returns the option to specify if the weld attributes should be included in the output.


Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

bool NXOpen::Weld::InformationBuilder::OutputLengthAndVolume ( )

Returns the option to specify if the weld length and volume should be calculated for the output.


Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

void NXOpen::Weld::InformationBuilder::SetAttributeOrigin ( NXOpen::Weld::InformationBuilder::AttributeOriginType  attributeOrigin)

Sets the option indicating where the attributes are read from, welding object or corresponding Design Feature.


Created in NX10.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters
attributeOriginattributeorigin
void NXOpen::Weld::InformationBuilder::SetConnectedToInformation ( bool  connectedToInformation)

Sets the option to specify if the connected to information should be displayed in the output.


Created in NX11.0.1.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters
connectedToInformationconnectedtoinformation
void NXOpen::Weld::InformationBuilder::SetOutputAttributes ( bool  outputAttributes)

Sets the option to specify if the weld attributes should be included in the output.


Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters
outputAttributesoutputattributes
void NXOpen::Weld::InformationBuilder::SetOutputLengthAndVolume ( bool  outputLengthAndVolume)

Sets the option to specify if the weld length and volume should be calculated for the output.


Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters
outputLengthAndVolumeoutputlengthandvolume

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