MassPropertiesBuilder Class¶
-
class
NXOpen.MassPropertiesBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.MassPropertiesBuilderfor calculating the weight of selected objects as well as informing the part that the assemblies weight property data needs to be updated on save.To create a new instance of this class, use
NXOpen.PropertiesManager.CreateMassPropertiesBuilder()Default values.
Property Value UpdateOnSave No New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| Accuracy | Returns or sets the accuracy used for weight calculation during Update Now. |
| LoadPartialComponents | Returns or sets the load partial components flag. |
| SelectedObjects | Returns the selected objects list. |
| Tag | Returns the Tag for this object. |
| UpdateOnSave | Returns or sets the update on save option. |
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. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpdateNow | This will update the weight property of the selected objects immediately. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| MassPropertiesBuilderUpdateOptions Enumeration | Specifies the Update on Save option that will be applied to all selected objects. |
Property Detail¶
Accuracy¶
-
MassPropertiesBuilder.Accuracy¶ Returns or sets the accuracy used for weight calculation during Update Now.
-------------------------------------Getter Method
Signature
AccuracyReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AccuracyParameters: accuracy (float) – New in version NX8.0.0.
License requirements: None.
LoadPartialComponents¶
-
MassPropertiesBuilder.LoadPartialComponents¶ Returns or sets the load partial components flag.
This flag specifies whether partially loaded components will be fully loaded so the Update on Save setting can be applied to all parts. The commit may take longer if this flag is turned on.
-------------------------------------Getter Method
Signature
LoadPartialComponentsReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LoadPartialComponentsParameters: loadPartialComponents (bool) – New in version NX8.0.0.
License requirements: None.
SelectedObjects¶
-
MassPropertiesBuilder.SelectedObjects¶ Returns the selected objects list.
-------------------------------------Getter Method
Signature
SelectedObjectsReturns: Return type: NXOpen.SelectNXObjectListNew in version NX8.0.0.
License requirements: None.
UpdateOnSave¶
-
MassPropertiesBuilder.UpdateOnSave¶ Returns or sets the update on save option.
This option informs the part if it should update the assemblies weight property on save and will be applied to all fully loaded parts contained in the parts list. The option will be applied to all partially loaded parts as well if the Load Partial Components option is set to true.
-------------------------------------Getter Method
Signature
UpdateOnSaveReturns: Return type: NXOpen.MassPropertiesBuilderUpdateOptionsNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UpdateOnSaveParameters: updateOption ( NXOpen.MassPropertiesBuilderUpdateOptions) –New in version NX8.0.0.
License requirements: None.
Method Detail¶
UpdateNow¶
-
MassPropertiesBuilder.UpdateNow¶ This will update the weight property of the selected objects immediately.
Signature
UpdateNow()New in version NX8.0.0.
License requirements: None.
Validate¶
-
MassPropertiesBuilder.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.