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

Inheritance diagram for NXOpen::PDM::SmartSaveBuilder:

Public Types
enum	SaveType { SaveTypeSave, SaveTypeSaveAll, SaveTypeSavePreciseAssembly, SaveTypeSaveWorkPartOnly, SaveTypeSaveAndClose, SaveTypeSaveDesignElements }
	Represents an File Save type Created in NX11.0.0. More...

Public Member Functions
void	AssignRemoveProjects (const std::vector< NXOpen::PDM::SmartSaveObject * > &smartSaveObjects, std::vector< NXString > &projectNames, const std::vector< NXOpen::Session::ProjectAssignmentState > &assignmentStates)
	Assign or remove projects to/from objects Created in NX11.0.0. More...

virtual NXOpen::ErrorList *	AutoAssignAttributes (const std::vector< 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...

virtual NXOpen::ErrorList *	AutoAssignAttributesWithNamingPattern (const std::vector< NXOpen::NXObject * > &objects, const std::vector< NXOpen::NXObject * > &properties)
	Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...

bool	CanPerformDefaultSave ()
	Checks whether smart save operation can be performed with default operation type set. More...

void	ClearValidationFailures ()
	Clears operation failures if any Created in NX11.0.0. More...

virtual NXOpen::NXObject *	CreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
	Creates a map object of attribute titles to their corresponding naming pattern. More...

void	CreateSpecificationsForSmartSaveObjects (const std::vector< NXOpen::PDM::SmartSaveObject * > &smartSaveObjects)
	Create new specifications for Logical Objects Created in NX11.0.0. More...

bool	DebugDumpEnabled ()
	Returns the debug dump enabled Created in NX11.0.0. More...

NXOpen::PDM::ErrorMessageHandler *	GetErrorMessageHandler (bool refresh)
	Returns ErrorMessageHandler. More...

NXOpen::ErrorList *	GetOperationFailures ()
	Returns operation failures. More...

void	GetSmartSaveObjects (std::vector< NXOpen::PDM::SmartSaveObject * > &smartSaveObjects)
	Gets the smart save objects for the modified objects in session. More...

void	OnOperationTypeChanged (const std::vector< NXOpen::PDM::SmartSaveObject * > &smartSaveObjects, NXOpen::AttributePropertiesBuilder::OperationType operationType)
	Updates the given smart save objects after operation type change. More...

void	SetDebugDumpEnabled (bool debugDumpEnabled)
	Sets the debug dump enabled Created in NX11.0.0. More...

void	SetUseNewSortForDebug (bool useNewSortForDebug)
	Sets the new debug sort enabled Created in NX11.0.1. More...

void	UpdateSmartSaveObjectsOnBuilder ()
	Updates the smart save objects with valid operation type and dependencies Created in NX11.0.0. More...

bool	UseNewSortForDebug ()
	Returns the new debug sort enabled Created in NX11.0.1. More...

void	ValidateSmartSaveObjects ()
	Validates whether the save operation can be performed on the smart save objects Created in NX11.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

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

enum NXOpen::PDM::SmartSaveBuilder::SaveType

Represents an File Save type
Created in NX11.0.0.

Enumerator
SaveTypeSave	File Save.
SaveTypeSaveAll	File SaveAll.
SaveTypeSavePreciseAssembly	File SavePreciseAssembly.
SaveTypeSaveWorkPartOnly	File SaveWorkPartOnly.
SaveTypeSaveAndClose	File Save And Close.
SaveTypeSaveDesignElements	Save Design Elements.

Member Function Documentation

void NXOpen::PDM::SmartSaveBuilder::AssignRemoveProjects	(	const std::vector< NXOpen::PDM::SmartSaveObject * > &	smartSaveObjects,
		std::vector< NXString > &	projectNames,
		const std::vector< NXOpen::Session::ProjectAssignmentState > &	assignmentStates
	)

Assign or remove projects to/from objects
Created in NX11.0.0.

License requirements : None

Parameters

smartSaveObjects	Array of objects to assign/remove projects to
projectNames	names of the projects to assign
assignmentStates	assignment states

virtual NXOpen::ErrorList* NXOpen::PDM::SmartSaveBuilder::AutoAssignAttributes ( const std::vector< NXOpen::NXObject * > & objects )

virtual

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

Returns: Created in NX8.5.0.

License requirements : None

Parameters

objects objects

Implements NXOpen::IAttributeSourceObjectBuilder.

virtual NXOpen::ErrorList* NXOpen::PDM::SmartSaveBuilder::AutoAssignAttributesWithNamingPattern	(	const std::vector< NXOpen::NXObject * > &	objects,
		const std::vector< NXOpen::NXObject * > &	properties
	)

virtual

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

Returns: Created in NX12.0.0.

License requirements : None

Parameters

objects	objects
properties	properties

Implements NXOpen::IAttributeSourceObjectBuilder.

bool NXOpen::PDM::SmartSaveBuilder::CanPerformDefaultSave ( )

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

Returns: Created in NX11.0.0.

License requirements : None

void NXOpen::PDM::SmartSaveBuilder::ClearValidationFailures ( )

Clears operation failures if any
Created in NX11.0.0.

License requirements : None

virtual NXOpen::NXObject* NXOpen::PDM::SmartSaveBuilder::CreateAttributeTitleToNamingPatternMap	(	std::vector< NXString > &	attributeTitles,
		std::vector< NXString > &	titlePatterns
	)

virtual

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

Returns: Created in NX12.0.0.

License requirements : None

Parameters

attributeTitles	attributetitles
titlePatterns	titlepatterns

Implements NXOpen::IAttributeSourceObjectBuilder.

void NXOpen::PDM::SmartSaveBuilder::CreateSpecificationsForSmartSaveObjects ( const std::vector< NXOpen::PDM::SmartSaveObject * > & smartSaveObjects )

Create new specifications for Logical Objects
Created in NX11.0.0.

License requirements : None

Parameters

smartSaveObjects smartsaveobjects

bool NXOpen::PDM::SmartSaveBuilder::DebugDumpEnabled ( )

Returns the debug dump enabled
Created in NX11.0.0.

License requirements : None

NXOpen::PDM::ErrorMessageHandler* NXOpen::PDM::SmartSaveBuilder::GetErrorMessageHandler ( bool refresh )

Returns ErrorMessageHandler.

Returns: Created in NX11.0.0.

License requirements : None

Parameters

refresh refresh

NXOpen::ErrorList* NXOpen::PDM::SmartSaveBuilder::GetOperationFailures ( )

Returns operation failures.

Returns: Created in NX11.0.0.

License requirements : None

void NXOpen::PDM::SmartSaveBuilder::GetSmartSaveObjects ( std::vector< NXOpen::PDM::SmartSaveObject * > & smartSaveObjects )

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

Created in NX11.0.0.

License requirements : None

Parameters

smartSaveObjects smartsaveobjects

void NXOpen::PDM::SmartSaveBuilder::OnOperationTypeChanged	(	const std::vector< NXOpen::PDM::SmartSaveObject * > &	smartSaveObjects,
		NXOpen::AttributePropertiesBuilder::OperationType	operationType
	)

Updates the given smart save objects after operation type change.

Created in NX11.0.0.

License requirements : None

Parameters

smartSaveObjects	the objects for which operation type is changed
operationType	the new operation type

void NXOpen::PDM::SmartSaveBuilder::SetDebugDumpEnabled ( bool debugDumpEnabled )

Sets the debug dump enabled
Created in NX11.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

debugDumpEnabled debugdumpenabled

void NXOpen::PDM::SmartSaveBuilder::SetUseNewSortForDebug ( bool useNewSortForDebug )

Sets the new debug sort enabled
Created in NX11.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

useNewSortForDebug usenewsortfordebug

void NXOpen::PDM::SmartSaveBuilder::UpdateSmartSaveObjectsOnBuilder ( )

Updates the smart save objects with valid operation type and dependencies
Created in NX11.0.0.

License requirements : None

bool NXOpen::PDM::SmartSaveBuilder::UseNewSortForDebug ( )

Returns the new debug sort enabled
Created in NX11.0.1.

License requirements : None

void NXOpen::PDM::SmartSaveBuilder::ValidateSmartSaveObjects ( )

Validates whether the save operation can be performed on the smart save objects
Created in NX11.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

The documentation for this class was generated from the following file:

PDM_SmartSaveBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation