Provides methods for update and delete. More...

Inheritance diagram for NXOpen.Update:

Public Types
enum	Option { Now, Later }
	Specifies whether a method should perform an update or not. More...

enum	FailureOption { NoOption, Undo, Suppress, SuppressAll, Accept, AcceptAll, Delete, DeleteDependents, Interrupt }
	Specifies the action to take when an object fails to update. More...

Public Member Functions
unsafe int	AddToDeleteList (NXOpen.NXObject[] objects)
	Adds objects to the global delete list. More...

unsafe int	AddToDeleteList (NXOpen.TaggedObject @object)
	Adds an object to the global delete list. More...

unsafe void	RemoveFromDeleteList (NXOpen.NXObject[] objects)
	Removes objects from the global delete list. More...

unsafe NXOpen.NXObject[]	GetDeleteList ()
	Returns the global delete list More...

unsafe void	ClearDeleteList ()
	Clears the contents of the global delete list. More...

unsafe int	DoUpdate (NXOpen.Session.UndoMarkId undoMark)
	Updates the current session More...

unsafe void	ClearErrorList ()
	Clears the update error list. More...

unsafe void	DoInterpartUpdate (NXOpen.Session.UndoMarkId undoMark)
	Performs an interpart update. More...

unsafe void	SetDefaultUpdateFailureAction (NXOpen.Update.FailureOption failureAction)
	Sets the default action to take when an object fails to update. More...

unsafe NXOpen.Update.FailureOption	GetDefaultUpdateFailureAction ()
	Gets the default action to take when an object fails to update. More...

unsafe void	SetUpdateFailureAction (NXOpen.TaggedObject @object, NXOpen.Update.FailureOption failureAction)
	Sets the update failure action for an object. More...

unsafe void	RemoveUpdateFailureAction (NXOpen.TaggedObject @object)
	Removes the update failure action for an object. More...

unsafe void	DoAssemblyConstraintsUpdateInPart (NXOpen.Part partTag, NXOpen.Session.UndoMarkId undoMarkId)
	Performs an assembly constraints update. More...

unsafe void	DoAssemblyConstraintsUpdate (NXOpen.Session.UndoMarkId undoMarkId)
	Performs an assembly constraints update. More...

unsafe void	StartLocalUpdate ()
	Starts a local update session, and sets an update mark for that session. More...

unsafe void	EndLocalUpdate ()
	Ends the local update session, and clears the update mark for that session. More...

unsafe void	UndelayObjectUpdate (NXOpen.TaggedObject objectToUpdate)
	Undelay an Object More...

unsafe void	LogForUpdate (NXOpen.TaggedObject objectToUpdate)
	Logs an object for update. More...

unsafe void	SetUpdateLock (bool @lock)
	Sets the update lock to lock and unlock updates. More...

unsafe bool	GetUpdateLock ()
	Gets the update lock status. More...

unsafe void	UpdateAllIntrapartPartModulesInPart (NXOpen.Part partTag, NXOpen.Session.UndoMarkId undoMarkId)
	Updates all out-of-date intrapart part modules More...

unsafe void	MakeUpToDate (NXOpen.NXObject[] objects, NXOpen.Session.UndoMarkId undoMarkId)
	Updates all given out-of-date features or expressions to make them up to date More...

unsafe void	UpdateAllLinkedPartModulesInPart (NXOpen.Part partTag, NXOpen.Session.UndoMarkId undoMarkId)
	Updates all linked part modules in the part More...

unsafe int	AddObjectsToDeleteList (NXOpen.TaggedObject[] objects)
	Adds objects to the global delete list. More...

unsafe void	RemoveObjectsFromDeleteList (NXOpen.TaggedObject[] objects)
	Removes objects from the global delete list. More...

unsafe NXOpen.TaggedObject[]	GetObjectsOnDeleteList ()
	Returns the objects on the global delete list. More...

unsafe void	UpdateAllProductInterfaceInPart (NXOpen.Part partTag, NXOpen.Session.UndoMarkId undoMarkId)
	Updates all out-of-date product interfaces More...

unsafe void	SetPropagateDelete (bool propagateToDelete)
	Sets the propagate delete for update More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

unsafe bool	AssemblyConstraintsDelay `[get, set]`
	Returns or sets the state of the assembly constraints delay flag. More...

unsafe NXOpen.ErrorList	ErrorList `[get]`
	Returns the list of all the errors that the Update module has encountered since the last time that the list was cleared. More...

unsafe bool	InterpartDelay `[get, set]`
	Returns or sets the state of the interpart delay flag. More...

unsafe bool	IntrapartPartModuleDelay `[get, set]`
	Returns or sets the delay status for intrapart part modules delays More...

unsafe bool	ProductInterfaceDelay `[get, set]`
	Returns or sets the delay status for product interface delays More...

Detailed Description

Provides methods for update and delete.

To obtain an instance of this class, refer to NXOpen.Session

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.Update.FailureOption

Specifies the action to take when an object fails to update.

Enumerator
NoOption	No option
Undo	Perform undo
Suppress	Suppress failing object
SuppressAll	Suppress failing objects and subsequent objects
Accept	Accept failure of failing objects
AcceptAll	Accept failure of failing objects and subsequent objects
Delete	Delete failing object
DeleteDependents	Delete failing object and its dependents
Interrupt	Interrupt update upon failure

enum NXOpen.Update.Option

Specifies whether a method should perform an update or not.

Methods that choose not to perform an update will need to call NXOpen.Update.DoUpdate at a later time. Some methods in the Common API may perform an update. In an effort to improve performance, these methods take an option as input to not perform an update. For example, a method called in a loop may set the option to not update and then perform an explicit update after the loop completes.

Enumerator
Now	Perform an update immediately
Later	Do not perform an update

Member Function Documentation

unsafe int NXOpen.Update.AddObjectsToDeleteList ( NXOpen.TaggedObject[] objects )

Adds objects to the global delete list.

The objects in the global delete list will be deleted when the next update is performed. An update can be performed through the NXOpen.Update.DoUpdate method.

Note: if you are removing objects from a sketch, NXOpen.Sketch.DeleteObjects should be used instead.

Created in NX11.0.0

License requirements: None.

Parameters

objects The objects to be deleted

Returns: The number of errors in the update module's error list. If errors occurred during the execution of this method, they will be added to that error list. To obtain a list of these errors, use NXOpen.Update.ErrorList .

unsafe int NXOpen.Update.AddToDeleteList ( NXOpen.NXObject[] objects )

Adds objects to the global delete list.

The objects in the global delete list will be deleted when the next update is performed. An update can be performed through the NXOpen.Update.DoUpdate method.

Note: if you are removing objects from a sketch, NXOpen.Sketch.DeleteObjects should be used instead.

Created in NX3.0.0

Deprecated in NX12.0.0. Use Update.AddObjectsToDeleteList instead.

License requirements: None.

Parameters

objects The objects to be deleted

Returns: The number of errors in the update module's error list. If errors occurred during the execution of this method, they will be added to that error list. To obtain a list of these errors, use NXOpen.Update.ErrorList

unsafe int NXOpen.Update.AddToDeleteList ( NXOpen.TaggedObject @ object )

Adds an object to the global delete list.

The objects in the global delete list will be deleted when the next update is performed. An update can be performed through the NXOpen.Update.DoUpdate method.

Note: if you are removing objects from a sketch, NXOpen.Sketch.DeleteObjects should be used instead.

Created in NX3.0.0

License requirements: None.

Parameters

object The object to be deleted

Returns: The number of errors in the update module's error list. If errors occurred during the execution of this method, they will be added to that error list. To obtain a list of these errors, use NXOpen.Update.ErrorList

unsafe void NXOpen.Update.ClearDeleteList ( )

Clears the contents of the global delete list.

Clearing the global delete list does not delete any of the objects on the list.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.Update.ClearErrorList ( )

Clears the update error list.

See NXOpen.Update.ErrorList for more information about the update error list.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.Update.DoAssemblyConstraintsUpdate ( NXOpen.Session.UndoMarkId undoMarkId )

Performs an assembly constraints update.

This ensures that all parts containing out-of-date assembly constraints in this session are updated.

Created in NX7.5.0

License requirements: None.

Parameters

undoMarkId If any update error occurs, the system will roll back to this undo mark.

unsafe void NXOpen.Update.DoAssemblyConstraintsUpdateInPart	(	NXOpen.Part	partTag,
		NXOpen.Session.UndoMarkId	undoMarkId
	)

Performs an assembly constraints update.

This ensures that the specified part containing out-of-date assembly constraints is updated.

Created in NX7.5.0

License requirements: None.

Parameters

partTag
undoMarkId	If any update error occurs, the system will roll back to this undo mark.

unsafe void NXOpen.Update.DoInterpartUpdate ( NXOpen.Session.UndoMarkId undoMark )

Performs an interpart update.

This ensures that all parts in the session are updated with respect to any changes on other loaded parts. Note that this update will always occur regardless of the state of the interpart delay flag. See NXOpen.Update.InterpartDelay

Created in NX3.0.0

License requirements: None.

Parameters

undoMark If any update error occurs, the system will roll back to this undo mark.

unsafe int NXOpen.Update.DoUpdate ( NXOpen.Session.UndoMarkId undoMark )

Updates the current session

Created in NX3.0.0

License requirements: None.

Parameters

undoMark If any update error occurs, the system will roll back to this undo mark and throw an exception.

Returns: The number of errors in the update module's error list. If errors occurred during update they will be added to that error list. To obtain a list of these errors, use NXOpen.Update.ErrorList

unsafe void NXOpen.Update.EndLocalUpdate ( )

Ends the local update session, and clears the update mark for that session.

See NXOpen.Update.StartLocalUpdate for details about the local update session.

Created in NX7.5.1

License requirements: None.

unsafe NXOpen.Update.FailureOption NXOpen.Update.GetDefaultUpdateFailureAction ( )

Gets the default action to take when an object fails to update.

An object will execute the default update failure action if it fails to update. The default update failure action is executed on a failing object even if there is a specific update action set for that object.

Created in NX9.0.0

License requirements: None.

Returns: The default update failure action

unsafe NXOpen.NXObject [] NXOpen.Update.GetDeleteList ( )

Returns the global delete list

Created in NX3.0.0

Deprecated in NX12.0.0. Use Update.GetObjectsOnDeleteList instead.

License requirements: None.

Returns

unsafe NXOpen.TaggedObject [] NXOpen.Update.GetObjectsOnDeleteList ( )

Returns the objects on the global delete list.

Created in NX11.0.0

License requirements: None.

Returns

unsafe bool NXOpen.Update.GetUpdateLock ( )

Gets the update lock status.

Also see NXOpen.Update.SetUpdateLock

Created in NX7.5.5

License requirements: None.

Returns: The lock state

unsafe void NXOpen.Update.LogForUpdate ( NXOpen.TaggedObject objectToUpdate )

Logs an object for update.

Created in NX7.5.3

License requirements: None.

Parameters

objectToUpdate The object to be updated

unsafe void NXOpen.Update.MakeUpToDate	(	NXOpen.NXObject[]	objects,
		NXOpen.Session.UndoMarkId	undoMarkId
	)

Updates all given out-of-date features or expressions to make them up to date

Created in NX9.0.0

License requirements: None.

Parameters

objects	The objects to be made up to date
undoMarkId	If any update error occurs, the system will roll back to this undo mark.

unsafe void NXOpen.Update.RemoveFromDeleteList ( NXOpen.NXObject[] objects )

Removes objects from the global delete list.

Note: if the object is not in the delete list, it will be ignored. An exception will not be raised.

Created in NX3.0.0

Deprecated in NX12.0.0. Use Update.RemoveObjectsFromDeleteList instead.

License requirements: None.

Parameters

objects The objects to be removed from the delete list

unsafe void NXOpen.Update.RemoveObjectsFromDeleteList ( NXOpen.TaggedObject[] objects )

Removes objects from the global delete list.

Note: if an object is not in the delete list, it will be ignored. An exception will not be raised.

Created in NX11.0.0

License requirements: None.

Parameters

objects The objects to be removed from the delete list

unsafe void NXOpen.Update.RemoveUpdateFailureAction ( NXOpen.TaggedObject @ object )

Removes the update failure action for an object.

Created in NX7.5.0

License requirements: None.

Parameters

object The object that fails to update

unsafe void NXOpen.Update.SetDefaultUpdateFailureAction ( NXOpen.Update.FailureOption failureAction )

Sets the default action to take when an object fails to update.

An object will execute the default update failure action if it fails to update. The default update failure action is executed on a failing object even if there is a specific update action set for that object.

Created in NX9.0.0

License requirements: None.

Parameters

failureAction The default update failure action

unsafe void NXOpen.Update.SetPropagateDelete ( bool propagateToDelete )

Sets the propagate delete for update

Created in NX12.0.0

License requirements: None.

Parameters

propagateToDelete

unsafe void NXOpen.Update.SetUpdateFailureAction	(	NXOpen.TaggedObject @	object,
		NXOpen.Update.FailureOption	failureAction
	)

Sets the update failure action for an object.

An object will execute this update failure action if it fails to update. If there is a default update failure action defined, that action overrides any specific update failure action set for an object.

Created in NX7.5.0

License requirements: None.

Parameters

object	The object that fails to update
failureAction	The update failure action

unsafe void NXOpen.Update.SetUpdateLock ( bool @ lock )

Sets the update lock to lock and unlock updates.

Locking updates will lock model updates until updates are unlocked. Note that updates should be locked with utmost care as operations can produce undesired results or possibly result in unexpected failures when they are performed when updates are locked.

If you do choose to lock updates then you have to ensure that the update lock state prior to locking update is restored after your operation. See NXOpen.Update.GetUpdateLock to get the lock status. Additionally, a call to NXOpen.Update.DoUpdate has to be made after restoring the lock status to ensure that entities added to the update list after update was locked are updated.

Created in NX7.5.5

License requirements: None.

Parameters

lock	The lock state

unsafe void NXOpen.Update.StartLocalUpdate ( )

Starts a local update session, and sets an update mark for that session.

This ensures that only entities added into update list since the mark setting are updated when the next update is performed before the mark is cleared. To perform update,use NXOpen.Update.DoUpdate . To clear the mark, use NXOpen.Update.EndLocalUpdate .

Note:

Any entities updated while the mark was in place will not be updated during the next update even if they depend on entities on the newly restored list.
Local update may not be nested.i.e.if a local update process is started and not yet ended, you cannot start another one.

Created in NX7.5.1

License requirements: None.

unsafe void NXOpen.Update.UndelayObjectUpdate ( NXOpen.TaggedObject objectToUpdate )

Undelay an Object

Created in NX7.5.3

License requirements: None.

Parameters

objectToUpdate The object to be undelayed

unsafe void NXOpen.Update.UpdateAllIntrapartPartModulesInPart	(	NXOpen.Part	partTag,
		NXOpen.Session.UndoMarkId	undoMarkId
	)

Updates all out-of-date intrapart part modules

Created in NX9.0.0

License requirements: None.

Parameters

partTag
undoMarkId	If any update error occurs, the system will roll back to this undo mark.

unsafe void NXOpen.Update.UpdateAllLinkedPartModulesInPart	(	NXOpen.Part	partTag,
		NXOpen.Session.UndoMarkId	undoMarkId
	)

Updates all linked part modules in the part

Created in NX10.0.0

License requirements: usr_defined_features ("USER DEFINED FEATURES")

Parameters

partTag
undoMarkId	If any update error occurs, the system will roll back to this undo mark.

unsafe void NXOpen.Update.UpdateAllProductInterfaceInPart	(	NXOpen.Part	partTag,
		NXOpen.Session.UndoMarkId	undoMarkId
	)

Updates all out-of-date product interfaces

Created in NX11.0.1

License requirements: None.

Parameters

partTag
undoMarkId	If any update error occurs, the system will roll back to this undo mark.

Property Documentation

unsafe bool NXOpen.Update.AssemblyConstraintsDelay

getset

Returns or sets the state of the assembly constraints delay flag.

If true, then all the assembly constraints in the session will be delayed from update. If false, then updates will be applied across all parts in the session.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.ErrorList NXOpen.Update.ErrorList

get

Returns the list of all the errors that the Update module has encountered since the last time that the list was cleared.

To clear the list, use NXOpen.Update.ClearErrorList .

Created in NX3.0.0

License requirements: None.

unsafe bool NXOpen.Update.InterpartDelay

getset

Returns or sets the state of the interpart delay flag.

If interpart delay is turned on, then updates will not be propagated beyond the work part. If off, then updates will be applied across all parts in the session.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Update.IntrapartPartModuleDelay

getset

Returns or sets the delay status for intrapart part modules delays

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Update.ProductInterfaceDelay

getset

Returns or sets the delay status for product interface delays

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.Update.Tag

get

Returns the tag of this object.

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

dotnet_pool/Update.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation