UpdateStructureBuilder Class¶
-
class
NXOpen.Assemblies.
UpdateStructureBuilder
¶ Bases:
NXOpen.Builder
Represents a builder
NXOpen.Assemblies.UpdateStructureBuilder
.To create a new instance of this class, use
NXOpen.Assemblies.AssemblyManager.CreateUpdateStructureBuilder()
Default values.
Property Value IsUpdateAllLevels 1 NumberOfLevels 1 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
IsUpdateAllLevels | Returns or sets the all level toggled on for updating the assembly structure. |
NumberOfLevels | Returns or sets the particular selected level for updating the structure. |
StructureToUpdate | Returns the component selection of the Assembly structure to Update. |
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. |
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. |
Property Detail¶
IsUpdateAllLevels¶
-
UpdateStructureBuilder.
IsUpdateAllLevels
¶ Returns or sets the all level toggled on for updating the assembly structure.
-------------------------------------
Getter Method
Signature
IsUpdateAllLevels
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsUpdateAllLevels
Parameters: isUpdateAllLevels (bool) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
NumberOfLevels¶
-
UpdateStructureBuilder.
NumberOfLevels
¶ Returns or sets the particular selected level for updating the structure.
-------------------------------------
Getter Method
Signature
NumberOfLevels
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfLevels
Parameters: numberOfLevels (int) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
StructureToUpdate¶
-
UpdateStructureBuilder.
StructureToUpdate
¶ Returns the component selection of the Assembly structure to Update.
-------------------------------------
Getter Method
Signature
StructureToUpdate
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
UpdateStructureBuilder.
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.