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

Represents a NXOpen::MassPropertiesBuilder for calculating the weight of selected objects as well as informing the part that the assemblies weight property data needs to be updated on save. More...

Inheritance diagram for NXOpen::MassPropertiesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  UpdateOptions { UpdateOptionsNo, UpdateOptionsYes, UpdateOptionsMixed }
 Specifies the Update on Save option that will be applied to all selected objects. More...
 

Public Member Functions

double Accuracy ()
 Returns the accuracy used for weight calculation during Update Now. More...
 
bool LoadPartialComponents ()
 Returns the load partial components flag. More...
 
NXOpen::SelectNXObjectListSelectedObjects ()
 Returns the selected objects list. More...
 
void SetAccuracy (double accuracy)
 Sets the accuracy used for weight calculation during Update Now. More...
 
void SetLoadPartialComponents (bool loadPartialComponents)
 Sets the load partial components flag. More...
 
void SetUpdateOnSave (NXOpen::MassPropertiesBuilder::UpdateOptions updateOption)
 Sets the update on save option. More...
 
void UpdateNow ()
 This will update the weight property of the selected objects immediately. More...
 
NXOpen::MassPropertiesBuilder::UpdateOptions UpdateOnSave ()
 Returns the update on save option. 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

Represents a NXOpen::MassPropertiesBuilder for 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


Created in NX8.0.0.

Member Enumeration Documentation

Specifies the Update on Save option that will be applied to all selected objects.

Enumerator
UpdateOptionsNo 

The Update on Save property will be turned off for all selected objects.

UpdateOptionsYes 

The Update on Save property will be turned on for all selected objects.

UpdateOptionsMixed 

The Update on Save property will not change for the selected objects.

Member Function Documentation

double NXOpen::MassPropertiesBuilder::Accuracy ( )

Returns the accuracy used for weight calculation during Update Now.


Created in NX8.0.0.

License requirements : None

bool NXOpen::MassPropertiesBuilder::LoadPartialComponents ( )

Returns 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.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::MassPropertiesBuilder::SelectedObjects ( )

Returns the selected objects list.


Created in NX8.0.0.

License requirements : None

void NXOpen::MassPropertiesBuilder::SetAccuracy ( double  accuracy)

Sets the accuracy used for weight calculation during Update Now.


Created in NX8.0.0.

License requirements : None

Parameters
accuracyaccuracy
void NXOpen::MassPropertiesBuilder::SetLoadPartialComponents ( bool  loadPartialComponents)

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.
Created in NX8.0.0.

License requirements : None

Parameters
loadPartialComponentsloadpartialcomponents
void NXOpen::MassPropertiesBuilder::SetUpdateOnSave ( NXOpen::MassPropertiesBuilder::UpdateOptions  updateOption)

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.
Created in NX8.0.0.

License requirements : None

Parameters
updateOptionupdateoption
void NXOpen::MassPropertiesBuilder::UpdateNow ( )

This will update the weight property of the selected objects immediately.


Created in NX8.0.0.

License requirements : None

NXOpen::MassPropertiesBuilder::UpdateOptions NXOpen::MassPropertiesBuilder::UpdateOnSave ( )

Returns 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.
Created in NX8.0.0.

License requirements : None


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