InformationBuilder Class¶
-
class
NXOpen.Weld.
InformationBuilder
¶ Bases:
NXOpen.Builder
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 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AttributeOrigin | Returns or sets the option indicating where the attributes are read from, welding object or corresponding Design Feature. |
FabricationObjects | Returns the list of weld fabrication objects to create the output. |
OutputAttributes | Returns or sets the option to specify if the weld attributes should be included in the output. |
OutputLengthAndVolume | Returns or sets the option to specify if the weld length and volume should be calculated for the output. |
Tag | Returns the Tag for this object. |
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. |
GetObject | Returns the object currently being edited by this builder. |
GetTotalLength | Get the total length of the selection weld objects. |
GetTotalVolume | Get the total volume of the selection weld objects. |
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¶
InformationBuilderAttributeOriginType Enumeration | the Object Type enum |
Property Detail¶
AttributeOrigin¶
-
InformationBuilder.
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.InformationBuilderAttributeOriginType
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
-------------------------------------
Setter Method
Signature
AttributeOrigin(attributeOrigin)
Parameters: attributeOrigin ( NXOpen.Weld.InformationBuilderAttributeOriginType
) –New in version NX10.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
FabricationObjects¶
-
InformationBuilder.
FabricationObjects
¶ Returns the list of weld fabrication objects to create the output.
-------------------------------------
Getter Method
Signature
FabricationObjects()
Returns: Selected weld objects list Return type: NXOpen.SelectNXObjectList
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
OutputAttributes¶
-
InformationBuilder.
OutputAttributes
¶ Returns or sets the option to specify if the weld attributes should be included in the output.
-------------------------------------
Getter Method
Signature
OutputAttributes()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
-------------------------------------
Setter Method
Signature
OutputAttributes(outputAttributes)
Parameters: outputAttributes (bool) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
OutputLengthAndVolume¶
-
InformationBuilder.
OutputLengthAndVolume
¶ Returns or sets the option to specify if the weld length and volume should be calculated for the output.
-------------------------------------
Getter Method
Signature
OutputLengthAndVolume()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
-------------------------------------
Setter Method
Signature
OutputLengthAndVolume(outputLengthAndVolume)
Parameters: outputLengthAndVolume (bool) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
Method Detail¶
GetTotalLength¶
-
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.
Signature
GetTotalLength()
Returns: Return type: float New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
GetTotalVolume¶
-
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.
Signature
GetTotalVolume()
Returns: Return type: float New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
Validate¶
-
InformationBuilder.
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.