SmartSaveBuilder Class

class NXOpen.PDM.SmartSaveBuilder

Bases: NXOpen.Builder, NXOpen.IAttributeSourceObjectBuilder

TODO: Add a documentation comment describing this class.

The comment must be placed inside and should describe conceptually what this class represents or does. Don’t use a comment that just states something that would be obvious if the comment didn’t exist. Such comments add no value for the customer. To create a new instance of this class, use NXOpen.PDM.PdmSession.CreateSmartSaveBuilderWithContext()

New in version NX10.0.0.

Properties

Property Description
DebugDumpEnabled Returns or sets the debug dump enabled
Tag Returns the Tag for this object.
UseNewSortForDebug Returns or sets the new debug sort enabled

Methods

Method Description
AssignRemoveProjects Assign or remove projects to/from objects
AutoAssignAttributes Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
AutoAssignAttributesWithNamingPattern Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.
CanPerformDefaultSave Checks whether smart save operation can be performed with default operation type set
ClearValidationFailures Clears operation failures if any
Commit Commits any edits that have been applied to the builder.
CreateAttributeTitleToNamingPatternMap Creates a map object of attribute titles to their corresponding naming pattern
CreateSpecificationsForSmartSaveObjects Create new specifications for Logical Objects
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.
GetErrorMessageHandler Returns ErrorMessageHandler
GetObject Returns the object currently being edited by this builder.
GetOperationFailures Returns operation failures
GetSmartSaveObjects Gets the smart save objects for the modified objects in session.
OnOperationTypeChanged Updates the given smart save objects after operation type change.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateSmartSaveObjectsOnBuilder Updates the smart save objects with valid operation type and dependencies
Validate Validate whether the inputs to the component are sufficient for commit to be called.
ValidateSmartSaveObjects Validates whether the save operation can be performed on the smart save objects

Enumerations

SmartSaveBuilderSaveType Enumeration Represents an File Save type

Property Detail

DebugDumpEnabled

SmartSaveBuilder.DebugDumpEnabled

Returns or sets the debug dump enabled

-------------------------------------

Getter Method

Signature DebugDumpEnabled

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DebugDumpEnabled

Parameters:debugDumpEnabled (bool) –

New in version NX11.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

UseNewSortForDebug

SmartSaveBuilder.UseNewSortForDebug

Returns or sets the new debug sort enabled

-------------------------------------

Getter Method

Signature UseNewSortForDebug

Returns:
Return type:bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature UseNewSortForDebug

Parameters:useNewSortForDebug (bool) –

New in version NX11.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Method Detail

AssignRemoveProjects

SmartSaveBuilder.AssignRemoveProjects

Assign or remove projects to/from objects

Signature AssignRemoveProjects(smartSaveObjects, projectNames, assignmentStates)

Parameters:

New in version NX11.0.0.

License requirements: None.

AutoAssignAttributes

SmartSaveBuilder.AutoAssignAttributes

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Signature AutoAssignAttributes(objects)

Parameters:objects (list of NXOpen.NXObject) –
Returns:
Return type:NXOpen.ErrorList

New in version NX8.5.0.

License requirements: None.

AutoAssignAttributesWithNamingPattern

SmartSaveBuilder.AutoAssignAttributesWithNamingPattern

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap()

Signature AutoAssignAttributesWithNamingPattern(objects, properties)

Parameters:
Returns:
Return type:

NXOpen.ErrorList

New in version NX12.0.0.

License requirements: None.

CanPerformDefaultSave

SmartSaveBuilder.CanPerformDefaultSave

Checks whether smart save operation can be performed with default operation type set

Signature CanPerformDefaultSave()

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

ClearValidationFailures

SmartSaveBuilder.ClearValidationFailures

Clears operation failures if any

Signature ClearValidationFailures()

New in version NX11.0.0.

License requirements: None.

CreateAttributeTitleToNamingPatternMap

SmartSaveBuilder.CreateAttributeTitleToNamingPatternMap

Creates a map object of attribute titles to their corresponding naming pattern

Signature CreateAttributeTitleToNamingPatternMap(attributeTitles, titlePatterns)

Parameters:
  • attributeTitles (list of str) –
  • titlePatterns (list of str) –
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: None.

CreateSpecificationsForSmartSaveObjects

SmartSaveBuilder.CreateSpecificationsForSmartSaveObjects

Create new specifications for Logical Objects

Signature CreateSpecificationsForSmartSaveObjects(smartSaveObjects)

Parameters:smartSaveObjects (list of NXOpen.PDM.SmartSaveObject) –

New in version NX11.0.0.

License requirements: None.

GetErrorMessageHandler

SmartSaveBuilder.GetErrorMessageHandler

Returns ErrorMessageHandler

Signature GetErrorMessageHandler(refresh)

Parameters:refresh (bool) –
Returns:
Return type:NXOpen.PDM.ErrorMessageHandler

New in version NX11.0.0.

License requirements: None.

GetOperationFailures

SmartSaveBuilder.GetOperationFailures

Returns operation failures

Signature GetOperationFailures()

Returns:
Return type:NXOpen.ErrorList

New in version NX11.0.0.

License requirements: None.

GetSmartSaveObjects

SmartSaveBuilder.GetSmartSaveObjects

Gets the smart save objects for the modified objects in session.

Signature GetSmartSaveObjects()

Returns:
Return type:list of NXOpen.PDM.SmartSaveObject

New in version NX11.0.0.

License requirements: None.

OnOperationTypeChanged

SmartSaveBuilder.OnOperationTypeChanged

Updates the given smart save objects after operation type change.

Signature OnOperationTypeChanged(smartSaveObjects, operationType)

Parameters:

New in version NX11.0.0.

License requirements: None.

UpdateSmartSaveObjectsOnBuilder

SmartSaveBuilder.UpdateSmartSaveObjectsOnBuilder

Updates the smart save objects with valid operation type and dependencies

Signature UpdateSmartSaveObjectsOnBuilder()

New in version NX11.0.0.

License requirements: None.

Validate

SmartSaveBuilder.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.

ValidateSmartSaveObjects

SmartSaveBuilder.ValidateSmartSaveObjects

Validates whether the save operation can be performed on the smart save objects

Signature ValidateSmartSaveObjects()

New in version NX11.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)