NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.PDM.SmartSaveBuilder Class Reference

TODO: Add a documentation comment describing this class. More...

Inheritance diagram for NXOpen.PDM.SmartSaveBuilder:
NXOpen.Builder NXOpen.IAttributeSourceObjectBuilder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  SaveType {
  Save, SaveAll, SavePreciseAssembly, SaveWorkPartOnly,
  SaveAndClose, SaveDesignElements
}
 Represents an File Save type More...
 

Public Member Functions

unsafe void AssignRemoveProjects (NXOpen.PDM.SmartSaveObject[] smartSaveObjects, string[] projectNames, NXOpen.Session.ProjectAssignmentState[] assignmentStates)
 Assign or remove projects to/from objects More...
 
unsafe NXOpen.ErrorList AutoAssignAttributes (NXOpen.NXObject[] objects)
 Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...
 
unsafe NXOpen.ErrorList AutoAssignAttributesWithNamingPattern (NXOpen.NXObject[] objects, NXOpen.NXObject[] properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
unsafe bool CanPerformDefaultSave ()
 Checks whether smart save operation can be performed with default operation type set More...
 
unsafe void ClearValidationFailures ()
 Clears operation failures if any More...
 
unsafe NXOpen.NXObject CreateAttributeTitleToNamingPatternMap (string[] attributeTitles, string[] titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern More...
 
unsafe void CreateSpecificationsForSmartSaveObjects (NXOpen.PDM.SmartSaveObject[] smartSaveObjects)
 Create new specifications for Logical Objects More...
 
unsafe
NXOpen.PDM.AlternateIdManager 
GetAlternateIDManager (NXOpen.PDM.LogicalObject logicalObject)
 Create an instance of a NXOpen. More...
 
unsafe string[] GetAssociatedChangeNoticeNames (NXOpen.PDM.SmartSaveObject[] smartSaveObjects)
 Gets CLI names of Change Notice associated with Objects involved in Save operation More...
 
unsafe
NXOpen.PDM.ErrorMessageHandler 
GetErrorMessageHandler (bool refresh)
 Returns ErrorMessageHandler More...
 
unsafe NXOpen.ErrorList GetOperationFailures ()
 Returns operation failures More...
 
unsafe void GetSmartSaveObjects (out NXOpen.PDM.SmartSaveObject[] smartSaveObjects)
 Gets the smart save objects for the modified objects in session. More...
 
unsafe void OnOperationTypeChanged (NXOpen.PDM.SmartSaveObject[] smartSaveObjects, NXOpen.AttributePropertiesBuilder.OperationType operationType)
 Updates the given smart save objects after operation type change. More...
 
unsafe void UpdateSmartSaveObjectsOnBuilder ()
 Updates the smart save objects with valid operation type and dependencies More...
 
unsafe void ValidateSmartSaveObjects ()
 Validates whether the save operation can be performed on the smart save objects More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool DebugDumpEnabled [get, set]
 Returns or sets the debug dump enabled More...
 
unsafe bool UseNewSortForDebug [get, set]
 Returns or sets the new debug sort enabled More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

Created in NX10.0.0

Member Enumeration Documentation

Represents an File Save type

Enumerator
Save 

File Save

SaveAll 

File SaveAll

SavePreciseAssembly 

File SavePreciseAssembly

SaveWorkPartOnly 

File SaveWorkPartOnly

SaveAndClose 

File Save And Close

SaveDesignElements 

Save Design Elements

Member Function Documentation

unsafe void NXOpen.PDM.SmartSaveBuilder.AssignRemoveProjects ( NXOpen.PDM.SmartSaveObject[]  smartSaveObjects,
string[]  projectNames,
NXOpen.Session.ProjectAssignmentState[]  assignmentStates 
)
inline

Assign or remove projects to/from objects

Created in NX11.0.0

License requirements: None.

Parameters
smartSaveObjectsArray of objects to assign/remove projects to
projectNamesnames of the projects to assign
assignmentStatesassignment states
unsafe NXOpen.ErrorList NXOpen.PDM.SmartSaveBuilder.AutoAssignAttributes ( NXOpen.NXObject[]  objects)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
objects
Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe NXOpen.ErrorList NXOpen.PDM.SmartSaveBuilder.AutoAssignAttributesWithNamingPattern ( NXOpen.NXObject[]  objects,
NXOpen.NXObject[]  properties 
)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
objects
properties
Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe bool NXOpen.PDM.SmartSaveBuilder.CanPerformDefaultSave ( )
inline

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

Created in NX11.0.0

License requirements: None.

Returns
unsafe void NXOpen.PDM.SmartSaveBuilder.ClearValidationFailures ( )
inline

Clears operation failures if any

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.NXObject NXOpen.PDM.SmartSaveBuilder.CreateAttributeTitleToNamingPatternMap ( string[]  attributeTitles,
string[]  titlePatterns 
)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
attributeTitles
titlePatterns
Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe void NXOpen.PDM.SmartSaveBuilder.CreateSpecificationsForSmartSaveObjects ( NXOpen.PDM.SmartSaveObject[]  smartSaveObjects)
inline

Create new specifications for Logical Objects

Created in NX11.0.0

License requirements: None.

Parameters
smartSaveObjects
unsafe NXOpen.PDM.AlternateIdManager NXOpen.PDM.SmartSaveBuilder.GetAlternateIDManager ( NXOpen.PDM.LogicalObject  logicalObject)
inline

Create an instance of a NXOpen.

PDM.AlternateIdManager which will be used to create alternate ID information while creating the new part.

Created in NX12.0.0

License requirements: None.

Parameters
logicalObject
Returns
unsafe string [] NXOpen.PDM.SmartSaveBuilder.GetAssociatedChangeNoticeNames ( NXOpen.PDM.SmartSaveObject[]  smartSaveObjects)
inline

Gets CLI names of Change Notice associated with Objects involved in Save operation

Created in NX12.0.0

License requirements: None.

Parameters
smartSaveObjects
Returns
unsafe NXOpen.PDM.ErrorMessageHandler NXOpen.PDM.SmartSaveBuilder.GetErrorMessageHandler ( bool  refresh)
inline

Returns ErrorMessageHandler

Created in NX11.0.0

License requirements: None.

Parameters
refresh
Returns
unsafe NXOpen.ErrorList NXOpen.PDM.SmartSaveBuilder.GetOperationFailures ( )
inline

Returns operation failures

Created in NX11.0.0

License requirements: None.

Returns
unsafe void NXOpen.PDM.SmartSaveBuilder.GetSmartSaveObjects ( out NXOpen.PDM.SmartSaveObject[]  smartSaveObjects)
inline

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

Created in NX11.0.0

License requirements: None.

Parameters
smartSaveObjects
unsafe void NXOpen.PDM.SmartSaveBuilder.OnOperationTypeChanged ( NXOpen.PDM.SmartSaveObject[]  smartSaveObjects,
NXOpen.AttributePropertiesBuilder.OperationType  operationType 
)
inline

Updates the given smart save objects after operation type change.

Created in NX11.0.0

License requirements: None.

Parameters
smartSaveObjectsthe objects for which operation type is changed
operationTypethe new operation type
unsafe void NXOpen.PDM.SmartSaveBuilder.UpdateSmartSaveObjectsOnBuilder ( )
inline

Updates the smart save objects with valid operation type and dependencies

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.PDM.SmartSaveBuilder.ValidateSmartSaveObjects ( )
inline

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

Created in NX11.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Property Documentation

unsafe bool NXOpen.PDM.SmartSaveBuilder.DebugDumpEnabled
getset

Returns or sets the debug dump enabled

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.PDM.SmartSaveBuilder.UseNewSortForDebug
getset

Returns or sets the new debug sort enabled

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")


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