CATMecModUIUseItf CATPrtUpdateCom

Usage: you must use this class as is. You should never derive it.

public class CATPrtUpdateCom

Class to update the part or a selected feature.
Role: This class is the command to update a feature or a part in the user interface. The update diagnosis dialog box is automatically displayed if an update error occurs. This command should be run at the end of a command that creates or modifies a feature. In this case, do not call delete on it, because it is automatically deleted when the father command is deleted. On the other hand, it should not be used in a batch code, where is enough.

Constructor and Destructor Index


o CATPrtUpdateCom(CATString*)
Runs the command.
o CATPrtUpdateCom(CATBaseUnknown_var,int,int,int,CATCommandMode)
Runs the command.

Constructor and Destructor


o CATPrtUpdateCom
public CATPrtUpdateCom( iArg= NULL)
Runs the command.
Parameters:
iArg
The string specifying what has to be updated.
Legal values:
  • "PartUpdate" : updates the whole part and the external references. A progress bar is displayed.
  • "PartUpdateKeepReport" : same as "PartUpdate", except a better management of the update diagnosis report, if the feature is modified after pressing the "Edit" button.
  • "AutoUpdate" : updates the whole part, if the automatic update option is checked, else only the UI active feature in manual update.
  • "AutoUpdateKeepReport" : same as "AutoUpdate", except a better management of the update diagnosis report, if the feature is modified after pressing the "Edit" button.
  • "FeatureUpdate" : updates only the selected feature (
).
o CATPrtUpdateCom
public CATPrtUpdateCom( iObjectToUpdate,
const iAutoUpdate= 0,
const iCreation= 0,
iVisu= 1,
iStartMode= CATCommandModeUndefined )
Runs the command.
Parameters:
iObjectToUpdate
The object to update. It may be NULL_var, then the UI active object is updated.
iAutoUpdate
The automatic update flag.
Legal values:
  • 0 to update the iObjectToUpdate only.
  • 1 to update the part in automatic update mode or the iObjectToUpdate in manual update mode.
iCreation
The current action on the feature. It may be returned by
.
Legal values:
  • 1 if the object iObjectToUpdate is being created.
  • 0 if it is being edited.
iVisu
Not used argument.
iStartMode
The start mode of the command.
It is is better to use CATCommandModeUndefined. Thus, the command may be lauched from another command without cancelling it. Moreover, the error report is displayed only in this mode.
This object is included in the file: CATPrtUpdateCom.h
If needed, your Imakefile.mk should include the module: CATMecModUIUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.