Modifier and Type | Interface and Description |
---|---|
static class |
Update.FailureOption
Specifies the action to take when an object fails to update.
|
static class |
Update.Option
Specifies whether a method should perform an update or not.
|
Modifier and Type | Method and Description |
---|---|
int |
addToDeleteList(NXObject object)
Adds an object to the global delete list.
|
int |
addToDeleteList(NXObject[] objects)
Adds objects to the global delete list.
|
boolean |
assemblyConstraintsDelay()
Returns the state of the assembly constraints delay flag.
|
void |
clearDeleteList()
Clears the contents of the global delete list.
|
void |
clearErrorList()
Clears the error list.
|
void |
doAssemblyConstraintsUpdate(int undoMarkId)
Performs an assembly constraints update.
|
void |
doAssemblyConstraintsUpdateInPart(Part partTag,
int undoMarkId)
Performs an assembly constraints update.
|
void |
doInterpartUpdate(int undoMark)
Performs an interpart update.
|
int |
doUpdate(int undoMark)
Updates the current session
License requirements: None. |
void |
endLocalUpdate()
Clear the update mark.See
startLocalUpdate() . |
ErrorList |
errorList()
Returns the list of all the errors that the Update module has encountered
since the last time that the list was cleared.
|
Update.FailureOption |
getDefaultUpdateFailureAction()
The default update failure action.
|
NXObject[] |
getDeleteList()
Returns the global delete list
License requirements: None. |
boolean |
getUpdateLock()
Get the current update lock status.
|
boolean |
interpartDelay()
Returns the state of the interpart delay flag.
|
boolean |
intrapartPartModuleDelay()
Returns the delay status for intrapart part modules delays
License requirements: None. |
void |
logForUpdate(NXObject object)
Log Object for Update
License requirements: None. |
void |
makeUpToDate(NXObject[] objects,
int undoMarkId)
Updates all given out-of-date features or expression to make them up to date
License requirements: None. |
void |
removeFromDeleteList(NXObject[] objects)
Removes objects from the global delete list.
|
void |
removeUpdateFailureAction(NXObject object)
Remove update failure action.
|
void |
setAssemblyConstraintsDelay(boolean delayed)
License requirements: None. |
void |
setDefaultUpdateFailureAction(Update.FailureOption failureAction)
Action to take when an object fails to update even with specific action set to that object.
|
void |
setInterpartDelay(boolean delayed)
License requirements: None. |
void |
setIntrapartPartModuleDelay(boolean delayed)
License requirements: None. |
void |
setUpdateFailureAction(NXObject object,
Update.FailureOption failureAction)
Action to take when an object fails to update.
|
void |
setUpdateLock(boolean lock)
Lock and unlock updates.
|
void |
startLocalUpdate()
Set an update mark.
|
void |
undelayObjectUpdate(NXObject object)
Undelay an Object
License requirements: None. |
void |
updateAllIntrapartPartModulesInPart(Part partTag,
int undoMarkId)
Updates all out-of-date intrapart part modules
License requirements: None. |
void |
updateAllLinkedPartModulesInPart(Part partTag,
int undoMarkId)
Updates all linked part modules in the part
License requirements: None. |
int addToDeleteList(NXObject[] objects) throws NXException, RemoteException
doUpdate(int)
method.
Sketch.deleteObjects(nxopen.NXObject[])
should be used instead.
objects
- The objects to be deletederrorList()
NXException
RemoteException
int addToDeleteList(NXObject object) throws NXException, RemoteException
doUpdate(int)
method.
Sketch.deleteObjects(nxopen.NXObject[])
should be used instead.
object
- The object to be deletederrorList()
NXException
RemoteException
void removeFromDeleteList(NXObject[] objects) throws NXException, RemoteException
objects
- The objects to be removed from the delete listNXException
RemoteException
NXObject[] getDeleteList() throws NXException, RemoteException
NXException
RemoteException
void clearDeleteList() throws NXException, RemoteException
NXException
RemoteException
int doUpdate(int undoMark) throws NXException, RemoteException
undoMark
- If any update error occurs, the system will roll back to this
undo mark and throw an exception.errorList()
NXException
RemoteException
ErrorList errorList() throws NXException, RemoteException
clearErrorList()
.
NXException
RemoteException
void clearErrorList() throws NXException, RemoteException
NXException
RemoteException
void setInterpartDelay(boolean delayed) throws NXException, RemoteException
delayed
- The new state of the interpart delay flag.NXException
RemoteException
boolean interpartDelay() throws NXException, RemoteException
NXException
RemoteException
void doInterpartUpdate(int undoMark) throws NXException, RemoteException
setInterpartDelay(boolean)
undoMark
- If any update error occurs, the system will roll back to this
undo mark.NXException
RemoteException
void setDefaultUpdateFailureAction(Update.FailureOption failureAction) throws NXException, RemoteException
failureAction
- The default update failure actionNXException
RemoteException
Update.FailureOption getDefaultUpdateFailureAction() throws NXException, RemoteException
NXException
RemoteException
void setUpdateFailureAction(NXObject object, Update.FailureOption failureAction) throws NXException, RemoteException
object
- The object that fails to updatefailureAction
- The update failure actionNXException
RemoteException
void removeUpdateFailureAction(NXObject object) throws NXException, RemoteException
object
- The object that fails to updateNXException
RemoteException
boolean assemblyConstraintsDelay() throws NXException, RemoteException
NXException
RemoteException
void setAssemblyConstraintsDelay(boolean delayed) throws NXException, RemoteException
delayed
- The new state of the assembly constraints delay flag.NXException
RemoteException
void doAssemblyConstraintsUpdateInPart(Part partTag, int undoMarkId) throws NXException, RemoteException
partTag
- undoMarkId
- If any update error occurs, the system will roll back to this
undo mark.NXException
RemoteException
void doAssemblyConstraintsUpdate(int undoMarkId) throws NXException, RemoteException
undoMarkId
- If any update error occurs, the system will roll back to this
undo mark.NXException
RemoteException
void startLocalUpdate() throws NXException, RemoteException
doUpdate(int)
.
To clear the mark, use endLocalUpdate()
.
NXException
RemoteException
void endLocalUpdate() throws NXException, RemoteException
NXException
RemoteException
void undelayObjectUpdate(NXObject object) throws NXException, RemoteException
object
- The object to be undelayedNXException
RemoteException
void logForUpdate(NXObject object) throws NXException, RemoteException
object
- The object to be updatedNXException
RemoteException
void setUpdateLock(boolean lock) throws NXException, RemoteException
getUpdateLock()
to get the lock status.
Additionally, a call to doUpdate(int)
has to be made after restoring the
lock status to ensure that entities added to the update list after update was locked are updated.
lock
- The lock stateNXException
RemoteException
boolean getUpdateLock() throws NXException, RemoteException
setUpdateLock(boolean)
NXException
RemoteException
void setIntrapartPartModuleDelay(boolean delayed) throws NXException, RemoteException
delayed
- The new state of the interpart delay flag.NXException
RemoteException
boolean intrapartPartModuleDelay() throws NXException, RemoteException
NXException
RemoteException
void updateAllIntrapartPartModulesInPart(Part partTag, int undoMarkId) throws NXException, RemoteException
partTag
- undoMarkId
- If any update error occurs, the system will roll back to this
undo mark.NXException
RemoteException
void makeUpToDate(NXObject[] objects, int undoMarkId) throws NXException, RemoteException
objects
- The objects to be made up to dateundoMarkId
- If any update error occurs, the system will roll back to this
undo mark.NXException
RemoteException
void updateAllLinkedPartModulesInPart(Part partTag, int undoMarkId) throws NXException, RemoteException
partTag
- undoMarkId
- If any update error occurs, the system will roll back to this
undo mark.NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.