Home

Bouml reference manual - Fedora Project Packages GIT repositories

1. Select linked items Replace it Remove from view Remove from view Delete fram model Message Menu edit drawing settings This dialog allows to specify how a the class instance must be drawn you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level a Diagram Drawing Se mn Diagram Drawin cols id ree L diagram calor drawing mode deaur class instance color default na write class instance horizontaly To write the instance type and name on the same line or on two lines write namg type horizontally Message Menu Insert in model exit from model There are two kinds of class instances instances part of the model visible in the browser and pure graphic instances to not pollute the model with many useless instances The button E add or create an instance part of the model The button Ed add or create a pure graphical instances But after that you are 229 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html able to transform a pure graphical instance to a modeled one or to replace the drawing of a modeled instance by a pure graphic on the modeled class instance itself is unchanged Message Menu Replace it This entry appears on a pure graphical instance and allows to replace it by a modeled instance of the same class Defa
2. comment static mutable volatile const type namejr value Declaration C2 theCc2 Result after substitutian Default declaration Not generated In C ROLE 2 Visibility follow uml protected public protected private Sfoomment static mutable volatile const type name ivalue Declaration 2 Result after substitutian Default declaration Not generated in C for a generalization realization or a dependency 68 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Relation dialog Bie aan afa Um Kea Java IDL Liser ROLE 1 F virtual Visibility E follow uml public public protected C private T mutable itype Declaration c3 Result after substitution Default declaratian Not generated in C In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for C supposing you do not modify the C code generator When you push the button default declaration the form specified through the generation settings depending on the stereotype and multiplicity and of course the language is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this relation defined in C empties the declaration manually or using
3. This very important dialog allows to specify many default definitions concerning the attributes more details will be given in C generator Java generator and Idl generator The first tab allows to specify how the types not supported by an UML class are translated in each language except Php pee n dialog void void Object baal boolean char char unsigned char char unsigned char byte short shart unsigned short shart int int unsigned int int unsigned int lang long unsigned long long float float double double GC String string char String vaid 7 long char byte GSacketDevice Socket void any nopean char octet octet short TNT ee amp const type type itype Pitype amp type itype amp type itype itype pitype amp type pitype amp unsigned short type Per amp long unsigned long unsigned long long unsigned long float double string string Rem id octet Socket tins itype A itype P type amp jitper Sityne amp type abitype amp itype Pitype amp jityner jitype amp ditype ditype amp itype type amp const type type amp type _Bitype amp itype pitype amp type pitypej amp nc The third C tab allows to set the default definition of an attribute in C only visible when C is set through the menu Languages 07 10 2007 16 00 91 of 357 file C uml BOUML bouml_3 0 doc TOUT html a
4. class diagram PO stereotypes object diagram PO stereotypes collaboration diagram EM MSN stereotypes Sequence diagram FO Stereotypes use case diagram FO stereotypes state diagram NEN stereotypes activity diagram PO stereotypes component diagram EMEN NN Stereotypes deployment diagram NEM NK sterentypes 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html make a dessert EnF j k HHeeeg one ep Gees o m liom uu make a chocolate mousse precanditions to have ingredients i break e lt localPastconditian gt chocolate lt lt iteratives gt right temperature melt chocolate i y all e ox chocolate i f liquid wait 4 e gt hours refrigerator al S A activity diagram may contain activity activity regions activity actions activity objects activity control nodes packages fragment notes texts diagram icons and the flows To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram Warning when you use the buttons to add an activity node and you click on a activity or region drawing the new activity will be nested in the activity or region In case you place the new element out of any activity or region drawing the new one will be nested
5. C Java Php Idl clase C public C3 4 class C extends C3 class C extends C3 valuetype C C3 protected protected C dir a protected S dir a private C dir a C dir a protected C dir_b protected S dir b private C dir b C dair D protected C2 theC2 protected S theC2 private C2 theC2 2 theC2 class C2 1 class C2 4 Glass C2 4 protected protected C theC protected StheC valuetype C2 C theC protected C2 a protected a private C theC C2 a private C2 a friend class C3 The multiplicity and stereotype may be used to produce the appropriate code with a natural and intuitive way For instance the C s relation theC2 with the stereotype vector and multiplicity will produce depending on the generation settings C Java Idl vector C2 gt theC2 protected Vector theC2 private sequence lt C2 gt theC2 With the stereotype vector and the multiplicity 12 the C s relation theC2 will produce depending on the generation settings C Java Idl C2 thec2 I12 5 protected C2 theC2 private sequence lt C2 12 gt theC2 Refer to the C Generator Java generator Php Generator and Idl generator for additional information Menus The relation menu appearing with a right mouse click on its representation in the browser is something like these supposing it is not read only nor deleted see also menu in a diagram the C2 CandCe edit duplicate add get op
6. Fites 9 m i with without artifact l class T operation l attribute M relation curent DB i Replace Quit The filters are optional are allow to not do the change on all the potential definitions and declarations An empty filter is ignored else a filter may be used to consider the forms containing it with is set or not containing it without is set When you have several filters you may conjugate them with and or or the priority of and and or are equals to the ones under C and Java In case you have one filter you must use filter 1 In case you have two filters you must use filter 1 and 2 It is also possible to filter through the stereotype Choose any to not consider the stereotypes is to consider only the elements having the specified stereotype may be an empty one and is not to not consider the elements having the specified stereotype may be an empty one Several targets may be set to choose on which kind of elements the change must be done Several languages may be set too to choose for which language the definition declarations the changes must be done Current indicates the current form to be changed new the value the substitution being done on the element definitions declarations compatible with all the previous indications Notes except for the stereotype n is used to indicate a line break in the inputs The carriage return characters are removed to not pollute th
7. return 0 in C Z1 and produce a RuntlmeException in Java creare Inaur parent UmiClass in s str i Umi Attribute The bouml window is composed of three parts e The left sub window display a browser presenting your project the navigation may be done by the mouse or the keyboar arrows The bold font is used when an item is modifiable an item is read only when you do not have the write permission for the file s supporting it see project files The system items supporting the plug out s API for instance UmlBaseActor are also read only e The bottom right sub window is used to display modify the comment associated to the current selected item 07 10 2007 16 00 4 of 357 file C uml BOUML bouml_3 0 doc TOUT html e The top right part is used to display modify the diagrams these ones may be maximized or minimized Notes e if you have at least a dual monitor configuration the better is to set the environment variable BOUML LIMIT DESKTOP see here e if you use non ISO 8859 1 latinl characters for instance Cyrillic set the environment variable BOUML CHARSET see here e it is possible to start a plug out when Bouml is launch see here Project creation A project creation is done through the entry new of the project menu When you create a new project a file dialog appears its aspect depend on the used system and window manager and you have t select the directory where the project will be placed an
8. 0 a Scoe 100 es Hf A deployment diagram may contain deployment node network line network connexion component fragment notes texts diagram icons and the relations To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram The network lines may connect deployment nodes and or network connexion The network connexions represented by small squares allows to have network lines out of deployment node as it is the case in the picture above The scale may be changed from 30 up to 200 To allows to see the relation kinds even with a small scale the size of the arrows is unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the pr
9. Activity Action dialog 45 ica iba ile Lm oc C Java Properties Fre condition Post condition Activity send object action dialog tab Java This tab allows to specify the pre and post condition in Java but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 45 vei mm quie Lm oc ee Java Properties Fre condition Post condition cu Menu duplicate The menu entry duplicate clone the activity action without its children Menu referenced by To know who reference the current activity action through a flow Menu mark See mark Menu delete The menu entry delete is only present when the activity action 1s not read only Delete the activity action and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on a activity action The selected tool is called and applied on the current activity action 160 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Pin menus The pin menu appearing with a right mouse click on its representation in the browser is something like these supposing the pin not read only nor deleted see also menu in a diagram edit d
10. GenerationSettings dialog m haultigliciby unspecified comment static mutable volatile i const type name value iori comment static mutable volatile iconst stereotype lt f typel gt name value comment static mutable volatile const type name F miltiplicity value f ccoment itet ic Fimutabia f volatile Ficomet titype f nameif value f commantif etat ici tiguteble f volatile coast fiatereotypel lt fitype fitamelfivaluel comment istati mutable fivolatile iconet typel Finamel multiplicity tivalwel comment F atat iol timutebile fivolatile ficonst titype tiname T ivalua i comment f istaticif imutable tivolat tiie fi cont tigtereot ype lt i itype gt tf name fivaiue i comment j F etat ic Cimuteble fivolatiie f comet f type Ciname fimultiplicity Fivalee The fourth C tab allows to set the default definition of an enumeration s item in C and to specify the get and set opera specificities in C only visible when C is set through the menu Languages ES a GenerationSettings dialog default definition Set operation default definition Enumeration item default definitian Ey tup murs Cut type tores tor et hys ret giver im he inst tat Modifiers 34 amp public protected C private F inline F const value
11. Next Java generator 206 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Java generator The Java code generator is a plug out directly written in C The generated sources follows the definition made in BOUML at the artifact class operation relation attribute extra member levels When the code generation is applied on a artifact associated to several classes the code generation is made for all these cl Nevertheless the the Java code generator produce first the code in memory and update the appropriate files only when it is necessary to not change the last write date of the files for nothing Depending on the toggle verbose code generation of the global menu Languages the code generator is verbose or not The Java code generator plug out may be called on e aclass in this case the code generation is in fact applied on the class s artifact then on all the classes associated to this artifact e a artifact in this case the code generation is in fact applied on all the classes associated to the artifact e a class view the code generation will be applied on all the sub classes then on all the artifacts associated to these classes e a deployment view the code generation is applied on all the sub artifacts e package may be the project itself the code generation will be applied on all the sub class views and deployment views then on all their sub classes and artifacts
12. The disadvantage of this choice in C is to recompile many files when a base class is modified but this allows to define virtual operations managing several classes I do not describe in this documentation all the predefined classes and their operations the better is to look at the model of a new created plug out or to generate the html pages describing it this is done under the empty_html directory the html entry page is index withframe html I also recommend you to look at the plug outs given with the BOUML distribution Nevertheless you have to know e the entry point of a plug out in C and Java is placed in the artifact named Main under USER API refer to it e in C if the C pre processor variables WITHCPP WITHJAVA WITHPHP and WITHIDL are defined using define or D option of the G compiler etc you will get all the informations from BOUML if the C pre processor variables WITHCPP WITHJAVA WITHPHP and WITHIDL are not defined you will access only to UML data this means for instance that the operations cppDecl javaDecl phpDecl and idlDecl will not be defined for UmlBaseClassItem this limits the amount of data managed by a plug out and reduce the execution time and used memory space if only WITHCPP is defined you will access only to UML and C data this means for instance that the operations javaDecl phpDecl and idlDecl will not be defined for UmlBaseClassItem this limits the amount of data managed by a plug out
13. control c is a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them Multiple selection menu select linked items copy selected Ctrit c cut selected Ctriex remove from view remove selected fram view Suppr delete selected Contral d If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally select linked items Copy selected Ctrl c Cut selected Ctri x remove from view Remove selected from view Suppr Edit drawing Settings and for instance when the elements are classes in a class diagram drawing language drawing made show context hide attributes hide operations Multiple selection menu Delete selected Control q IE align top o align bortom E align lett H align right align center F align center verticaly H amp align center harizontaly unchanged unchanged unchanged unchangeds unchanged show members full definitian sunchanged show members visibiliby
14. file C uml BOUML bouml_3 0 doc TOUT html edit allows to show modify the project packages properties with the following dialog here Php is not selected in the top level menu Languages so its tab is not visible Package dialog lt Url c Java IDL User name tri Stereotype 1 This is a HTML documentation generator It is implemented simultaneously in C and Java and produce documentation running over the browser tree description The project s name cannot be changed through this dialog use save as in the project menu The stereotype of the project and packages doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support The C Java Php and Idl tabs visible only 1 these languages are all set in the Languages menu allow to specify the directory where the generation are made and the namespace package module W Package
15. show package context default 1 draw all relations default 1 default class instance default color draw shadow defaut 1 e drawing language to indicate in which language the operations must be written when the full definition is showed see below like for the class drawing in a class diagram For instance the class C has the operation op returning an int supposed translated int in C and Java octet in Idl and having the input parameter p having the type uchar supposed translated unsigned char in C char in Java and octet in Idl Depending on the drawing language 224 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html languages e El B An e ox e se soo 1l Pi EN 3 int op char p FE 4 lang ap in octet p i e show operations full definition to show all the operation profile or just its name may be with the arguments specified at the operation level in the diagram see edit e show hierarchical rank a message may be numbered using its rank a simple number or its hierarchical rank numbers separated with dot e write class instance horizontally To write the instance type and name on the same line or on two lines e package name in tab to indicate if the package s name must be written in the tab which is the small rectangle on the top note a transparent package doesn t have shadow e show packages context to indicate if the context whe
16. show parameter direction show parameter name show information note unchanged unchanged unchanged unchanged 207 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Th settings valuing unchanged are not changed for the selected elements in the other case the same value is set for all the elements Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu Edit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu font b edit drawing settings select linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram
17. 1 Unda all changes Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram may also be done through control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size change the size of the windows to see all the diagram s elements with the current scale 264 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Picture Menu copy optimal picture part Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy visible picture part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size and scale To memorize
18. 244 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only Object diagram menu Edit drawing settings select diagram in browser Select all Ctria Optimal snl i Optimal window size Copy optimal picture part Copy visible picture part Save optimal picture part png Save visible picture part png Save optimal picture part svg save visible picture part svg Set preferred size and scale 3et preferred scale Size unset Restore preferred scale Unset preferred scale Format Unda all changes Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram also done through a control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size Simila
19. C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog amp is lh Ales Umi behavior Bel C save Properties Pre condition Post condition cue Activity call behavior action dialog tab Java This tab allows to specify the pre and post condition in Java but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 45 vp me Umi behavior Bcl c Java Properties Pre condition Post condition Activity call operation action dialog tab Uml Activity Action dialog amp merge Urmi operation Oel C dava Properties name faction Stereotype 1 description Editor Activity call operation action dialog tab Ocl The Ocl tab allows to specify the operation and the pre and post condition using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention 157 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog S mpm pe Umi operation Gel c dava Properties l synchronous Pre condition Post condition The button operation shows a menu proposing e if the current operation is set to select this class in the browser e if the action is not read only and if an operation selected in the browser to set the operation to be the selected one e if the class is not read only to create an operation and to choose it Activity
20. Next Project files 347 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Project files A project is saved in an own directory through several files all of them are text files this may help you to do some searches or changes directly in the files after a backup or of course to use a software configuration management The files are project name gt prj contains the top level package and project level data for instance the generation directories number contains the data of a package an uml package not a java package and its sub elements the package s name is the second saved data after a format indication The number is the package s identifier see Multi users considerations lt number gt diagram contains a diagram definition For time and memory save reason BOUML does not load a diagram until it is edited Th number is the diagram s identifier see Multi users considerations lt number gt bodies contains the C and Java bodies of all the operations of a class For time and memory save reason BOUML does not loa body until it is edited The number is the class s identifier see Multi users considerations generation settings contains the generation settings this allows you to quickly set them after creating a new project copying the generation_settings file of an old project tools contains the plugs outs declaration this allows you to quickly set the tools list after cr
21. an NA dialog E comment E ivisibility f static il ufi nee valatile i aen name 5 velue comment pokl at inal int firme 0 value public static final class binase new S class _S nane care name cretum Bina mpi Th Ficomaentilivisibility B ataticil finalif teansient E volatile B type S nane E valz mulpl cey ficomenti isibility lb staticiltfinalil tcansientil ivolatile typell multiplicity inama fivalon e ab X probably a Sicosmant imibulityjl ataticil Fanallf tzaneientil eolatile f typeif multiplicity inama f valos rape abay Medien E pub c C protected C privet C package F inai Imm ave in ont r yy e see set fin YY Oparation amp iconwent fivisibility ifinal bistatic S ak inition The second Php tab allows to set the default operation definition without the parameters in Php it is visible only if Php is set through the menu Languages 106 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html a GenerationSettings dialog lt gt x Stereotypes C Ceta cenar cesta cent deat Jawata Javas savata Pret Pret jamat Pivieibility f comet fetat ici f ivar f name value ficam Fivisibllity comet P stat iei fiver finas fi value an t name f value Welty shared with Java Meod hes P tesi re fie t Same aso wel p
22. control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c is a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them Multiple selection menu select linked items US align top copy selected Ctri c Qe align bottom cut selected Ctr x remove from view IE align lett remove selected fram view Suppr align right delete selected Contral d align center T align center verticaly e align center horzontaly 219 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally Multiple selection menu select linked items Align Copy selected Ctrl c Cut selected Ctri x remove from view Remove selected from view Suppr Delete selected Control q Edit drawing sett
23. state act default default default default default default default default T file C uml BOUML bouml_3 0 doc TOUT html a Diagram Drawing Settings dialo ow TT class sequence collaboration lobject ster act write name tyne horizontally default show packages name in tab show packages context automatic labels position drew all relations draw shadow show packages name in tab show packages contest automatic labels position write flow label horizantally show opaque action definition draw all relations drew shadow show information nate drawing language default defautt default default default default default default default 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html u Diagram Drawing Settings dialo aos default class color default default note color defaut default package color default default fragment colar default default duration color default default continuation color default default state calor default default state action color default default activity region color default default activity action calor default default parameter and pin color default This dialog allows to specify how the class view s diagrams must be drawn by default Menu delete The menu entry delete is only present w
24. to indicate if the package s name must be written in the tab which is the small rectangle on the top note a transparent package doesn t have shadow e show classes and packages context To indicate if the context where the class package is defined must be written and if yes how The context may be the context which is the path of the class package in the browser or the C namespace or the Java package or at least the Idl module See class context and package context e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited associated class pictures moved etc Browser Menu duplicate Clone the diagram in a new one Browser Menu delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only 236 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc
25. type 1multiplicity name number multiplicity comment case case readonly stereotype type name At least the third Idl tab allows to specify the get and set operations specificities in Idl a GenerationSettings dialog lt dei ce ee em c cts Javati Javatz Javaa Javaj tatiy ioe iata iara Br flcomment cese ilasa Pfiresdoniyltitypel Tinamel mapie t Ur an woe Fus fricomment care ficasze Firesdoniyll ieterectypel fitgpel Finame mahigit Ht o OOOEEEEENILLLLIGIICDGGSI HGGGGGTS B Add ficomment case ficase Fireadoanly fisterectypel Zitypel T imuit ip gobab a default dafiniian name get name iss in ami t ME mss Cnm iHe default definition Operator rt TEE j icmevey Fit yp inamelfttitrift firalisesenilf iraizes mca aor ceca The form in from of also in uml allows to specify the name of the operation in Idl the same rule is followed in UML 1f also in uml is set Drawing A relation is drawn in a diagram with a line may be with an arrow and the associated labels relation s name stereotypes role s and multiplicity ies 71 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Project Windows Tools Miscellaneous Help Diagram a x afk E BEJ a e em ee scaie 100 t El rel B aclass view Bac r ecgeneralisation C3 ered
26. E action 4 eflows There are several kinds of action Bouml doesn t propose all the kinds defined in UML but the main ones opaque accept event read variable value clear variable value write variable value add variable value remove variable value call behavior call operatior send object send signal broadcast signal unmarshall and value specification The pins are added automatically by Bouml depending on the kind of the action for the call behavior and call operation and actions on a variable the pins are set when the behavior operation variable is set or changed When something is changed all the current pins are removed then new ones may be added Note that you may change or delete the default pins or add new ones and the pins are not changed when the corresponding behavior operation variable is modified The parameter sets are defined on the actions and have sense only for call behavior action when the behavior is an activity but this is not checked by Bouml so a parameter set contains pins corresponding to parameters To define parameter sets on action rather than activity allows you to use them as you want The activity action s and pin s properties are exposed below Activity action menus The activity action menu appearing with a right mouse click on its representation in the browser is something like these supposing the action not read only nor deleted see also menu in a diagram add pin add parameter set edi
27. Language see top level menu An operation is created through the class menu called from the browser or a class picture in a class diagram UmlOperation uer eds Ormwing settings UmiOperation ewfryidual airina visibility add anribur dryidua operation visit add operation edt class add inherited operation add aeri add embedded class ent att i add extra member add operation eo add inherited operation turpes ate edt operation P set it embedded in Umi iode select in browser rere seect ined Hema seeC 550cieied component st associated diagram referenced by remove from view man delete fom model generate generate tool e mo The icon in the browser indicate if the operation is public protected private or package The protected and package visibilities are translated in private in Idl The package visibility is translated in private in C and produce nothing in Php allowing you to generate Php 4 code Note that BOUML doesn t check the validity of the re refinition of an inherited operation for instance the visibility is not checked the operation may be final in Java etc but some operations are not part of the proposed operations list the constructors destructors and the operations already defined in the current class for the UML point of view the UML definition of an operation is the one written under the browser window when the operation is selected in the browser A class ope
28. Project Style Help nomefbrunofuml Vodited by Se Inie Modiied by homersruno Pev Mocited by 5 Mor bruna 2 bruno 2 fred 3 3 Package bruno 2 G a 0 alain 4 Package bruno 2 B Package bruna 2 BL Package bruno 2 BJPackagez bruna 2 JPackage bruna 2 Package Bruna 2 Package Bruna 2 JPackage1 Package1 Package B jPackaged bruna 2 B L Package3 bruna 2 Package bruno 2 Packager bruna 2 Package 1 bruno 2 MEPa ckagel bruna 2 JjPackage4 Package4 Packages EI Fackage3 Packages alain 4 E Package ea amp JPackage3 ea BiPackage Ba Brackage B jPackages Bl Package Packages BL Packages i L Gite CiPackagea fred 3 4 need update 1 deleted 3 need update 1 deleted RO 1 need update As you can see incl is gray indicating it was deleted and the project itself was modified at least to remove incl On the bottom of each image you have the number packages whose need to be updated or deleted The indication RO means that at least one file of the project image is read only in this case the image can t be synchronized even if the file correspond to an up to date package When enough images was load you can ask for the synchronization through the menu Project or the shortcut control S A dialog appears z SSL ee ERE Synchronize lt 3 7 Tr Choose the projects
29. The plug outs are the external programs written in C or Java interacting with BOUML these programs may be written using BOUML itse previous chapter describe some plug out including the code generators and code reverse A plug out is a very practical way to automatize treatment on the model do not hesitate to write plug out I just recommend you to save your model before executing your plug outs when you debug them Declaring a plug out To be executed a plug out must be declared through the tool dialog called when you select the tools settings entry of the tools menu a Locks ELEY REA HTMIL dac flat Generale ora import Rose Generate XI The first column specify how the plug out is executed for a C program you just have to give its name and may be the path depending on your environment in Java the cp option allows to specify the path and the starting class is Main except if you change the definition of the executable artifact The content of the second column will be displayed in the menu when your plug out is applicable on the target item The other columns allows to specify the kind of the items on whose the plug out is applicable For instance below gpro may only be applied on a artifact Note that the declaration of the plug out is saved in the file named fools this allows you to quickly set the tools list after creating a new project copying the tools file of an old project this file is read when you load t
30. default draw shadow default default component color default draw component as ican default i default package calor default show component s required and 3 default provided Interfaces default fragment calor default show component s realizations default OK Cancel OK Cancel e package name in tab to indicate if the package s name must be written in the tab which is the small rectangle on the top note a transparent package doesn t have shadow EN 281 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e show packages context to indicate if the context where the package is defined must be written it is not the case just above The context may be t UML context which is the path of the package in the browser choice followed for awt below or the C namespace specified by the package or the Java package specified by the package choice followed for picture below or at least the Idl module java ew image javg awtimage e write node instance horizontally Allows to write the the node type and the instance name on the same line see host below or on two lines see laserwriter below e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in the diagram when the relation is edited or the linked items moved etc Browser Menu duplicate Clone the diagram in a
31. default fragment color default write transition horzontally default 1 default subject color default show transition definition default draw all relations defautt 1 default continuation color default draw share default 1 default default class instance color ee RN E default state color default draw state s regions horizontally default 1 default state action color default drawing language default default activity color show packages name In tab defauit 1 default note colar default default duration colar default default Cancel Cancel default activity region color default default activity action calor default default parameter and pin color default This dialog allows to specify how the sub diagrams must be drawn by default Menu delete The delete entry is only present when the package is not read only Delete the use case view and all its children and all the representation of them in the opened diagrams After that it is possible undelete them from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Menu tools The menu entry tool not present above is present in case at least a plug out may be applied on the use case view 32 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Previous package Next class view 33 of 357 07 10 2007 1
32. delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only 254 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Edit drawing settings Select diagram in browser Select all Cirlea Optimal scale Optimal window size Copy optimal picture part Copy visible picture part Save optimal picture part pre Save visible picture part png Save optimal picture part svi Save visible picture part wg Sel preferred size and scale sel preferred scale size unset Restore preferred size and scale Unset preferred size and scale Format k Unda all changes Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram may also be done through control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s el
33. e f inherit is replaced by the inheritance e members is replaced by the code generated for all the class s members relations attributes operations and extra members following the browser order e switch only for the unions is replaced by the union switch type e items only for the enums is replaced by the enum s items definition e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the class if not found for the container of the class an other class of a class view etc Operation The Idl definition of an operation is set through the Uml and Idl tabs of the operation dialog The indentation of the first line of the declaration definition give the indentation added to the class definition for all the oper definition In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Idl code generator are e comment is replaced by the description of the operation adding e description is replaced by the operation description without adding e oneway produce oneway when the operation is oneway e type is replaced by the value type see the UML tab e name is replaced by the name of the operation e and produce and but there are also a mark for BOUML to find the parameters list e t n and p lt n gt produce the type and the name of each parameter count from 0 this all
34. from the browser until y close the project obviously the deleted items are not saved Menu mark 199 of 357 07 10 2007 16 00 See mark Menu tool Appears only when at least one plug out is associated to the nodes To apply a plug out on the node Default stereotypes file C uml BOUML bouml_3 0 doc TOUT html The dialog allowing to set the default stereotypes has a tab reserved for the components Drawing A component is drawn in a deployment diagram as a parallelepiped depending on the drawing settings A right mouse click on a node in a diagram calls the following menu supposing the node editable Menu edit drawing settings Default stereotypes dialog 53 TTT Package class UseCase Views Diagrams Others ees l actor wer l f toute liinan eicumooe hode cpu device stereotypes cue a Deployment Diagram Upper lower edit edit drawing settings select node in browser select linked items set node associated diagram remove from view tool These drawing settings concerns only the picture for which the menu is called 200 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a node in a diagram all the settings are s
35. html a GenerationSettings dialog m nimi s ct ce tzl ceta cta c ts Java 1 Jevat avers Javeta Phor Phora iau RE comment visibility const istat Sivar name value comment f ivisibilityif comet F letatic Ft vari f iname t value Enumeration tem Comet Fimamel Fi value comment default definition et operation T default definition also in uml Set operation Visibility shared with Java Madifiers T default definition public protected C private T final nome 50 in um froomment fifinalifivisibilityrifiabetractlistaticifuncti n Finami tiii fiboaly GenerationSettings dialog Stereotypes c tu c cta cesa cts Javati Javarz Java 3 Javaj Idi 1 multiplicity 1 comment ireadonly attribut Itype inamel or unspecifie multiplicity comment fireadonly attribute stereotype cs itype i name or a b X probably a comment readoniy attribute stereotypel itype multiplicity name number multiplicity 1 comment visibilityl type name or unspecifie Attribute default declaration in valuetype multiplicity comment ivisibility sterectype lt typel iname nr a b X probably a comment visibilityl stereotype typel multiplicitv name number multiplicity Flcomment const S type S namel ivaluel or u
36. lt unchanged gt show context unchanged hide attributes unchangeds hide operations unchanged show members full definition lt unchanged gt show members visibility lt unchanged gt show parameter direction unchanged show parameter name sunchanged show information note sunchanged valuing file C uml BOUML bouml_3 0 doc TOUT html lt unchanged gt are not changed for the selected elements in the other case the same value is set for all the elements Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu E dit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window to end the edition 259 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html ais bouml 5 bic saab te A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu font b edit drawing settings select linked items remove from view The font may be changed by def
37. see the UML tab e name is replaced by the operation s name e class is replaced by the name of the class containing the operation e and produce and but there are also a mark for BOUML to find the parameters list e abstract produce the string 0 when the operation is abstract see the UML tab e staticnl produce a line break when the operation is static else an empty string e t n and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter add type modifiers etc e throw is replaced by the form throw when at least an exception is defined in the UML tab It is also possible to produce throw when there is no exception depending on the generation settings body is replaced by the body of the operation this macro may also be replaced by the body itself BOUML use this way for the get and set operations associated to a relation attribute The usage of body has a great advantage when you hit Default definition or From declaration the body is not cleared At least BOUML share the declaration and definition forms of the operations and other object minimize the needed memory size body help for this The indentation of the keyword body is added at the beginning of each line except the ones starting by a or when the previous one ends by V xyz is replaced by the user property value in case xyz is the key of this property The pro
38. to show or not the conditions drawing language Allows to specify the used language used to indicate opaque action behavior or the conditions action color To specify the fill color Menu select X in browser action color default Ok Cancel Appears only when the action is associated to a variable behavior or an operation to select this one the the browser Menu select associated diagram from behavior Appears only when the action is a call behavior and the behavior an activity or a state has an associated diagram set this last to be the diagram associated to the action this allows to goes to the diagram associated to the behavior on a double click on the action Menu tools 166 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Appears only when at least one plug out is associated to the activity actions To apply a plug out on the activity action Pin drawing A Pin is drawn as a small square with the stream or exception indication istream A right mouse click on a pin in a diagram calls the following menu supposing the pin editable upper lower edit drawing settings edit pin select in browser select class in browser select linked Items delete fram model Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level
39. transformation Editor The weight guard selection and transformation are the standard UML properties of a flow Flow dialog tab C This tab allows to give the C definition of the flow but in fact BOUML doesn t check the syntax this is just a convention 178 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Flow dialog ml Jel ieen Java Properties weight guard Editor selection Editar transformation Editor Flow dialog tab Java This tab allows to give the Java definition of the flow but in fact BOUML doesn t check the syntax this is just a convention Flow dialog ml oc e Jav Properties weight guard Editor transformation n s lection Editor Editor Menu delete The menu entry delete is only present when the flow is not read only Delete the flow associated get and set operations when they exist and all the representation of them in the opened diagrams After that it is possible to undelete them from the browser until you close the project obviously the deleted items are not saved Menu select X To select the target of the flow Menu mark See mark Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the flows 179 of 557 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog Rs cale
40. uml BOUML bouml_3 0 doc TOUT html show packages name in tab no show packages context automatic labels position write transition horizontally show transition definition draw all relations show state activities drawing language default package color ris snarent default fragment color Transparent default subject color Transparent default use case color 4 default duration color Transparent default cantinuation color 1 default component color default artifact color default node color 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html a Diagram Drawing Settings dialo sb aibs default state calor default state action colar Transparent Ji default activity color Transparent default activity region color Transparent default parameter and pin color C default activity action calor Transparent This dialog allows to specify how the diagrams must be drawn by default at the package level you may specify all the drawing settings because a package may contain indirectly all the kinds of diagram Except at project level you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level Refer to drawing for the settings concerning the packages Menu import Allows to import the generation settings ex
41. valuetyne valuetyng ignored The second C tab allows to define the default C class definition depending on the stereotype 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html GenerationSettings dialog 2 AT nana ei iaheriil I members Class default inlines declaration Ficomment template struct iname inherit 5 members struct default inlines declaration Sicomment template union name I5 members Union default 1i1n1ines declaration 1comment enum namel items Enum default declaration comment typedef Fitypel F name Typedef default declaration The first Java tab allows to define the default Java class definition depending on the stereotype GenerationSettings dialog 2 P comment ie arini f ipactsagel corte Pe importtal det init ion comment public final labstract class S name extends implements Class default E members declaration commenti public interface name extends Interface default t members declaration S comment public final abstract enum name implements Enum default 5 i1tema declaration amp i members m 5icommenti public final class name E Enum pattern members default declaration private int value ASS efit RI J ficommeotif eisibilitylfisetatic Fifinalifitransi
42. void html in string pfix in unsigned long rank in unsigned long level raises IOException Resull afar subsBlutian Defautl declaration Mot generated in Idi In BOUML the generated code is obtained by the substitution of macros in a text only the Definition part is editable the other one help you to see what will be generated for Java supposing you do not modify the Java code generator When you push the button Default definition the form specified through the generation settings 1s proposed adding all the operation parameters given in the UML tab These forms may be modified as you want even to produce illegal source code When you do not want to have this operation defined in Java empties the definition manually or using the button not generated in Idl oneway produce an empty string when the check box oneway is not checked else produce oneway type is replaced by the value type see the UML tab name is replaced by the name of the operation and produce and but there are also a mark for BOUML to find the parameters list t n and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter add type modifiers etc raise is replaced by the form raise when at least an exception is defined in the UML tab raisenl produce a line break when the operation have exception else an empty string In case you do not like this n
43. 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Sequence diagram sequence Diagrams 3 opzip1 int pz ficat da context danefcontest opzi 123 The sequence diagrams may be placed in a use case view or a use case E external events ESOverall E Piston Piston set amp Piston clear A sequence diagram is created through the new sequence diagram entry of the use case view and use case browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings duplicate delete mark tool Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only sequence diagram dialog tab Uml 210 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Sequence diagram dialog amp i mm tha Umi User narme Piston set Stereotype 1 description Editar caen The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning f
44. BOUML package containing the deployment view where the artifact is defined e definition is replaced by the definition of the classes associated to the artifact e module_end is replaced by dependent on the module specifications associated to the BOUML package containing the deployment view where the artifact is defined e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the artifact if not found for the deployment view containing the artifact if not found in the package containing the deployment view etc Class The Idl definition of a class is set through the Uml and Idl tabs of the class dialog A Idl type definition may be a valuetype an interface a struct an union an enum an exception or a typedef defined through depending on the stereotype and its translation in Idl see generation settings In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Idl code generator are e comment is replaced by the description of the class adding e description is replaced by the class description without adding e abstract only for the valuetypes produce abstract when the valuetype is abstract e custom only for the valuetypes produce abstract when the valuetype is custom e name is replaced by the class s name 312 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html
45. BOUML bouml_3 0 doc TOUT html Component diagram dialog x Umi User name Diagram Stereotype 1 description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level diagram color diagram colar packages name in tab default show package context default default note calor default autom
46. C see generation settings In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the C code generator are e comment is replaced by the description of the class adding e description is replaced by the class description without adding e template produce a template declaration in case the class is a template class e name is replaced by the class s name e finherit is replaced by the class inheritance e members is replaced by the code generated for all the class s members relations attributes operations and extra members following the browser order e items only for the enums is replaced by the enum s items e xyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the class if not found for the container of the class an other class of a class view etc In the special case where the class is declared external its C type declaration must contains at least one line indicating how the name of the class is generated the other lines will be added in the header file of the components referencing the class By default the first line only contain name meaning that the name is produced unchanged the only allowed keywords are name Name and NAME For instance you want to define the external class string and you want to automatically generate Zinclude lt string gt followed by using namespace
47. F const name set name F also in uml Modifiers name sets name also in umi st fitypel 4 tic J d fitype d Fitype ifriendifistaticifivirtualifitype PF imame 070 01 t comet Fiwolet ile f throw f ietetr liniine fitypel Ficiagei iii inamel FLUCH D I E Loonati PF wolatilel throw F stat Lon f ibody The second Java tab allows to set the default definition of an attribute in Java only visible when Java is set through the menu Languages 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html 4s GenerationSettings dialog 3 2 9 LL Types Stereotypes cet c ceta 613 cnt devant Jovatz Javaa Javaj te iet ioi iata tats Description bi comment Sivisibility static final transient volatile itype iname ivalue amp comment a visibility static finall transient volatile stereotype name value Attribute multiplicity default pr declaration coment ia visibility istatic final transient volatile type multiplicity namel val X probably a number j ccumentiftivisibilitylfistaticififinal f transient f volatile tityppe finamelf value Asvyocafin and lRicomment T ivisibilityifistatieci f ifinalifitransienti f ivolatile f stereotypel finame f value S Lecomment f ivisibilitylfigtaticilifinallfB itrangient f ivolatite fi typelf Umuitipiicity n
48. For instance if you define the stereotype eiu which is translated by enum in C interface in Java and union in IDL through the generation settings you will have exactly that you want magic isn t it The stereotypes known at each language level by BOUML are e C class or empty stereotype enum struct typedef and union e Java class or empty stereotype enum enum pattern interface and interface e Php class or empty stereotype enum interface 46 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html e dl enum exception interface struct typedef union and valuetype The class s properties will be exposed below Menus The class menu appearing with a right mouse click on its representation in the browser depend on the stereotype and the artifact association it is something like these supposing the class not read only nor deleted see also menu in a diagram Enum EnumPattern add attribute add item add operation add attribute edit add nested class add operation duplicate add extra member add extra member edit edit create source artifact duplicate duplicate referenced by delete delete create source artifact select associated artifact referenced by referenced by mark mark generate generate tool tool Menu add The first entries of the menu allowing to add something may not be present depending of the class s stereotype Menu edit edit allows t
49. Remove diagram association Remove from view Delete from model Generate oca Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add an artifact in a diagram all the settings are set to default Diagram Dice color artifact color detaut 1 OK Cancel Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the artifact representation in a diagram or the browser After that the only way to edit the artifact is to choose the edit entry in the menu Menu remove diagram association To stop to associate a diagram to the artifact AB Previous component Next deployment node 198 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Node Nodes are used to specify how the deployment is made a node may represent a CPU a device etc E Bia Deployment view fla Deployment Diagram l epuss a Node Cl device an other Mode A node may be created through the new node entry of a deployment view or through the component button of a deployment diagram Menus The node menu appearing with a right mouse click on its representation in the browser
50. TOUT html Class diagram menu Edit drawing settings select diagram in browser Select all Ctri a Optimal scale Optimal window size Copy optimal picture part Copy visible picture part save optimal picture part png Save visible picture part png Save optimal picture part svg Save visible picture part svg Set preferred size and scale set preferred scale size unset Restore oreferred size and scale Unset preferred size and scale Format Unda all changes Picture Menu add classes of the selected class view Only appears when a class view is selected in the browser all the classes of the class view whose are not yet present in the diagram are added in the diagram allowing to not have to do several drag amp drop from the browser to ass these classes but the position of the classes 1s probably not the good one Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram may also be done through control a Picture Menu optimal scale Similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size Similar to the button H change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy optimal picture part Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture pa
51. View EHC use Case 1C 2sub seCase p generalizalion use case ependency uc actors anActor Hatsa Hjatassinstance Aass falUse Case Diagram Sequence Diagram Collaboration Diagram actors AnActor H Actass FAladassinstance Alass Fuse Case Diagram EX Sequence Diagram F2 Collaboration Diagram object Diagram Ef esuh Use Case View Exluse Case Diagram EH Pgldass view amp Bladass ganALtribule t eneneralisation Aclass RA unidirectinal association gt ovanOperation wx Ejadassinstance ACIass f class Diagram Object Diagram Ei Sequence Diagram x Collaboration Diagram OBCO machings AStateMachine EH AState ngon region COsesubimachinge ASub Machine 4 State Diagram E t transitions COuentry pnt B x kt i e UT Z receive sinals C simd signal s B SAnArctivity Sslnctivity Diagram aParameter EI Chan interruptible region Sha nested Interruptible region a nested expansion region San accept event action s einterruptss flow Giman expansion region sam expansion node ima nested expansion region Ca nested interruplible region file C uml BOUML bouml 3 0 doc TOUT html 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html ECan action ps 2 an olher pin H a parameter set orosflow T dependency other Package E a send signal action u target A ai accept event action timer Jan activity object j d
52. You are not limited to the proposed list and any form even invalid for the target language s may be given The button type shows a menu proposing e if the current type of the expansion node is a class to select this class in the browser e if the expansion node is not read only and if a class is selected in the browser to set the type to be this class The multiplicity ordering in state and is control are the standard UML properties The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi 144 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Expansion node dialog tab Ocl The Ocl tab allows to specify the selection using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention Expansion Node dialog 2 ap ah i lea Um ot c Java Properties selectian OK Cancel Expansion node dialog tab C This tab allows to specify
53. a Makefile for a C or Java program Previous Html documentation generator Next Rose project import 324 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Rose project import This plug out is developed using BOUML in C As it is signified by its name this one import a Rose model from its mdl and associated files into BOUML in the package project where it is launch This plug out is under development actually the imported diagrams are created empty the BOUML s API doesn t yet allows to modify then Actually the reverse C doesn t allows to complete the imported model with the files generated by Rose BOUML manages the case of the controlled packages through a cat or a sub files find through a variable rather than a fixed path When a variable is not an environment variable BOUML ask for its value only one time or course BOUML write a message into the tool window each time it cannot import something Previous genpro Next Plug out upgrade 325401 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Plug out Upgrade When new features are introduced in BOUML these ones are not managed by your now old plus outs to automatically upgrade them the distribution of BOUML contains the upgrade plug out Its goal 1s to upgrade the plug outs not made from the last up to date version of the plug out empty adding the missing features It is applied through the entry plu
54. a stereotype for each direction of a bi directional relation frankly I avow that the main reason is to simplify as it is possible the drawing of the relations in the diagrams with the associated labels In the browser are written the name of the relations by default its kind between parenthesis the role s of the association aggregations the end class of the generalization realization and dependency The stereotype may be may be showed hidden throug the Miscellaneous menu The name of a relation is not used by the code generators Project Windows Jools Miscellaneous Help Diagram a xf i A efe BOE a e e ee O H aie scaie 100 t E rel B aclass view BAC r generalisation C3 radir a self bi dir radir b self bi dir irigiidsse dir b thet theCz r ratheC CandC2 se bi dir p seWf mono cr BEC dire a rathec CandCz xii raa self mono dir racefriend lt dependency gt C3 ica EXDiagram 4 Generally the relation s stereotype is used to specify how a relation with a multiplicity different than 1 is translated in each language for instance to produce a vector The friend stereotype is a special case for a dependency and is used to produce a C friend declaration There are several kinds of relation e generalization to produce an inheritance e realization produce also an inheritance the code generators do not distinguish a realizatio
55. and any form even invalid for the target language s may be given The button type shows a menu proposing e if the current type of the parameter is a class to select this class in the browser e if the parameter is not read only and if a class is selected in the browser to set the type to be this class The direction multiplicity ordering effect in state default value is control unique exception and stream are the standard UML properties The flags exception and stream are exclusive choose standard to be not exception nor stream The editor button visible above and associated here to the default value and description allows to edit the default value or the description in other window or to call an external editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog closed I do not like very much this polling but this works even QT isn t compiled with the thread support parameter dialog tab Ocl The Ocl tab allows to specify the selection using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention 135 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Parameter dialog E Lim
56. and reduce the execution time and used memory space if only WITHJAVA is defined you will access only to UML and Java data this means for instance that the operations cppDecl phpDecl and idlDecl will not be defined for Um lBaseClassItem this limits the amount of data managed by a plug out and reduce the execution time and used memory space if only WITHPHP is defined you will access only to UML and Php data this means for instance that the operations cppDecl javaDecl and idlDecl will not be defined for UmlBaseClassItem this limits the amount of data managed by a plug out and reduce the execution time and used memory space if only WITHIDL is defined you will access only to UML and IDL data this means for instance that the operations cppDecl javaDecl and phpDecl will not be defined for UmlBaseClassItem this limits the amount of data managed by a plug out and reduce the execution time and used memory space the other combinations where only two of these three pre processor variables are defined are illegal 334 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Typical Execution fe E Eo mwueebe amp x scate 100 E fe HE boumi s to get the item an plug out i which the plug aut main 2 part number l __ 4 ls applied you may ere also get the market tems with BOUML bo get items definitions and execute Applicative commands part of the are not shown plug out Updating a plug out See u
57. and set operations associated to a relation attribute The usage of body has a great advantage when you hit Default definition the body is not cleared At least BOUML share the definition forms of the operations and other objects to minimize the neec memory size body help for this The indentation of the keyword body is added at the beginning of each line The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted The edit body button is active when the definition contains body to edit it through the editor you want define the environment variable BOUML_EDITOR furthermore when you set add operation profile on body edition through the miscellaneous menu the form defining the operation in the editor is added at the beginning of the edited file Operation dialog tab Idl 103 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html This tab allows to give the Idl declaration of the operation it is visible only if Idl is set through the Language menu Cpu mte Ee A n oe aes Lien ce Java Idi Properties oneway E comment S onaway S type S rameys is dO Eyed p Sf dl Eiti S pij dZ S t2 sipeys is rarseanl raises Declaration fantry to produce the html code receiving chapter number fpath rank in the mother ond level in the browser tree
58. are available for the component Store because Customer and Order are nested in Store The scale may be changed from 30 up to 200 To allows to see the relation kinds even with a small scale the size of the arrows is unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may 276 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c is a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control
59. associa Ecz After the duplication of C into the new class C3 Project Windows Tools Miscellaneous Help lud bp ww Diagram 4x El clone afe E OBE oe D io E ti E B aclass view A d amp Diagram B BICI mat peop t lt lt st gt gt the e25s lt unidirectio raself cunidirectional associati BE SC sec unidirectional associa ECZ BE ca hcclist gt gt the czs unidirectio reself lt unidirectional associati BEB xie sc1 unidirectional associa M dE Note that the duplication of the relation c of C3 SC is still a relation to C1 because only the self relation are specially managed not all the relation to the duplicated class the context of the inner class es SC is visible thanks to the drawing setting show context and also to the inner class relation Menu create source artifact The menu entry create source artifact is present when the class does not have an associated artifact but the class view containing the class have an associated deployment view Choosing this entry a new artifact having the name of the current class and the stereotype source is created in the deployment view associated to the class view containing the current class To quickly create is needed the associated deployment view and associate an artifact to all the classes of a class view use the plug out deploy Menu select associated artifact This menu entry is present when the class have
60. attribute in a valuetype In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Id code generator are e comment is replaced by the description of the relation adding e description is replaced by the relation description without adding e visibility produce the visibility see the UML tab e type is replaced by the name of the class pointed by the relation see the UML tab e name is replaced by the role s name see the UML tab e stereotype is replaced by the translation in Idl of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the relation if not found for the class containing the relation etc Relation equivalent to an attribute in an union In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Id code generator are e comment is replaced by the description of the relation adding e description is replaced by the relation description without adding e readonly produce readonly when the relation is read only see the UML tab 315 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e type is replaced by the name of the class pointed by the relation see the UML tab e name i
61. attributes starting by _ without collision For instance in case you apply the state machine generator on the following state machine Bouml home bruno uml EX state state prj 5 bes ples Project Windows Jools Miscellaneous Help ie Md amp BW brawser Diagram Lab xl E state T IS Sener e pgozeoeesxeee SX pORD m es E FajGass view EC eamachinme Read mount ReadAmnount K piagram i machine 5 selec tAmnournt otherAmount r amount t abori 1 _lenterAmount t abari t Ok d abort E 23 F I C machine SM REM No E Jeemarhine s telephone IC emachines Processes Lal aj you will obtain these definitions 318 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html E gcass view E34 Jeemachine ReadAmount Ejximramwnouyt Bt Any Safe BEB ReadAmaount State EH ER seleclAmount State rxipeneralisations Any Stale pocatherfumaunt mamout asabort OW upper E SeenterAmount_State t xigeneralisations Any State cabort D upper Rmm seleclamuount state Je enteramountl state t chentralisalions Any siale wscreate em xit Oe upper Gem readamount state pos Resul mount pos therPimount Geanount Dscreale BW sel currentstale Bm final pi Curren stale directional aggregation Having an instance of ReadAmount you must first call create to execute the initial transition then you may call otherAmount etc When you modify the state mac
62. bouml 3 0 doc TOUT html Object Diagram scale TOO E nts Se Evelyne Person wife husband hobby painting hobby electronic An object diagram may contain classes instances notes texts diagram icons packages fragment and links To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram To show a relation between two class instances add a link between the instance then edit the link through a double click or throug right mouse click The scale may be changed from 30 up to 200 To allows to see the relation kinds even with a small scale the size of the arrows is unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut
63. by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Refer to the generation settings and Java generator for more details and explanation of the other keywords Relation dialog tab Php This tab allows to give the Php definition of the relation it is visible only when Php is set through the Languages menu Liml ce Java Php io Properties inc f comment visibility S const static fi var S name value Declaration var fthec2 Result after substitution Default declaration Not generated In Php comment visibility const static var name value Declaration i protected theC Result after substitution Default declaration Not generated in Php In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for Php supposing you do not modify the Php code generator When you push the button default declaration the form specified through the generation settings depending on the stereotype and multiplicity and of course the language is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this relation defined in Php empties the declaration manually or using the button not generated in Php It is possible to fo
64. call an external editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very much this polling but this works even QT isn t compiled with the thread support The default button visible above associated to the description allows to set the description with a default contain specified through the generation settings Useful to generate comments compatible Java Doc or Doxygen for instance Attribute dialog tab C 83 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html This tab allows to give the C definition of the attribute it is visible only when C is set through the menu Languages For a standard attribute Attribute dialog T m Wml E Java Idi user Visibillby follow uml orotected C public protected private T mutable comment istaticl mutable volatilel const type inamel ivalue Declaratian the name of the stop Reeds are trumpet cromorne Flutes are bourdon rhorflote Result after Principal are montre prestant substitution Strings are viola unda maris Mutation are nazard thierce Compound are mixture cornet s
65. call operation action dialog tab C This tab allows to specify the pre and post condition in C but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 npe rye Umi operation Ocl C Javg Properties Fre condition Post condition Activity call operation action dialog tab Java This tab allows to specify the pre and post condition in Java but in fact BOUML doesn t check the syntax this is just a convention 158 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog amp is lh Ales Umi operation Ocl c Java Properties Fre condition Post condition cue Activity send object action dialog tab Uml Activity Action dialog 5 mp rl oct Java Properties name action stereotype 1 description Editor Activity send object action dialog tab Ocl The Ocl tab allows to specify the pre and post condition using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 is sah yE Limi gel crs Java Properties Fre condition Post condition Activity send object action dialog tab C This tab allows to specify the pre and post condition in C but in fact BOUML doesn t check the syntax this is just a convention 159 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html
66. case for more information EJ Class A class is the support to define a class an interface an enum an union a struct an exception or a valuetype depending on the language The stereotype specify what a class is the way a stereotype is translated for each language may be specified through the generation settings Of course a class is also a browser container and may contain e nested classes e relations e attributes e operations e extra members The order of the class s sub items is very important because it is followed by the C Java Idl generators Refer to class for more information Relation They are two kinds of relation the relations between classes whose are considered by the source code generators and the relations between the other items inheritance and dependency To add a relation you have to use a diagram obviously the relation drawing may be deleted just after it is not possible to adc relation through the browser It is also not possible to move a relation out of the items containing it The icon in the browser indicate if a relation between classes is public protected or private The protected visibility is translated in private in Idl A bi directional relation between classes is supported by two items in the browser Generally the stereotype of a relation between classes is used to specify how a relation with a multiplicity different than 1 is translated in each language refer
67. case nested in an other one in the browser is a practical way when a use case is refined into sub use cases The relations between use cases presented in the browser are the inheritance and dependency Menus The menu appearing with a right mouse click on a use case in the browser are something like this supposing it is not read only nor deleted Menu edit Edit drawing settings Delete New use case diagram New sequence diagram New collaboration diagram New object diagram New use case New actor New class Mew class instance New state machine New activity Edit Referenced by ies Tool b edit allows to show modify the use case properties with the following dialog 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Umi Properties name fkey dawn stereotype 1 extensian points key is pressed down description Depending on the used keyboard pedalboard their coupling and the set stops none or several pipes will sin Editar CE 3 The stereotype of a use cases doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description it
68. click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu Overall short cul upper lower open select diagram in browser select linked Items remove from view The other diagram s elements have an own chapter refer to them Previous sequence diagram Next class diagram 233 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Class diagram organ ab x eal amp al 9D scale 10 t ne a The class diagrams may be placed in a class view E EgClass view amp lconsole A class diagram is created through the new static class diagram entry of the class view browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted edit edit drawing settings duplicate delete mark tool Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only class diagram dialog tab Uml 234 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Class diagram dialog pe een ey pore Url U
69. contains e state diagrams e sub states e regions e pseudo states e transitions e actions e receive signals an action with the stereotype receive signal e send signals an action with the stereotype send signal Refer to state and for more information Pseudo State A pseudo state may be final state for reasons of simplification 9 initial 9 deep history 9 shallow history iP join fork iunction 9 choice entry point exit point X terminate 16 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html A pseudo state may contains e transitions Refer to pseudo state for more information 3 Activity An activity may contains e activity diagrams e parameters e activity nodes e expansion and interruptible activity regions Refer to activity for more information om Expansion region An expansion region may contains e expansion and interruptible activity sub regions e om expansion nodes e control nodes e action nodes e object nodes Refer to region for more information C Interruptible activity region An interruptible activity region may contains e expansion and interruptible activity sub regions e control nodes e action nodes e object nodes Refer to region for more information Activity node An activity node may be gt activity action opaque accept event 2 accept timer event read variable value clear variable value write variable value add variab
70. d EG drawing setting and for instance when the elements are classes in a class diagram The Note drawing language unchanged drawing mode lt unchanged gt show context unchanged hide attributes unchanged hide operations unchanged E show members full definition unchanged show members visibility unchanged show parameter direction unchanged show parameter name sunchanged show information mote lt unchanged gt valuing are not changed for the selected elements in the other case the same value is set for all the elements align center file C um BOUML bouml 3 0 doc TOUT html unchanged A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window to end the edition 250 of 357 XS boum Quake 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu font edit drawing settings select linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one
71. diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy visible part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale 213 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By defa
72. diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove from view The other diagram s elements have an own chapter refer to them Previous collaboration diagram Next object diagram 242 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Object diagram Objpect Diagram The object diagrams may be placed in a use case view a use case or a class view False Case View BlObject Diagram HCOUse Case Object Diagram E giClass view fObject Diagram An object diagram is created through the new object diagram entry of the use case view use case and class view browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings duplicate delete mark tool L Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case th
73. dialog allows to specify how the deployment diagrams must be drawn by default draw all relations default Menu delete The menu entry delete is only present when the class view is not read only Delete the deployment view and all its children and all the representation of them in the opened diagrams After that it is possi undelete them from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Menu tools The menu entry tool not present above is present in case at least a plug out may be applied on the component view The selected tool is called and applied on the current deployment view Previous component view Next use case 07 10 2007 16 00 42 of 357 Use case file C uml BOUML bouml_3 0 doc TOUT html In the browser an use case may contain other use cases actors classes stereotyped actor classes class instances state machine activities use case diagrams sequence diagrams collaboration diagrams object diagrams and the relations in any order Gl s external events Overall amp BCPiston F2lOverall E cokey down Fikey down 5 lt cactor gt gt organist lH Stop EiFlute Stop on great on swell ton positiv on pedal Pelkey down fS Sequence Diagram fBloObject Diagram egeneralization on great m generalization on swell generalization on positiv generalization on pedal Define a use
74. edit the region is to choose the edit entry in the menu Menu tools Appears only when at least one plug out is associated to the regions To apply a plug out on the region 5n Interruptible region drawing An interruptible activity region is drawn in a diagram as a dashed rectangle with rounded corners A right mouse click on a region in a diagram calls the following menu supposing the region editable interruptible reglon 1 upper lower edit drawing settings edit Interruptible activity region select In browser set associated diagram remove from view delete from model Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a region in a diagram all the settings are set to default Interruptible activity region color default To specify the fill color 148 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the region representation in a diagram or the browser After that the only way to edit the region is to choose the edit entry in the menu Menu tools Appears only when at least o
75. extra member After that it is possible to undelete it from the browser until you close the project obviously the delet items are not saved Menu mark See mark Menu tools Appears only when at least one plug out is associated to the extra member To apply a plug out on the extra member Previous operation Next class instance 114 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Class instance A class instance may be placed under a class view a use case view or a use case Menus The class menu appearing with a right mouse click on its representation is something like this supposing the instance not read only nor deleted see also menu in a diagram E dit Duplicate Delete Referenced by Menu edit edit allows to show modify the instance properties In case the class is read only the fields of the dialog are also read only Class dialog tab Uml i3 Class instance dialog mi Attributes Relations Properties name pascal stereotype class Man 1 description Editor The button class shows a menu proposing e to select in the browser the class of the instance e if the instance is not read only and if a class is selected in the browser to set the class of the instance to be this class e if the view containing the class containing the instance is not read only to create a new class and to set the attribute type to it The editor b
76. for an artifact looks at the package containing the deployment view where is the artifact to get these information Refer to package for more information Fs Use case view A use case view may contain 07 10 2007 16 00 14 of 357 e sub use case view e use cases e classes an actor is just a class having the stereotype actor e class instances e states e activities e use case diagrams e object diagrams e sequence diagrams e collaboration diagrams Refer to use case view for more information Class view A class view is used to design the classes and may contain e classes e class instances e states e activities e class diagrams e object diagrams e sequence diagrams e collaboration diagrams Refer to class view for more information Component view A component view may contains e components e component diagrams Refer to component view for more information Deployment view A deployment view may contains e nodes e artifact e deployment diagrams Refer to deployment view for more information t 2 Use case A use case is a use case but also a browser container and may contain e usce cases file C uml BOUML bouml_3 0 doc TOUT html 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e actors e classes e class instances e states e activities e relations e use case diagrams e object diagrams e sequence diagrams e collaboration diagrams Refer to use
77. here the diagram must be followed obviously this one may also be default up to the project level When you add a pin in a diagram all the settings are set to default Diagram Dri cool as aye color pin colar default o c To specify the fill color Menu select class in browser Appears when the type of the pin is a class to select it in the browser Menu tools Appears only when at least one plug out is associated to the pins To apply a plug out on the pin Parameter set drawing A parameter set is a rectangle drawn around the corresponding pins it is highly recommended to place the pins on the same are to have a pretty result pin other pin A right mouse click on a pin in a diagram calls the following menu supposing the pin editable 167 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html edit drawing settings edit parameter set select in browser delete from model Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a set in a diagram all the settings are set to default parameter set color default To specify the fill color Menu tools Appears only when at least one plug out is associated
78. icon Text Text is another way to write a text contrary to the note a text is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu 208 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Upper lower edit font remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove fram view The other diagram s elements have an own chapter refer to them Subject A subject is drawn as a rectangle to set modify the title do a double left mouse click on the representation or call the menu through a right mouse click and choose edit edit drawing settings remove from view Previous deployment node Next sequence diagram 209 of 357 07
79. in activity owning the diagram To add a new flow or dependency between elements select the appropriate arrow through the buttons on the top of the diagram sub window click on the start eleme with the left mouse button move the mouse each time the mouse button is raised a new line break is introduced at least click on tl end element To abort a line construction press the right mouse button or do a double click with the left mouse button A line may be broken during its construction of after clicking on the line with the left mouse button and moving the mouse with mouse button still pushed To remove a line break a double click on the point with the left mouse button is enough or use the lin break menu of the point using the right mouse button The scale may be changed from 30 up to 200 To allows to see the operation message kinds even with a small scale the size of the unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down
80. is generated for the artifact artifact header C The generated file name is the artifact s name with the extension specified in the first C tab of the generations settings 289 of 357 07 10 2007 16 00 290 of 357 file C uml BOUML bouml 3 0 doc TOUT html 45 GenerationSettings dialog ELLEN s atf d du Kifndef NAME H define NMAME H i comment ineludes Header file declarat ions default content namespace start definition gt namespace end endif i comment i 1includes namespace start members i namespace end Source file ia default content aneratecdreyersed nenerated reversed 4 h d p lepp inciude without path header file extension source file extension force namespace generate Javadoc prefix generation style comment In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the C code generator are e NAME produce the artifact name capitalized Name produce the artifact name with the first letter capitalized at least name produce the artifact name without modification e comment is replaced by the artifact description adding e description is replaced by the artifact description without adding e includes is replaced by the automatically generated include and using forms it is also a good place to add your include and using forms when the ones pro
81. is something like these supposing the node not read only nor deleted see also menu in a diagram edit delete referenced by mark tool Menu edit edit allows to show modify the node properties In case the node is read only the fields of the dialog are also read only Node dialog tab Uml The tab Uml is a global tab independent of the language Node dialog 3 a Pye name p Node Stereotype cpu 1 description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu delete The menu entry delete is only present when the node is not read only Delete the node and all its representation in the opened diagrams After that it is possible to undelete it
82. linked items Select linked items select all the items connected this the current one through any line Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams Drawing 218 of 357 Default stereotypes dialog 5 Te 4 Freier Ur EP ge class diagram P stereotypes object diagram NEMESIS stereotypes collabaration diagram CO Stereotypes sequence diagram CO Stereotypes use case diagram Fe stereotypes state diagram PO stereotypes activity diagram PN stereotypes component diagram CO Stereotypes deployment diagram OO Stereotypes sequence Diagrams oo abe ioc E ne cg Lh asynchronous daj context je op2 p1 int pz float done context apz 123 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html A sequence diagram may contain actors classes instances part of the model or only graphical fragment notes texts diagram icons and the operations messages To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram To add an operation message select the appropriate button the synchronous asynchronous state may be changed thro operation message edit menu click on the sender with the left mouse bu
83. means that the plug out is configured two times for instance like this display oane HTML documentation X X X X X X X X X X X X X X X X X XX XX X executable Generate pro a 3 Jirose Import Rose AA cpp util C utilities A Generate Xll A E een When it is applied to a the project or an other package it ask you for the command proposing the last used one file control Check in sub packages In the command tile will be replaced by the file s name and dir by the directory where is the flle Command specify the command with the fle replaced by fle Save then reload the project to see the new write permission of the files Ok Cancel file control lt 2 gt 45 pem Check out sub packages In the command wile will be replaced by the file s name and Sadir by the directory where is the flle Command specify the command with the flle replaced by fle Save then reload the project to see the new write permission of the files Ok Cancel When you just want to change the write permissions using chmod under Linux the check in command is chmod w dir file and the check out command is chmod w dir Vofile Note the file permissions are set when a project is read you must re read a project to force Bouml to know the new ones Previous C utilities Next Deploy classes 329 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Deploy classes A very simp
84. or to empty it The proposed types are the non class types defined in the first tab of the generation settings more all the classes defined in the project with their localization to distinguish synonymous classes You are not limited to the proposed list and any form even invalid for the target language s may be given The button type shows a menu proposing e if the current type of the object is a class to select this class in the browser e if the object is not read only and if a class is selected in the browser to set the type to be this class 169 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The multiplicity ordering in state and is control are the standard UML properties The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Activity object dialog tab Ocl The Ocl tab allows to specify the selection using the Ocl language but in fact BOUML doesn t check the synt
85. p gom x EO me Oo ex MMe 6H POD HD EC J machine ReadAmount x biagram E COselectAmount ct otherAmount t amount t abori E C jenter amp anount or abort t ok E i abort i is machines gt SM B n om 3 _ lt emarchine gt gt telephone BC emachine Processes E 2 The state diagrams may be placed in a state A state diagram is created through the new state diagram entry of the state browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings duplicate delete mark tool Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only State diagram dialog tab Uml 252 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html State diagram dialog ices uae Umi User name biag S Stereotype 1 description Editar caen The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML
86. preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format file C uml BOUML bouml 3 0 doc TOUT html By default the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e USA B 1116 x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes iso A5 iso A4 iso A3 iso A2 iso Al iso AQ 592 x 840 840 x 1188 1188 x 1680 1680 x 2376 2376 x 3364 3364 x 4756 USA A 864 x 1116 Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams 256 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog amp rmp Package Class UseCase Artfact Views Diagrams Activities Others class diagram EEEMMMM Mgctem stereotypes object diagram PO stereotypes collaboration diagram CO Stereotypes sequence diagram o ooo stereotypes use case diagram INE NK stereotypes state diagram NEM stereotypes activity diagram CO stereotype
87. several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c is a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them Multiple selection menu select linked items IE align tap copy selected Ctri c g align bottom cut selected C
88. skal a Diagram Drawing Settings d sesks diagram color diagram color ackages name in tab default cme default activity color default r show package context default default activity region color default automatic labels position default efault activity acti lar default zi write flow label harlzantally default default activity actian color show opaque action definition default default parameter and pin colar default draw all relations default default nate color draw shadow default default package calor default show information note default AAA default fragment color default drawing language default e show packages context To indicate if the context where the package is defined must be written and if yes how The context may be the UMI context which is the path of the package in the browser or the C namespace or the Java package or at least the Idl module See package context UY e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited associated Activity pictures moved etc e write flow label horizontally to write the flow description on only one line or each information on a different line e show opaque action definition to write the name of an opaque action or its behavior definition e show information note to show or not the notes associa
89. software to make sure the software is free for all its users This General Public License applies to most of the Free Software Foundation s software and to any other program whose authors commit to using it Some other Free Software Foundation software is covered by the GNU Library General Public License instead You can apply it to your programs too When we speak of free software we are referring to freedom not price Our General Public Licenses are designed to make sure th you have the freedom to distribute copies of free software and charge for this service if you wish that you receive source code or can get it if you want it that you can change the software or use pieces of it in new free programs and that you know you can do these things To protect your rights we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rig These restrictions translate to certain responsibilities for you if you distribute copies of the software or if you modify it For example if you distribute copies of such a program whether gratis or for a fee you must give the recipients all the rights that you have You must make sure that they too receive or can get the source code And you must show them these terms so they kn their rights We protect your rights with two steps 1 copyright the software and 2 offer you this license which gives you legal permission copy distribute and or modify the softwar
90. std you just have to create the class string to set it external in C and to have the declaration form name include lt string gt 291 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html using namespace std If you don t want to use the namespace and ask to write std string the declaration must be std name include lt string gt Operation The C definition of an operation is set through the Uml and C tabs of the operation dialog The indentation of the first line of the declaration definition give the indentation added to the visibility specification in the cli definition for all the operation declaration definition except for the pre processor forms beginning by whose are placed at beginning of the line In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the C code generator are e comment is replaced by the description of the operation adding e description is replaced by the operation description without adding e static produce static when the operation is a class operation see the UML tab e const produce const when the operation is const e volatile produce volatile when the operation is volatile e friend produce friend when the operation is friend e virtual produce virtual when the oprration is virtual e finline produce inline when the operation is inline e type is replaced by the returned value type
91. ta synchronize with the others Warning Some projects cant be synchronized because of read only files l home bruno uml pr T hame bruno pr 5yncnronize As you can see only two of the three images may be synchronized because of read only files in the second image However the second image will be used during the synchronization to get the new version of packagel and the new package package5 After selecting at least one image and hitting on synchronize the synchronization the selected images are updated then a dialog indicating the end of the synchronization appears Project syi ai du synchronizatlan done When you confirm the execution of Project Synchro is done Supposing the synchronization done for the first and third image restarting Project Synchro this the same images one obtains 344 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Project synchro 43 PEINE Style Help Rev Mod Rev Mod vod ri ma frec prm Borur cm A Package alali L1 Package alali L1 Package BL jPackage brur BL jPackage brur BL jPackage Package brur Package brur Package cDjPackage cDjPackage Package B Package3 arur B Packages arur B Package3 Parkage brur i Package brur i Package Package4 Package4 Package4 Package5 alal Packages alal Package5 G Packages A Packages a Packaged Bia Packages B Packages E
92. the attribute if not found for the class containing the attribute etc Relation The C definition of a relation is set through the Uml and C tabs of the relation dialog The indentation of the first line of the definition give the indentation added to the visibility specification in the class definition for all the relation definition except for the pre processor commands beginning by whose are placed at the beginning of the line Relation equivalent to an attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the C code generator are e comment is replaced by the description of the relation adding e description is replaced by the relation description without adding e static produce static when the relation is a class relation see the UML tab e const produce const when the relation is read only see the UML tab e type is replaced by the class pointed by the relation see the UML tab e name is replaced by the relation s role name see the UML tab e value is replaced by the initial value of the static relation in the definition part generated in the source file see the UML tab value and h value are exclusive e h value is replaced by the initial value of the static relation in the declaration part generated in the header file see the UML tab value and h_value are exclusive e mutable produce mutable when the relation
93. the appropriate files only when it is necessary to not change the last write date of the files for nothing Depending on the toggle verbose code generation of the global menu Languages the code generator is verbose or not The Idl code generator plug out may be called on e aclass in this case the code generation is in fact applied on the class s artifact then on all the classes associated to this artifact e a artifact in this case the code generation is in fact applied on all the classes associated to the artifact e a class view the code generation will be applied on all the sub classes then on all the artifacts associated to these classes e a deployment view the code generation is applied on all the sub artifacts e package may be the project itself the code generation will be applied on all the sub class views and deployment views then on all their sub classes and artifacts When the Idl code generator is ask through the Tools menu it is applied on the project then on all the artifacts The name of the generated files depend on the artifact name the extension depend on the language and is fixed for each by the generations settings see below the directory where the files are generated may be set in each package containing directly or indirectly the artifact see generation directory artifact The Idl definition of a artifact is set through the Idl source tabs of the artifact dialog The code g
94. the browser or a class picture in a class diagram UmbAttri bute BGG attribaut eee coe ation BAD em Meche cans ae ea eee rat dupie wt pG rA UAc UmlAttribute edit drag settings Puta oper allons visibili en cuia ao Opera acu irse Pet cot ano eil oo atic a pt oc ence ww onae av den aper hor ware ipite Fam oer gere ate E a The icon in the browser indicates if an attribute is public protected private or package The protected and package visibilities are translated in private in Idl The package visibility is translated in private in C A class attribute is underlined It is possible to move an attribute from a class into an other using the drag and drop or the marked items capabilities see browser items EA enum StopKind weReed wF lute waPrincipal aeString miMutation Compound AE Stop maname maulabel akind EL FJ Keyboard amstops In a class having the stereotype enum the attributes are renames item in the menus Menus The attribute menu appearing with a right mouse click on its representation in the browser is something like these supposing it is not read only nor deleted the second one is associated to an enumeration s item Menu edit 81 of 357 eit add get operation add set operation add get and set operation duplicate delete mark tool edit duplicate delete mark tool b 07 10 2007 16 00 file C uml BOU
95. the button not generated in C It is possible to follow the visibility as it is set in the UML Tab or to change it static produce an empty string when the relation is not an class relation see the UML tab else produce static const produce an empty string when the relation is not read only see the UML tab else produce const type is replaced by the class pointed by the relation see the UML tab name is replaced by the relation s role name see the UML tab stereotype is replaced by the stereotype translated in C first tab of the generation setting dialog multiplicity is replaced by the multiplicity see the UML tab h_value is replaced in the header file by the initial value of the relation see the UML tab mutable produce an empty string when the check box mutable is not checked else produce mutable volatile produce an empty string when the check box volatile is not checked see the UML tab else produce volatile association produce the association class The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted When the check box virtual is checked the inheritance is virtual Refer to the generation settings and the C Generator for more details and explanation of the other keywords Relation dialog tab Java 69 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Thi
96. the description of the artifact adding e description is replaced by the artifact description without adding e fincludes if all includes is not used in the header definition it is replaced by the automatically generated include and using forms corresponding to the declaration generated in the header file If all includes is used in the header definition it is replaced by the Zinclude of the header It is also a good place to add your Zinclude and using forms e namespace_start is replaced by the namespace xx forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact is defined e members is replaced by the non inline members of the classes associated to the artifact e namespace_end is replaced by the forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact 1s defined e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the artifact if not found for the deployment view containing the artifact if not found in the package containing the deployment View etc Class The C definition of a class is set through the Uml Parametrized Instantiate and C tabs of the class dialog A C type definition may be a class a struct an union an enum or a typedef depending on the stereotype and its translation in
97. the description of the class adding e description is replaced by the class description without adding e public produce public when the class is declared public e final produce final when the class is declared final e fabstract produce abstract when the class is abstract e name is replaced by the class s name e extend is replaced by the class inheritance 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e implement is replaced by the interface inheritance e members is replaced by the code generated for all the class s members relations attributes operations and extra members following the browser order e cases only for the enums is replaced by the enum s items definition e xyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the class if not found for the container of the class an other class of a class view etc In the special case where the class is declared external its Java type declaration must contains a line indicating how the name of t class is generated by default name meaning that the name is produced unchanged the only allowed keywords are name Name and NAME Operation The Java definition of an operation is set through the Uml and Java tabs of the operation dialog The indentation of the first line of the declaration definition give the indentation added to the class defini
98. the relation and the role B is only available when the relation is bi directional The proposed stereotypes are the default ones specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype and the multiplicity are used both may be witl the stereotype of the class es in Idl to compute the default declaration Association allows to define a class association to produce it in the generated code use the keyword association By default the names of the generated attributes are the role names The multiplicity is used to compute the default declaration and the generated code for each language the proposed ones are not the alone know by code generators you may also use a number or a number between they are not distinguished by BOUML to specify a vector or a sequence or numbers each between to specify a multi dimensioned array The initial value give the default value of the generated attribute s in C it is taken into account only when the relation is a read only class relation By default the generated form is exactly the one you give this means that you have to give the when it must be generated thi allows to give the arguments of a constructor The visibility may be chosen with the radio buttons the relations have a default visibility set through the class settings 67 of 357 07 10 2007 16 00 file C u
99. the syntax this is just a convention State dialog i rum epigr Liml oai c Java User Entry behavior Exit behavior Da behavior State dialog tab C This tab allows to specify the state behavior in C but in fact BOUML doesn t check the syntax this is just a convention State dialog nea numi ge Lm oct cre Java User Entry behavior Exit behavior Da behavior State dialog tab Java 07 10 2007 16 00 121 of 557 file C uml BOUML bouml 3 0 doc TOUT html This tab allows to specify the state behavior in Java but in fact BOUML doesn t check the syntax this is just a convention State dialog 5 ye I DH Umi Oct C Java User Le Entry behavior Exit behavior Da behavior Menu duplicate The menu entry duplicate clone the state without its children Menu extract it from X The menu entry extract it from X is present when the stste is nested in X perhaps X is itself nested in another one but it is not visible here Choosing this entry the current stste became a children of the parent of X Menu referenced by To know who reference the current stste through a transition Menu mark See mark Menu delete The menu entry delete is only present when the state is not read only Delete the state and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t bro
100. this segment geometry Ctril remove from view delete from model Menu edit To edit the flow Menu select labels To select the labels flow s name stereotypes associated to the flow Useful when you are lost after many label movings Menu labels default position To place the labels flow s name stereotypes role s and multiplicity ies associated to the flow in the default position Useful wh you are lost after many label movings By default when you move a class or a flow point break or edit the flow the associated labels are moved to their default position this may be irritating To ask BOUML to not move the associated labels on the flows in a diagram use the drawing settings of the diagrams Menu geometry Allows to choose one of the line geometry Note if you manually move the central line of the last two geometries this one stop to be automatically updated when you move ont of the two extremities of the flow Menu tools Appears only when at least one plug out is associated to the flow To apply a plug out on the flow Drawing settings The drawing settings associated to the flows in a diagram may be set through the the diagram itself or one of its parent for instance Flow Drawing Settings dialo csi write horizontally defaut 1 show information note defaut drawing language defaut 181 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html A se
101. to change it replacing visibility by the desired one static produce an empty string when the relation is not an class relation see the UML tab else produce static final produce an empty string when the relation is not read only see the UML tab else produce final volatile produce an empty string when the check box volatile is not checked see the UML tab else produce volatile transient produce an empty string when check box transient is not checked else produce transient type is replaced by the class pointed by the relation see the UML tab stereotype is replaced by the stereotype translated in Java first tab of the generation setting dialog multiplicity is replaced by the multiplicity a form 123 become see the UML tab name is replaced by the relation s role name see the UML tab value is replaced by the initial value of the relation see the UML tab association produce the association class produces the annotations when it is present in the definition the button Edit annotation is active a specific dialog allows you to enter the annotations proposing the default annotations Deprecated and the ones defined through the classes stereotyped interface 70 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html To add an annotation at the cursor position vau may Select it in the fist and press add Add Deprecated The forms property are replaced
102. to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c 1s a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them 249 of 357 07 10 2007 16 00 If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally Multiple selection menu select linked items delete selected Contral d IE align tap copy selected Ctri c Qc align bottom cut selected Ctriex remove from view E align lett remove selected fram view Suppr align right F align center verticaly ge align center harizontaly Multiple selection menu select linked items Copy selected Ctri c Cut selected Ctri x remove from view Remove selected from view Suppr Delete selected Contral
103. to see what will be generated for Idl supposing you do not modify the Idl code generator Result after substitution When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this attribute defined in Idl empties the declaration manually or using the button not generated in Idl It is possible to follow the visibility as it is set in the UML Tab or to change it replacing visibility by the desired one type is replaced by the class pointed by the attribute see the UML tab name is replaced by the attribute s name see the UML tab stereotype is replaced by the translation in Idl of the relation s stereotype see the UML tab multiplicity is replaced by the multiplicity of the relation see the UML tab Refer to the generation settings and Idl generator for more details and explanation of the other keywords Menu duplicate The menu entry duplicate clone the attribute Menu add 88 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html These entries allow to produce get and set operations on the attribute contrarily to the similar operations made by hand these two ones are linked to the associated attribute to be updated or deleted when the attributes 1s deleted The default name of the operatior and their characteristics are set thro
104. to the parameter sets To apply a plug out on the set B Previous activity region Next activity object 168 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity object Note pins are activity object they are described with the activity actions In the browser an activity object is placed in an activity or an activity region and may contain flows E14 activity Si interruptible region BLobject flow E mexpansion region object L lobject The activity object s properties are exposed below Menus The activity object menu appearing with a right mouse click on its representation in the browser is something like these supposing the object not read only nor deleted see also menu in a diagram edit duplicate delete referenced by mark Menu edit edit allows to show modify the object properties In case the object is read only the fields of the dialog are also read only Activity object dialog tab Uml The tab Uml is a global tab Activity Object dialog 5 iiie n iles Umi ocr cH Java Properties name bet ti stereotype 1 type miultipiiciny ordering unordered in state D o F is control description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one
105. view doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu edit drawing settings 38 of 357 07 10 2007 16 00 39 of 357 file C uml BOUML bouml_3 0 doc TOUT html i Diagram Drawing Settings dialo o 4 4 4 4 05 Diagram Drawing Settings dialo Lekak TUCELIICEGG XLIIIETY i atte component color component color L show packages name in tab default show packages context default default component color default 1 automatic labels position default default note color default 1 draw all relations default draw shadow default draw component as ican default default package colar default H show component s required defaut 3 and provided interfaces default fragment colar default show components realizations default This dialog allows to specify how the component diagrams must
106. visible part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e iso A5 592 x 840 e iso A4 840 x 1188 e iso A3 1188 x 1680 e iso A2 1680 x 2376 e
107. z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items When several diagram s elements are selected the menu appearing on a left mouse click allows to align them Multiple selection menu select linked items IE align top copy selected Ctri c Qo align bottom cut selected Crri x remove from view E align let remove selected fram view Suppr H align right delete selected Control d align center F align center verticaly H8 align center harizontaly Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu Upper Lower Edit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window to end the edition 277 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html ais bouml 5 bic saab te A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu font b edit drawing settings select l
108. 00 52 of 357 Limi Parametrzed C Java iot User Definition Result after r public comment amp public final fabstract enum name implements siitems members substitution oper M final Default definition For a class with the Java stereotype enum_pattern Standard class Class dialog 45 oi mm er og Definition Not generated in Java file C uml BOUML bouml_3 0 doc TOUT html Edit annotatian f comment a public final class name members j private int value icases public int value return value public static name fromInt int value switch value I default throw new Error private nama int v value v final class IntegerValues do d amp d dc Zero z One o Two Three as gewyeral private int value public int value return value public static IntegerValues fromInt int value switch value Zero a One Two Three as gewyeral default throw new Errori D private IntegerValues int v value v Default definition Not generated in Java Edit annotation 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Wml Parametrized c Java io User T public F final ficomment publie final abstract class name axtends implements Definition imem
109. 16 00 Project Settings settings For Wind2 Release To apply moc on a header Edit the settings of the file in the following order e use custom build step 337 of 357 file C uml BOUML bouml 3 0 doc TOUT html General Debug C C Categon Prepracessor Preprocessor definitions ITHEPPWITHIDLJwITHJAVA 0 T DLL HT THREAD Undefined symbols Undefine all symbols Additional include directories i TBIR Include Taole html ignore standard include paths Project Options Anolaga ML AWS GX 02 A BIB TBIR Punclude zl Toole AL html D ISKVITHEPP ID WITHIDL iD P KNITHIAVAU DUBT BLEU AD General Debug CAC Link Hiesnurci Categor General bi Reset Output file name fF elease ghtml exe Object library modules 32 lib HATDA IMibsat mtz30nc lib 8 TPTR JMibsqtmain ib Generate debug info Ignore all default libraries Link incrementally Generate mapfile Enable profiling Project Options kemel32 lib Users lib adi3z lib winspool lib comdlg 32 lib advaprse lib shell 3z lib ole3z lib nleaut32 lib uuid lib adbc3z lib adbcep3z lib 07 10 2007 16 00 338 of 357 Project Settings settings For win32 Release X B aDirection h Z anltemkind A aRelationKind h avisibility h ClassGlobalCmd h CrodF amily hi CopSettings h EODEM CIUS ids ettings h Idi etingsCmd h Z JavaSettings h Z JayvaSettingsCmd h BE MiscGlobalCm
110. 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Genpro pro generator genpro is an other example of plug out developed with BOUML its goal is to generate the pro file used by gmake or tmake to produce the Makefile of a C program using Qt for instance a plug out genpro has itself a graphical interface implemented thanks to Qt when it is applied on a artifact stereotyped executable the following window appears here it is applied on the gpro executable artifact itself the C generation directory is tmp gpro pra file itmp gpra genpre nro target mp gpro genpra template config warn an al defines WITHCPP WITHJAVA WITHIDL include paths compute depend paths objects dir browse Cancel By default the pro file is produced in the directory where the executable is made the executable s name is the artifact s name except when this least is executable in this case is is the project s name You may specify the template app lib or subdirs set some flags like debug the C pre processor variable definitions see plug out for explanations on WITHCPP WITHJAV A and WITHIDL ask to place the objects in a directory which is not the one used for the sources etc The source files considered by genpro are the ones produced by the source artifacts associated to the executable artifact on which genpro is applied The same technique may be used to directly generate
111. 6 00 file C uml BOUML bouml_3 0 doc TOUT html Class view A class view is used to design the classes and may contain classes class instances states activities class diagrams object diagrams sequence diagrams and collaboration diagrams in any order E P cass view B EjAdass Fjadassinstance AClass eiGass Diagram object Diagram Ee Sequence Diagram F Collaboration Diagram E C O emachine Astate Machine 1 4 AnActivity A class view may have an associated deployment view in this case the menu of the sub classes propose a shortcut to create an artifact in the associated deployment view refer to class menu Menus The menu appearing with a right mouse click on a class view in the browser is something like this supposing it is not read only nor deleted Class view New class diagram New sequence diagram New collaboration diagram New object diagram New class New class Instance New state machine New activity Edit Edit class settings Edit drawing settings Delete Mark Generate Tool select associated deployment view The menu entry select associated deployment view is only present when the class view has an associated deployment view this feature allows to quickly associate an artifact to a class see class menu Menu edit class view dialog ER e unii User name ari USER class view stereotype 1 oe ari USER component view API USER 1 your API clas
112. 7 file C uml BOUML bouml_3 0 doc TOUT html The way an attribute is written or not in its class picture depend on the class drawing settings drawing language hide attributes show member visibility and show full members definition and also on the class menu entry individual attribute visibility Changing the drawing language from UML the default to C or IDL pgnum patterns pK Changing the drawing language to Java public static final int Reed public static final int Principal public static final int String public static final int _Mutation public static final int Compound Changing the drawing language to Php xEnur patterns StopKind const Reed const Flute const Principal const String const Mutation const Compound Previous relation Next operation 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Operation BOUML only manage class s operations and friend operations not standard C or Php functions even it is possible to define a C or Php function through an extra member or in an artifact definition etc An operation may have a stereotype but it does not have a special meaning for BOUML Contrarily to several UML toolbox the body of the operations is fully managed by BOUML and saved among the project data see project files Howerver you can also enter the bodies out of BOUML thanks to the option Preserve operations s bodies of the
113. 7 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Previous class diagram Next deployment diagsram 279 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Deployment diagram a Deployment Diagram Diagram Faf x eae Eo E a ala mo a es be scale 100 tz fit ore ca The deployment diagrams may be placed in a deployment view E Bia Deployment view 3Ha Deployment Diagram 0 lt lt source gt gt an Artifact 1 executable an other Artifact Fl lt lt epu gt gt a Node Ci lt lt device gt gt an other Node A deployment diagram is created through the new deployment diagram entry of the deployment view browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted Deployment Diagram show edit edit drawing settings duplicate delete mark tool Ll Browser Menu show show allows to show the diagram picture and edit it in case it is not read only 280 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only deployment diagram dialog tab Uml Deployment diagram dialog e name fe Deployment Diagram Stereotype 1 description Edit
114. C uml BOUML bouml_3 0 doc TOUT html Upper Lower Edit drawing settings Edit select in browser select class in browser select linked items Remove fram view Delete fram model Contrarily to the sequence and collaboration diagrams an object diagram show modeled instances there is no pure graphical instances Message Menu edit drawing settings This dialog allows to specify how a the class instance must be drawn you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level Diagram Drawin cs diagram color dee defaut class instance color defaut E cene write class instance horizontaly To write the instance type and name on the same line or on two lines Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams Default stereotypes dialog 2 miep Package Class UseCase Artfact Views Diagrams Activities Others beri rmm class diagram NEM stereotypes object diagram NEM stereotypes collaboration diagram EMEN Stereotypes Sequence diagram PO Stereotypes use case diagram PO Stereotypes state diagram FO stereotypes activity diagram FO stereotypes component diagram PO Stereotypes deployment diagram TO sterentypes Drawing 248 of 357 07 10 2007 16 00 file C uml BOUML
115. It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu duplicate The menu entry duplicate clone the pseudo state without its children Menu referenced by To know who reference the current pseudo state through a transition Menu mark See mark Menu delete The menu entry delete is only present when the pseudo state is not read only Delete the pseudo state and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from 1 browser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on a pseudo state of this kind The selected tool is called and applied on the current pseudo state Default stereotypes The dialog allowing to set the defaul
116. ML bouml_3 0 doc TOUT html edit allows to show modify the properties of the attribute In case the attribute is read only the fields of the dialog are also read only Attribute dialog tab Uml The tab Uml is a global tab independent of the language For a standard attribute 4 Attribute dialog 5 prr Umil c Java Php idi Properties class stop Organ name fee Stereotype type string rmiultipilesity d Initial value Et C publie protected private package class attribute T volatile T read only the name of the stop description Reeds are trumpet cromorne Flutes are bourdon rhorflote Principal are montre prestant Edito Strings are viola unda maris Ur Mutation are nazard thilerce u Default Compound are mixture cornet constraint Editor ceca For an enumeration s item Enum item dialog U H Lim c Java Php Idi Properties class Stopkind Organ name Feed value Ecitor description All the organ s pipes are not flue pipes mm the reed pipes have a metal tonge the reed Editor resting against a shallot Default constraint Editor The proposed types for a standard attribute are the non class types defined in the first tab of the generation settings more all the classes defined in the project with their localization to distinguish synon
117. OUT html Default stereotypes dialog amp TT jl 4 Package Class UseCase Artfact Views Diagrams Activities Others class diagram NEM NNNM stereotypes l object diagram PO stereotypes collaboration diagram stereotypes sequence diagram P Stereotypes use case diagram PO stereotypes state diagram PO stereotypes activity diagram PO stereotypes component diagram OO Stereotypes deployment diagram CO sterentypes Drawing component diagram mfe EI Hoa oO component Order Orderableltem lt lt component gt Product A component diagram may contain component package fragment notes texts diagram icons and the relations Note that the association between components does not appears in the browser there are establish deleted throw the compone diagrams or when you edit the component from where the relation start To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram To add required and provided interface indications use the appropriate button click on the component move the mouse click down and release the click on a already placed or a or nowhere in this least case BOUML will ask you to select a class from the list set by editing the component OrderEntry and Account
118. Oct C Java Properties selection parameter dialog tab C This tab allows to specify the selection in C but in fact BOUML doesn t check the syntax this is just a convention Parameter dialog s selection parameter dialog tab Java This tab allows to specify the selection in Java but in fact BOUML doesn t check the syntax this is just a convention 136 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Parameter dialog lt yr an a selection cu Menu duplicate The menu entry duplicate clone the parameter without its children Menu referenced by To know who reference the current parameter through flow Menu mark See mark Menu delete The menu entry delete is only present when the parameter is not read only Delete the parameter and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on an parameter The selected tool is called and applied on the current parameter Default stereotypes The dialog allowing to set the default activity and parameter stereotypes 137 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog mme ers activity OO stereotyp
119. Restore oreferred size and scale Unset preferred size and scale Format Unda all changes Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram may also be done through control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size Similar to the button H change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy optimal picture part Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy visible part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size a
120. Stereotype 1 description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu duplicate 174 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The menu entry duplicate clone the activity control node without its children Menu referenced by To know who reference the current activity control node through a transition Menu mark See mark Menu delete The menu entry delete is only present when the activity control node is not read only Delete the activity control node and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from the browser until you close the project obviously
121. TENT PERMITTED BY APPLICABLE LAW EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND OR OTHER PARTIES PROVIDE THE PROGRAM AS IS WITHOUT WARRANTY OF KIND EITHER EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARI MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE THE ENTIRE RISK AS TO THE QUA PERFORMANCE OF THE PROGRAM IS WITH YOU SHOULD THE PROGRAM PROVE DEFECTIVE YOU ASSUME COST OF ALL NECESSARY SERVICING REPAIR OR CORRECTION 12 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYI HOLDER OR ANY OTHER PARTY WHO MAY MODIFY AND OR REDISTRIBUTE THE PROGRAM AS PERMITT ABOVE BE LIABLE TO YOU FOR DAMAGES INCLUDING ANY GENERAL SPECIAL INCIDENTAL CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM INCLUDING BL NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS EVEN IF amp HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES END OF TERMS AND CONDITIONS Previous Troubleshootings 355 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Next Miscellaneous 356 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Define an environment variable To define an environment variable under Windows click on start gt settings gt control panel gt system gt ad
122. The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level W Diagram Drawing Settings di aamavs ik diagram color packages name in tab default q show package context default default state calor default automatic labels positian default default state action color default write transition horizontally default show transition definition default default note color default draw all relations default draw shadow default default package color default show state activities default drawing language default HURLRGURHU e show packages context To indicate if the context
123. When the Java code generator is ask through the Tools menu it is applied on the project then on all the artifacts The name of the generated files depend on the artifact name the extension depend on the language and is fixed for each by the generations settings see below the directory where the files are generated may be set in each package containing directly or indirectly the artifact see generation directory artifact The Java definition of a artifact is set through the Java source tabs of the artifact dialog The code generation depend on the stereotype of the artifact e text the Java definition of the artifact is produced without changes the name of the generated file is the name of the artifact including the extension e source see below e else nothing is generated for the artifact The generated file name is the artifact s name with the extension specified in the first Java tab of the generations settings 297 of 357 07 10 2007 16 00 298 of 357 file C uml BOUML bouml_3 0 doc TOUT html a GenerationSettings dialog a ng TTE Types Stereotypes C i et e ea Corts Java Javatz avers iei nato ia dices pengrated reversed java file default amp definition file extension 3 cantent generate Javadoc style comment zj f abstracticlars mame ont ards imp ienent s mime f iant erecta lmp l eden tg private int value pub
124. a Packaged Eb amp Ben mpl HE Cinel amp Jsrc um ea eh EyPackage4 Eb amp fen Del He E D3src T T B jiava fl fl a3 pos 3 need update 1 deleted RO Lip ta date c D 2 2 Et QR 3 pn p t 2 qx 4 1 1 E 1 1 1 2 1 2 1 1 1 1 Fd 1 1 1 1 Obviously the first and third images have the same aspect and don t contain old packages As I said it is possible to start the tool giving the project images in parameter for instance under Linux projectControl bruno uml pr pr prj tmp pr pr prj bruno pr pr prj irec alali brur brur orur brur alal Previous Project control Next Multi user considerations 345 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Multi users considerations BOUML attributes an identifier to the main objects to resolve the references to the not already read objects when you load a proje This identifier is establish during the object creation and will not change later to allow several users to work simultaneously on t same project this object identifier contains the identifier of the user creating the object This explains why BOUML ask you to have an own identifier between 2 and 127 defined through the environment variable BOUML ID see Define an environment variable These identifiers are also used to name the files m
125. a primitive type rather than a data type extension optional to ask the generator to produce or not through an extension the stereotypes and user properties tagged value f optional to produce the characters line feed and carriage return without modification else there are replaced by amp 0 and amp 13 In case these arguments are given the dialog doesn t appears this allows to export a project in XMI without any manual action These options may be set through the Tool setting dialog or when you ask to start a plug out when Bouml is lauched see here 321 of 357 Previous State machine generator Next XMI import 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html XMI import The XMI import allows to import XMI 2 1 for UML 2 0 or 2 1 file The top level element in the XMI file must be a project or a package else nothing will be imported This plug out must be applied on the project itself or a package it asks for a file and import it at end the number of main imported elements is written This release doesn t look at the language indications and only define elements at UML level Previous XMI generator Next Html documentation generator 322 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html HTML documentation generator The HTML documentation generator is developed using BOUML and is an example of a program implemented simultaneously in C and Java As it
126. accept this License since you have not signed it However nothing else grants you permission to modify or distribute the Program or its derivative works These actions are prohibited by law if you do not accept this License There modifying or distributing the Program or any work based on the Program you indicate your acceptance of this License to do so and all its terms and conditions for copying distributing or modifying the Program or works based on it 6 Each time you redistribute the Program or any work based on the Program the recipient automatically receives a license from the original licensor to copy distribute or modify the Program subject to these terms and conditions You may not impose any 1 restrictions on the recipients exercise of the rights granted herein You are not responsible for enforcing compliance by third parties to this License 7 If as a consequence of a court judgment or allegation of patent infringement or for any other reason not limited to patent conditions are imposed on you whether by court order agreement or otherwise that contradict the conditions of this License they do not excuse you from the conditions of this License If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations then as a consequence you may not distribute the Program at all For example if a patent license would not permit royalty free redistribution of the Progra
127. ace gt gt Serializable see java io Serializable L3 i k serlailzable Al As you can see contrarily to the result of a standard Java reverse the two classes do not have associated artifact because the goal i just to allow to have a class generalizing Serializable or having an attribute of this type etc Thanks to Java catalog you do not have to define the JDK and other classes by hand in BOUML to use them Note the saving of a catalog is just a list of classes and the pathname of the file defining them not the classes definitions When you send a class to BOUML Java catalog reverse the associated file to get the class definition this implies that you must not delete or move the Java source files defining classes of the catalog Previous Java reverse Next Php generator 304 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html PHP generator The PHP code generator is a plug out directly written in C The generated sources follows the definition made in BOUML at the artifact class operation relation attribute extra member levels When the code generation is applied on a artifact associated to several classes the code generation is made for all these cl Nevertheless the the Php code generator produce first the code in memory and update the appropriate files only when it is necessary to not change the last write date of the files for nothing Depending on the toggle verbose cod
128. acros in a text only the Declaration and Definition part are editable the other one help you to see what will be generated for C supposing you do not modify the C code generator Yc can see above that the definition doesn t contains the name of the parameters whose aren t used to avoid C compiler warnings When you push the button Default declaration or Default definition the form specified through the generation settings is proposed adding all the operation parameters given in the UML tab without any modifier These forms may be modified as you want ev produce illegal source code but more probably to add type modifiers etc The buttons From definition and From declaration allow to produce the declaration definition from the definition declaration getting the specified list of parameters and return definition For instance if I modify the operation s declaration like this the first parameter is modified and the second and thir removed i Operation dialog lt gt ar ey ae Len Cee Java ia Properties follow uml public C public protected private I const F velatie mend virtual T imina sS comment Sistatic s virtual t type name pS tO amp S pOleiy ye icanst voelatile abetract j Declaration fentrcy to produce the html code receiving chapter number path rank in the mother and level in the browser tree Result anar virtual veid htal Qcstring amp pfx substitution Def
129. activity The selected tool is called and applied on the current activity Parameter Menus 134 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html The parameter menu appearing with a right mouse click on its representation in the browser is something like these supposing the parameter not read only nor deleted see also menu in a diagram a parameter edit duplicate delete referenced by mark Menu edit edit allows to show modify the parameter properties In case the parameter is read only the fields of the dialog are also read only parameter dialog tab Uml The tab Uml is a global tab Parameter dialog 5 spim pp Umi oci c Java Properties name fa Parameter Stereotype 1 type direction Inet multinliciby 4 ordering unordered effect nona in state OOS O Ol default value Eciitor is control I unique E standard C exception stream description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The proposed types are the non class types defined in the first tab of the generation settings more all the classes defined in the project with their localization to distinguish synonymous classes You are not limited to the proposed list
130. age the color of the icons representing each package indicates if this one must be updated or not Project synchro 42 nation Style Help iB Tm bruno E E pr brunn 2 3 Package 8 bruno 2 e jPackage1 10 alain 4 B jPackage 4 bruna 2 E Package 4 bruno 2 Package 1 bruna 2 Package 1 bruno 2 Package 1 Package 1 Packages 3 bruno 2 a Packages 3 bruno 2 Package 1 bruna 2 Packagei 1 bruna 2 Packages 1 Package 1 EI Packages Z Packages 1 alain 4 Ba amp Package3 Package 1 aa 1 Bf yPackages 1 Package 1 Cla 1 El Parkage5 1 Package 1 Ja 1 Dh 1 Packages 1 G Jen 1 a 1 Ltmpl 1 een 1 Oo mpi Binet 1 Cii G src 1 inci 1 ig liava 1 GI 1 1 need update Up to date A package is green when it is up to date in all the images It is orange when it must be updated this means that an other image has new version of this package and this new version is blue A new package is also in blue At least a deleted package is gray In previous picture package is blue because it is new it doesn t exist in home bruno uml pr and package is blue on the right because it was modified to add the sub package package Each time a new image of the project is load the colors are computed obviously it is not possible to load several times the sam project image 343 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Project synchro 3
131. agram color write nametype horzantally defaut default package color defaut packages name in tab default default fragment color default show package context default automatic labels position default 1 default note cator default rel i fauit 1 draw all relations id default class instance default asi color draw shadaw default e write class instance horizontally To write the instance type and name on the same line or on two lines e package name in tab to indicate if the package s name must be written in the tab which is the small rectangle on the top note a transparent package doesn t have shadow B e show packages context to indicate if the context where the package is defined must be written it is not the case just above The context may be t UML context which is the path of the package in the browser choice followed for awt below or the C namespace specified by the package or the Java package specified by the package choice followed for picture below or at least the Idl module imag g jave awtinage e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited associated class pictures moved etc Browser Menu duplicate Clone the diagram in a new one Browser Menu delete The delete entry is only present when the diagram is not read only
132. alastores a datastore centralButfers a central buffer Ahuvoee E Ec Component view E 8 Component EL sub Component generalization cmp t sedependencys cmp kf component Diagram Deployment view EL 3Artifact dependency art C Node Ellpeptoyment Diagram suh Package t alependency gt other Package r dependency ARSS s ependencys an action All the browser items may have a description a stereotype sometime without special meaning for BOUML the default stereotype may be defined for some types of item and user properties The browser item s stereotype may be showed hidden through the Miscellaneous menu The bold font is used when an item is modifiable an item is read only when you do not have the write permission for the file s supporting it see Project files The system items supporting of the plug out s API for instance UmlBaseClass are also read only this help you to not modify them to have a chance to remain compatible with the future versions When you create a new item this last is placed at the end of the items of the same container using the left button of the mouse as for a drag amp drop it is possible to move an item to place it in an other container except for the relations or to change the items order The drag amp drop from the browser to an opened diagram is also possible when it is legal When you drag an item it on a non container item i72 itl will be placed just after i12 at
133. ame sg in um f loomment fif inali Fivisibility f abstract Fietetic function tiname Fii t1 ibody The form in from of also in uml allows to specify the name of the operation in Php the same rule is followed in UML if also in uml is set The third Idl tab allows to specify the default Idl generated code for the relations 76 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html a GenerationSettings dialog T pompe Types Stereotypes cet cet e e cnt Javati Jevatz Javers Javaj idit toa at iae multiplicity 1 comment readonly attribute type iname Association and O Unspecifiec aggregation multiplicity comment readonly f jattribute istereotype s tvper namel default ar a b declaration x mrehablya commenti readonly attribute stereotypel typel multiplicity name numer multiplicity 1 comment visibility S typel name Association and qr unspecific aggregatian defauit ITE declaraonin iis aa X probably a comment visibility stereotype lt type multiplicity gt iname MUMET multiplicity E comment ivis ibil ity stereotype keg type gt inamel multiplicity T comment case case I readonly type name Association and or unspecifie aggregation default or a b declaration in ATHE X probably a E comment case case f readoniyit stereotype e
134. an activity diagram obviously the diagram or the flow drawing may be deleted just after it is not possible to add a flow through the browser It is also not possible to move a flow out of its start or end container in the browser In the browser are written the name of the flows by default lt lt flow gt gt the stereotype may be may be showed hidden through the Miscellaneous menu Bouml home bruno uml EX activity activity prj a5 Project Windows Jools Miscellaneous Help jar id DR B activity jeu FE e Um ODne Tr lt 8 oo he oo am abe occ i Att HE E FajClass view gt 2 EY an activity Et AE EE Order l Process Order singleExecutions Diagrami preconditians order complete postcandition order closed Hc Hequested Order oor cows mH EO Recelve Order Requested Order EE xflows xflow ECF ill Order EX Ship Order E COClose Order b Bx ede E E CSend Invoice p flows EX Make Payment ECC cept Payment EH IInvoice Process Order F Menus The flow menu appearing with a right mouse click on its representation in the browser is something like these supposing it is not read only nor deleted see also menu in a diagram select decision Menu edit edit allows to show modify the flows properties In case the flow is read only the fields of the dialog are also read only Flow dialog tab Uml The tab Uml is a global tab indepe
135. an associated artifact to quickly select this one the current class may also be quickly 56 of 357 07 10 2007 16 00 57 of 357 file C um BOUML bouml 3 0 doc TOUT html selected from its associated artifact Menu select associated component Menu select an associated component This menu entry is present when the class have an associated component s to quickly select this one the current class may als quickly selected from its associated component Menu referenced by To know who reference the current class Menu mark See mark Menu delete The menu entry delete is only present when the class is not read only Delete the class and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from the browser until you close the project obviously the deleted items are not saved Menu generate To generate source code for the languages for whose the class and the associated artifact have a definition Menu tool The menu entry tool is only present in case at least a plug out may be applied on a class The selected tool is called and applied on the current class Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the classes c F w mm cama del ies a Default stereotypes dialog lt 3 7 Package Class useCase Artifact Views Diagrams Activities Others class i PR E actor auxil
136. anagement and default declaration Add operation profile on body edition The Languages menu allows to ask BOUML to produce or not a default definition declaration refer to the C generation Java generation Php generation and Idl generation when a browser item is created and to select for which language s the dialogs through tabs This menu also allows to update or not the body of the operation during the code generation refer to the C generation Java generation and Php generation to produce or not the operation s profile when you edit an operation s body throug an external editor refer to operation edition Miscellaneous menu 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Miscellaneous p Show stereotypes in browser Style Font size Nag am a FUR jormnal A Edit shortcuts F A Miscellaneous le Show stereotypes in browser atyig AU Landscape 41 Landscape Diagram default format A2 Landscane Edit shartcuts 43 Landscape A4 Landscape Miscellaneous p Show stereotypes in browser A5 Landscape A Landscape hott B Landscape Font size MatiPlus Diagram default format Windows C Landscape D Landscape Edit shortcuts E Landscape The Miscellaneous menu allows to show hide the stereotypes in the browser to change the used style to change the size of the font to set the def diagram format and to edit the sho
137. ansient e volatile produce volatile when the operation is volatile e type is replaced by the type of the attribute see the UML tab e stereotype is replaced by the translation in Java of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab must be used in case the multiplicity is a vector or dimensioning and are added when they are not present e name is replaced by the attribute s name see the UML tab e value is replaced by the initial value of the attribute see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc enumeration item The macros known by the Java code generator are e comment is replaced by the description of the item adding e description is replaced by the item description without adding e name is replaced by the item s name see the UML tab e class is replaced by the name of the class supporting the enumeration e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc 300 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Relation The Java definition of a relation is set thr
138. ar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level packages name in tab default default nate color default show package context default write node instance horizontally default default artifact color default automatic labels position default j default node color default draw all relations
139. artifact of the class menu in case the class view containing the class has an associated deployment view Browser Menu The artifact menu appearing with a right mouse click on its representation in the browser is something like these supposing the artifact not read only nor deleted see also menu in a diagram executable executable edit edit delete delete referenced by referenced by mark mark tool Menu edit edit allows to show modify the artifact properties In case the artifact is read only the fields of the dialog are also read only Artifact dialog tab Uml The tab Uml is a global tab independent of the language artifact dialog Se EE Umi C header C source Java source Php source Associated classes Associated artifacts Properties name iain Stereotype source 1 The main function you have to modify at least the line containing description Editor Default UmlCom targetlItem i 27 7 it if you want your program does something sees The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it 188 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html The editor button visible above and associated here to the description allows to edit the desc
140. asi f valual r The third Java tab allows to set the default definition of an enumeration s item in Java to set the get and set operations specificities in Java only visible when Java is set through the menu Languages a GenerationSettings dialog lia be fb Types Stereotypes cest ceta c9 ceta etm Java Javatey Savara avaja iip vg iar iname Ivalue Ei comment 1 Enumeration item default definition comment public static final int name valua Enum pattern item public static final class name new class nama default definitian case name return 5 name Enum pattern item case in rom int Visibility Ivtadillars Get operation ont default definition L public C protected private C package I final name pet name T alsa in uml Set operation default definition Visibility Modifiers L public protected C private package final T final parameter name set_ name M also in uml tiocmment Fivieibilicy Fifinal f iataticil abstract e eynehronisedif type finame 1 1 Cero f body seta clit i I The second Php tab allows to set the default definition of an attribute to set the default definition of an enumeration s item and to set the get and set operations specificities in Php only visible when Php is set through the menu Languages 92 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT
141. associated to the API contain several classes Compile a C plug out under Windows Qt 2 3 for Windows and Microsoft Visual C is available here ftp ftp trolltech com gt non commercial Because this release of Qt is old if you install Qt on a recent release of Windows for instance Xp the installation may be frozen at the end in this case just kill the installation process and in fact the installation is done Read the Qt documents to see how to use Qt under Microsoft Visual C On recent releases of Windows Visual C the macros allowing to automatically create a Qt project and or to ask for the usage of moc on header files may not work in this case read the following To have a QT project Edit project settings e the MFC must not be used Project Settings aa Settings For wine B lease General Debug C C Link Fiesourci En Microsoft Foundation Classes Mot Using MFC Output directories Intermediate files Release Output files Release Allow per configuration dependencies e add the preprocessor definitions WITHCPP WITHJAVA WITHPHP WITHIDL QT DLL QT THREAD SUPPORT having both WITHCPP WITE WITHPHP and WITHIDL is not mandatory you may define only one of them for instance WITHJAVA in case you interested by the Java definition of the items this allows to save memory space at the execution add the additional include directory QTDIR include 336 of 357 07 10 2007
142. ate action expression using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention 125 01 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html State Action dialog SE Lus Lim Oct ce Java User State action dialog tab C This tab allows to specify the state action expression in C but in fact BOUML doesn t check the syntax this is just a convention State Action dialog SE Lue Lim oct c Java User State action dialog tab Java This tab allows to specify the state action expression in Java but in fact BOUML doesn t check the syntax this is just a convention State Action dialog 2 LE Lim oc cH Java user Menu duplicate The menu entry duplicate clone the state action without its children Menu referenced by To know who reference the current state action through a transition Menu mark See mark Menu delete The menu entry delete is only present when the state action is not read only Delete the state action and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved 126 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Menu tool The menu entry tool is only present in case at least a plug out may be applied on a state action The selected too
143. ated to the state actions To apply a plug out on the state action Previous state Next pseudo state 128 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Pseudo State Currently BOUML manages only the behavioral states The pseudo states are e final state for reasons of simplification e initial e deep history e shallow history e join e fork e junction e choice e entry point e exit point e terminate In the browser a pseudo state may contain transitions when this is legal EC Jeemachine s ReadAmount SlDiagram E C Oselect Amount EH JenterAmount Be etransition gt abort a at The pseudo state s properties will be exposed below Menus The pseudo state menu appearing with a right mouse click on its representation in the browser is something like these supposing the pseudo state not read only nor deleted see also menu in a diagram edit duplicate delete reierenced by mark tool Menu edit edit allows to show modify the pseudo state properties In case the pseudo state is read only the fields of the dialog are also read only 129 0f 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html exit point dialog 2 eive Uml User name abor Stereotype 1 description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here
144. atic labels position default I default component color default draw all relations default draw shadow default default package colar default draw component as icon default show components required and provided Interfaces default fragment color default coz show component s realizations default e package name in tab to indicate if the packages s name must be written in the tab which is the small rectangle on the top ih e show package context to indicate if the context where the packages are defined must be written it is not the case just above The context may b UML context which is the path of the package in the browser choice followed for awt below or the C namespace specified by the package or the Java package specified by the package choice followed for picture below or at least the Idl module 272 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Java sew Image javag awtimage e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in the diagram when the relation is edited or the linked items moved etc e draw component as icon by default the component drawing follows the UML 2 0 notation this setting allows to use the old representation see customer e show component s required and provided interfaces to indicate if the required and provi
145. ation UmlOperation in id Item id In n string sKind string memo rei void M string In rank uint void gen cpp pere sing descr bool void gen ere carling string veld amelin s string string changing the drawing language from UML the default to C RU etn GCStrlhg UM ME ae 5 changing the drawing language to Java 108 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html fi 5 LIE 1 al ccn Arroak spun Nate bria ori Previous attribute Next extra member 109 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Extra member An extra member is an alien allowing you to specify directly the generated code for each language This allows to manage non L items for instance C pre processor directives Java attribute initializations etc An extra member is created through the class menu called from the browser stop add operation add embedded class BOG ExIrTE memor delete reterenced by ma generate tool i Menus The extra member menu appearing with a right mouse click on its representation in the browser is something like these supposing it is not read only nor deleted edit duplicate Menu edit edit allows to show modify the extra member properties In case the extra member is read only the fields of the dialog are also read only Extra member dialog tab Um
146. attribute see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc Relation The Idl definition of a relation is set through the Uml and Idl tabs of the relation dialog The indentation of the first line of the definition give the indentation added to the class definition for all the relation definition Relation equivalent to an attribute in an interface In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Id code generator are e comment is replaced by the description of the attribute adding e description is replaced by the relation description without adding e readonly produce readonly when the relation is read only see the UML tab e attribute produce attribute e type is replaced by the name of the class pointed by the relation see the UML tab e name is replaced by the role s name see the UML tab e stereotype is replaced by the translation in Idl of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the relation if not found for the class containing the relation etc Relation equivalent to an
147. ault declaration From d efinillan Mot generated in Ces Edit parameters IIT TIT El pe Lichen i amna i Lk Minii iiit hiinat i ieiet ian eee beg Thaha roid Dal peratis kimi OCU ia mmu QA omn unt and lites hi ot hae C g A oTa Edit body Default definition From declaration Mot generated in C Edit parameters and I press the From declaration button the modifications are reported in the operation s definition 99 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e qun SSS ss A D ul W Operation dialog lt gt Tems Leal Ces Java ia Properties f follow uml public C public protected private const T volatila fiend virtual T imina s comment istatic s virtual type amp namej 6 S t0 amp S pOleii e canst volatile abetract j Declaration fentcy to produce the html code receiving chapter number path tank in the mother and level in the browser tree Result aftar virtual youd htmli Qostring amp pfix i substitution Default declaration From d efinillan Not generated in Cs Edit parameters inline type i clsss S rameps 2 S160 amp p0151 const S wolatilei istakicnl s body Definition void Unl peration html CString amp pfix i m bady Result after substitution Edit body Default definition From declaration Mot generated in C Edit parameters When you do no
148. ault the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu upper lower edit fant remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove fram view The other diagram s elements have an own chapter refer to them 260 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT htm
149. ava lo definition 5 packagel definition Editor Default definition Not generated in Java import java io This class manages artifacts exor agio You can modify it as you want except the constructor substitution 41ass UmlArtifact extends UmlBaseArtifact Uml rtifact htmli 5Kind EH sj FI When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to generate the Java source file empties the declaration manually or using the button not generated in Java comment is replaced by the artifact description adding description is replaced by the artifact description without adding package is replaced by the package xx forms dependent on the package specifications associated to the BOUML package containing the deployment view where the artifact is defined definition is replaced by the definition of the classes associated to the artifact The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Artifact dialog tab Php source This tab is only available for the source artifacts and allows to give the definition of the Php source file generated for the artifact it 1s visible only if Php is set through t
150. ax this is just a convention Activity Object dialog a5 Um oct c Java Properties selectian OK Cancel Activity object dialog tab C This tab allows to specify the selection in C but in fact BOUML doesn t check the syntax this is just a convention State Action dialog aS Lus Activity object dialog tab Java This tab allows to specify the selection in Java but in fact BOUML doesn t check the syntax this is just a convention State Action dialog E LE Lim ct cH Java User Menu duplicate 170 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The menu entry duplicate clone the activity object without its children Menu referenced by To know who reference the current activity object through a transition Menu mark See mark Menu delete The menu entry delete is only present when the activity object is not read only Delete the activity object and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu tool The menu entry fool is only present in case at least a plug out may be applied on a activity object The selected tool is called and applied on the current activity object Default stereotypes The dialog allowing to set the default stereotypes Default stereotypes dialog 5 To
151. ay is to exit BOUML after the dialog acknowledge to define BOUML ID then to restart BOUML After this annoyance you may use BOUML open an already created project or create a new one a Boum deploy deploy prj Project Windows Jools Languages Miscellaneous Help js M amp 39 c NW Drow Ser B deploy A JAP BASE BERAPI BASE class view pH enum pattern aRelationk aE enum pattern aDirection IE enum pattern aVisibllity E Ej enum pattern anltemkin EF ES lt lt struct gt UmiParameter B EI LmiBase ActualParamener G H LimiGaseFormalParameter E FElUmiTypeSpec E ES LimiBase Aftrbure generalisation LimiCiass kind gsisReadOnly esel isReadOnly default alue gwser Defaultvalue Wwtype wwset Type wegetOperation awaddtietOperation uwesetOperation saddSerOperatian guisCppllutable me set_isCopMubable mls JavaTransient wset isJavalransient amidase wwset IdiCase meset Idicase lypical Execution emage2 o2 n0 e ek t die boul k r to get tha item on plug oi which he plog tut maln 2 part number ______ ts applied vou may E n also get the market ae Mems conmnect port_number Interactions with BOLIML to get tems dafinilorrs and execute commands are not shown returns a new attribute named s created under parent In case it cannot be created the name s already used or invalid parent cannot contain it etc
152. be drawn by default Menu delete The menu entry delete is only present when the class view is not read only Delete the component view and all its children and all the representation of them in the opened diagrams After that it is possil undelete them from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Menu tools The menu entry tool not present above is present in case at least a plug out may be applied on the component view Previous class view Next deployment view 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Deployment view A deployment view may contains nodes artifacts and deployment diagrams in any order E fla Deployment view 33a Deployment Diagram C lt lt source gt gt an Artifact 1 executable an other Artifact O lt lt cpu gt gt a Node Ci lt lt device gt gt an other Node Menus The menu appearing with a right mouse click on a deployment view in the browser is something like this supposing it is not read only nor deleted a Deployment view new deployment diagram new node new artifact edit edit drawing settings delete mark generate tool Menu edit Deployment view dialog 4 bi sly Ln ale Umi user name considered denimyments stereotype 1 Here are the deployments we propose depending on the available targets description Edita
153. bers This class manages classes notes that the class ClassiItem is a mother class of the class s children ff You can modify it as you want except the constructor Result ater C185s5 UmiCiass extends UmlBaseClass UmlClassgl substitution sg 1nd omens refi litmlt html Wwrltei Default definition Not generated in Java public produce an empty string when the check box public is not checked else produce public final produce an empty string when the check box final is not checked else produce final The external check box must be used when the class must not be defined in Java by BOUML but you want to specify the name of the class to not follow the Uml C Idl name members produce the declaration of the class members relations attributes operations and extra members following the browser order doesn t produce the enumeration items of an enum In an enum an attribute is not an enumeration item when its stereotype is attribute items produces the enumeration items of an enum an attribute is an enumeration item when its stereotype is not attribute extend is replaced by the class inheritance implement is replaced by the interface inheritance produces the annotations when it is present in the definition the button Edit annotation is active a specific dialog allows you to enter the annotations proposing the default annotations Deprecated and t
154. ble form with such ai offer in accord with Subsection b above The source code for a work means the preferred form of the work for making modifications to it For an executable work compl source code means all the source code for all modules it contains plus any associated interface definition files plus the scripts used to control compilation and installation of the executable However as a special exception the source code distributed need not include anything that is normally distributed in either source or binary form with the major components compiler kernel and so on of the operating system on which the executable runs unless that component itself accompanies the executable If distribution of executable or object code is made by offering access to copy from a designated place then offering equivalent access to copy the source code from the same place counts as distribution of the source code even though third parties are n compelled to copy the source along with the object code 4 You may not copy modify sublicense or distribute the Program except as expressly provided under this License Any atti otherwise to copy modify sublicense or distribute the Program is void and will automatically terminate your rights under thi License However parties who have received copies or rights from you under this License will not have their licenses terminated long as such parties remain in full compliance 5 You are not required to
155. c are the non class types defined in the first tab of the generation settings more all the classes defined in the project with their localization to distinguish synonymous classes You are not limited to the proposed list and any form even invalid for the target language s may be given The button value type shows a menu proposing e if the current value type is a class to select this class in the browser e if the operation is not read only and if a class is selected in the browser to set the value type to be this class e if the view containing the class containing the operation is not read only to create a new class and to set the return type to it Nevertheless I strongly recommend you to not add type modifier like amp etc with a class name in the UML tab because BOUML differentiate a reference to a class of the model and any other forms see type considerations The proposed stereotypes are the default ones specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of an operation does not have special meaning for BOUML The visibility may be chosen with the radio buttons the operations have a default visibility set through the class settings 97 of 357 07 10 2007 16 00 98 of 357 file C uml BOUML bouml 3 0 doc TOUT html Opit niana vedlity oronecec default operations visibility pub
156. canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e iso A5 592 x 840 e iso A4 840 x 1188 e iso A3 1188 x 1680 e iso A2 1680 x 2376 e iso Al 2376 x 3364 e iso AO 3364 x 4756 e USAA 864x 1116 e USAB 1116x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape 227 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Picture Menu undo changes Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored Operation message Menu The menu appearing with a right mouse click on link is something like these supposing the diagram not read only add messages to organist add messages to greatkeyboard edit Its messages edit all the messages select linked items edit drawing settings remove from view The two first entries allows to add a message in each direction you have to choose the new message rank among the proposed ones but you may change it after with edit its message or edit all the messages For instance in case a new message is added from from the keyboard great to a stop see the first picture the proposed ranks are Message Menu edit its message edit allows to edit the message of the link or delet
157. cept the specification of the base directories or the default stereotypes from an oth project Menu delete The delete entry is only present when the package is not read only Note that this entry is proposed even the package cannot be deleted because a children at any sub level is read only or referenced by a read only relation these cases are checked when you ask for the deletion for performance purpose else the menu may take too many time to appears Delete the package and all its children and all the representation of them in the opened diagrams After that it 1s possible to undel them from the browser until you close the project obviously the deleted items are not saved Menu referenced by To know who are the packages referencing the current one class through a relation Menu mark See mark Menu generate To generate the C Java Idl code of all the sub items To generate C Java Idl code for all the project do it at the project lev through the Tools menu Note that the generators does not re write a file when it is not necessary to not change the last modificati date of the files for nothing make will appreciate Refer to C generator Java generator and Idl generator for more details Menu reverse 27 of 357 07 10 2007 16 00 28 of 357 file C uml BOUML bouml 3 0 doc TOUT html To reverse sources placing the result into the current package Refer to C reverse Java reverse and Java catalog for m
158. ciated message operation to its default position Activity bar Menu The top and the bottom of an activity bars may be changed using the mouse clicking down the left mouse button on the top or bottom and moving the mouse The size of an activity bar is updated when you try to move a message above the top or below t bottom of the bar The menu appearing with a right mouse click on an activity bar rectangle is something like these supposing the diagram not read only Activity Te Upper Lower Draw as a caregian Edit drawing settings aplect linked items Remove from view Cut here Wierge juxtaposed activity bars Message Menu edit drawing settings Draw as activity ba Merge juxtaposed activity bars Activity bar Upper Lower Edit drawing settings Select linked tems Remove from view Cut here This dialog allows to specify the color of the activity duration rectangle Message Menu select linked items Select linked items select all the items connected this the current one through any line Message Menu cut here Cut the activity bar at the mouse place to obtain two activity bars resize the bar when there is no message above or below the position an empty activity bar is not created Message Menu merge juxtaposed activity bars When a least two activity bars of the same life line are juxtaposed replace these ones by only one activity bar Class instance Menu The menu appearing wi
159. cified comment statics mutable volatile const type name value Torg t S commeant S static imitable velatile const stereotypea lt type gt name value declaration X means X comment static mutable volatile const type name multiplicity value or ube Multiplicity Aggregation by value Aggregatia unspecified comment Sistatici imutable volatilelS constiS tvpe name ivalue by value Bs default orab declaration y means p comment static mutable volatile fconst itype namej multiplicity 5 value or comment Sistatic lmatable volatile l const lstereotypel lt sitypel 2 name Sivalue j 74 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The fourth C tab allows to specify the get and set operations specificities in C Visibility Wiodi ers default definitian L public protected C private F inline const value F const name aet_ name I also in uml Set operation Visibility Modifiers defaut definition public C protected C private inine T const peram M byret amesiset_ name aes value commen te fup ewes Cetin toe gree or he oes hof given me ist tat froomment Pliniine fitypel ficlassi i i mame CLS Clcomst ivolatile f throw f stat ioni f ibodyi l l tros The for
160. class declaration and Zinclude form for it The good way may be e to say that stops is a Stop and modify the attribute definition in C to have a vector e to set the stereotype to vector and the multiplicity to e but the right way here is to use a relation with the stereotype vector and the multiplicity because Stop is a class The proposed stereotypes are the default ones specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of an attribute does not have special meaning for BOUML The initial value give the default value of the generated attribute s in C it is taken into account only when the attribute is a class attribute enumeration item By default the generated form is exactly the one you give this means that you have to give the when it generated this allows to give the arguments of a constructor The visibility may be chosen with the radio buttons the attributes have a default visibility set through the class settings Class Settings d sss al s ai default attributs visibility protected Brimi mera vod usce Sartell ces anon vellit piit Cancel By default the description is used to produce comments by the code generators The editor button visible above and associated here to the description and initial value allows to edit the description or initial value in an window or to
161. cription with a default contain specified through the generation settings Useful to generate comments compatible Java Doc or Doxygen for instance Operation dialog tab C This tab allows to give the C declaration and definition of the operation it is visible only if C is set through the Language menu 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html _ _ _ _ _ _ E _ z E__ _ d 7 v ue mcg Operation dialog r Leni Ces Java ia Properties follow uml public C public protected C private I const T velatie mend V virtual T imina sS comment 5istatic s virtual type amp namej 0 t0 5S4pDj iti sipl Sitz 5 pZisi I5iconstib volatile abstract Declaration Fientry to produce the html code receiving chapter number path tank in the mother and level in the browser tree Result afer virtual veid html Qcstring pfix unsigned int rank unsigned int level substitution Default declaration From definition Not generated in Ces Edit parameters inline ii typet clsss nsme Si1ED Sitlp t2 1 4 S 4const S ivolatile sksticni body yord Unl peratian html CString unsigned int unsigned int bady Result after substitution Edit body Default definition From declaratinn Mot generated in C Edit parameters In BOUML the generated code is obtained by the substitution of m
162. ction dialog tab Ocl The Ocl tab allows to specify the variable class attribute or relation and the pre and post condition using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 nem erige Umi variable Oel crs Java Properties class variable j Pre condition Past condition The button variable shows a menu proposing e if the current variable 1s set to select this attribute or relation in the browser 154 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html e if the action is not read only and if a class attribute or relation is selected in the browser to set the variable to be the selected element e if the class is not read only to create a new attribute and to choose it Activity read variable value action dialog tab C This tab allows to specify the pre and post condition in C but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 npe rye Umi variable Ozi C Java Properties Fre condition Post condition Activity read variable value action dialog tab Java This tab allows to specify the pre and post condition in Java but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 mum mue Umi variable Oc ee Java Properties Fre condition Post condition Activity clear
163. cts classes operations attributes relations and extra members the state action behavior the state entry exit do behavior the transition trigger guard do behavior the attribute s value in an object diagram the notes and text in the diagrams It is not used else where for instance you can t use non ISO 8859 1 characters to name the elements or in a message of a sequence or collaboration diagram The specified encoding is followed in the project s files and for the exchanges with the plug out this means for instance that Cyrillic characters may be used in the comments and are generated unchanged by the code generators Previous Project files Next GNU public license 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html GNU public license The BOUML Toolkit is Copyleft 2004 2007 Bruno PAGES You may use distribute and copy the BOUML Toolkit under the terms of GNU General Public License version 2 which is displayed below GNU GENERAL PUBLIC LICENSE Version 2 June 1991 Copyright C 1989 1991 Free Software Foundation Inc 51 Franklin Street Fifth Floor Boston MA 02110 1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document but changing it is not allowed Preamble The licenses for most software are designed to take away your freedom to share and change it By contrast the GNU General I License is intended to guarantee your freedom to share and change free
164. d h Igl HnlnstanceCmd h E PackageGlobalCmd h gl gl gl gl AR E E e set Output to InputDir moc_ InputName cpp file C uml BOUML bouml 3 0 doc TOUT html General Custom Build M Always use custom build step Emsclude file from build Output directories Intermediate Files Release W e set Commands to qtdir bin moc exe InputDir InputName h o InputDir moc_ InputName cpp e set Description to Moc ing InputName h Project Settings Settings For win32 Release B aDirection h Z anltemKund h aRiaelationKind h avisibility h ClassGlobalCmd h CrodF amily hi L ppSettings h le n ids ettings h IdiS etingsCmd h Z JavaSettings h Z JavaSettingslmd h E MiscGlobalCmd h Z HnlnstanceCmd h B PackageGlobalCmd h pi cence E X General Custom Build Input File mpsgprasDialag h Description Mac ing InputM ame h Commands zgdir bin mac ewe lnputDir 4 InputNamel h o l Outputs InputDir moc Inputhamel CDD Cancel Previous Use case wizard Next Project control 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Project control This tool manages an applicative write access to the project files without using the may be existing operating system capabilities The goal is to give the write access of a the project files to at most one user per file to avoid to merge modification
165. d inheritances Because here the inheritance is very soft A inherits on B wl contains a class inheriting an other one defined in B BOUML accept that circular inheritances Menus The project and package menus appearing with a right mouse click on their representation in the browser are something like supposing them not read only nor deleted html new package new USE case vie new class view new component view new deployment view Import project edit edit default stereotypes edit class settings edit generatian settings edit drawing settings impart referenced by mark generate reverse tool project menu Menu import project import Package new package neu use case view new class view new component view new deployment view Impart project edit edit class setings edit drawing settings delete referenced by mark generate b reverse a teal non project package menu project allows to import a BOUML project into the current package as a standard package with its contain Note that the imported proje default settings are not imported It is not possible to import a project formated by a release of BOUML less than 1 3 then to import an older project you have to reformat it To do this load the project to import with a release greater or equal to 1 3 edit the pr package hit Ok BOUML doesn t check if something is really modified then save the project Menu edit 07 10 2007 16 00
166. d its name for instance in tmp probably just for a trial with the name foo Look n mp slel a ex CIkde bruno Spr ZIvaSTz 02452 FeMmd Cigconfd raot kde raot Zigsd alava Gi gpro ksocket bruna syajetmp Daze Cihsperfdata bruno ksocketroot Ci sysconig Daze html Shem meop bruno umi De Cihtmi html Imcan raot i Sed Cijavaseul pr Lz 4 2 File name oo File type E 1 Cancel amp In this case BOUML create the directory foo under tmp and place some files in tmp foo including foo prj which represents the project see project files file tmp foo Konqueror 5 ey Ie Document Edition Affichage Aller Signets Outils Configuration Fen tre Aid aaao Oa RADE E E gt URL Eifile tmp foo xj n lar l ments 7 fichiers 10 8 ko total Un dossier Do not rename or delete the files produced by BOUML nor the directory itself Project loading You may associate a prj file to bouml using your window manager capabilities call bouml through a command line given the prj file see project files in argument or launch bouml then load a project using the project menu or the open icon or the historic the historic is saved in the file bouml placed on your home directory 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html New CrN r4 pen Creo Save Chi s SAVE BS E Print Ctrl P Clase Crew Quit Ctrl nmp faa faa pr Ihame bruno uml html html prj h
167. d screnshots is permitted worldwide in any m provided a mention of Bouml Or http bouml free fr However following the shocking behavior of administrators of Wikipedia the distribution on all the Wikipedia sites of screenshot any part of the documentation is forbidden without autorisation Apologies First I apologize for the poor quality of my English and secondly it is clear that BOUML is not developed following all standarc object principles UML help to diffuse this is a little bit strange for an UML tool Nevertheless I hope the documentation is enough clear and consistent and I am sure that BOUML is fast and not glutton in memory At least this document describe BOUML not the Unified Modeling Language Next Starting 07 10 2007 16 00 3 of 357 file C uml BOUML bouml_3 0 doc TOUT html Starting When you execute BOUML for the first time this one ask you to have an own identifier between 2 up to 127 through the environment variable BOUML_ID Multi users considerations BOUML ID 2 eive van ES e The BOUML_ ID environment variable is not or wrong defined This one allows several users to work on the same project this time your identifier is 102 but BOLIMIL declines all the responsabilies of this random choice You must to define the environment variable BOUML_ 1D valuing between up to 127 not used by an other person working at the same time on a project with you I insist the better w
168. dd operation profile on body edition through the miscellaneous menu the form defining the operation in the editor is added at the beginning of the edited file home bruno uml html gen java decl body 87ffda0 2 java 45 File Hinde Edit Nodee Search Roeylon Font Misu produce the definition in Java WM public void gen java decliStnrinsg e throws IOException t fbodyi these lines will be automatically removed int n amp length int index bupass comment s while index n Operation dialog tab Php This tab allows to give the Php definition of the operation it is visible only if Php is set through the Language menu 102 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Operation dialog 5 es dale ba Lim e Java Php ii Properties F final lcomment 5 final l visibility abstract static function name i ipO pl ip2i41 body Definition entry to produce the html code receiving chapter number path rank in the mother and level in the browser tree public function html 5pfix rank level body Result after substitution Edit body Default definition Not generated in Php Edit parameters In BOUML the generated code is obtained by the substitution of macros in a text only the Definition part is editable the other one help you to see what will be generated for Php supposing you do not modify t
169. de and using forms done by the C code generator not made by the dialog which produce a fixed form If all includes is used in the header definition it is replaced by the Zinclude of the header It is also a good place to add your Zinclude and using forms the code generator does not look inside the bodies to compute the needed ones namespace start is replaced by the namespace xx forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact is defined members is replaced by the non inline members of the classes associated to the artifact namespace end is replaced by the forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact is defined The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted 190 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Artifact dialog tab Java source This tab is only available for the source artifacts and allows to give the definition of the Java source file generated for the artifact it is visible only if Java is set through the menu Languages artifact dialog 4 mpm rre Hkamrra iom mac amm Umi C header C source Java source di source Associated classes Associated artifacts User comment File import j
170. ded interfaces of the component must be written in the drawing of the component as a compartment e show component s realization to indicate if the realizations of the component must be written in the drawing of the component as a compartment Browser Menu duplicate Clone the diagram in a new one in the same diagram view Browser Menu delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only 273 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Component diagram menu Edit drawing settings select diagram in browser Select all Ctri a Optimal scale Optimal window size Copy optimal picture part Copy visible picture part save optimal picture part png Save visible picture part png Save optimal picture part svg Save visible picture part svg Set preferred size and scale set preferred scale size unset
171. default show activities defaut draw regions harlzantalty defaut state color drawing language defaut 1 Cancel Cancel show activities Allows to show or not the state s activities in a compartment depending on the drawing language entry behavior done on entry uxit behavior done on exit da behavior in state drawing language Allows to specify the used language in case the state s activities are shown drawing regions horizontally Allows to indicate if the regions are drawn horizontally or vertically for instance Processes Diagram eu rEjlozeoeexe89eoxeumpon Note the regions are not visible while the state picture is too small State color To specify the fill color Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the state representation in a diagram or the browser After that the only way to edit the state is to choose the edit entry in the menu Menu tools Appears only when at least one plug out is associated to the states To apply a plug out on the state Previous class instance 123 01 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Next state action 124 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html State Actions In the browser a state action may contain transitions The state action s properties wi
172. default stereotypes list for the packages and the dependency relation starting from a package In the lists the stereotypes must be separated by a space Menu edit class settings Class Settings d sis default attributs visibility ror default relations visibility nrotected default operations visibility public Cancel As you can see this setting allows to set a default visibility at the UML level for the attributes relations and operations This setting may be redefined in nested packages and class views At the project level you have to choose between public protected and private elsewhere you may also choose default this means that the visibility of the upper level is followed which itself may be default etc up to the project level When you create a new package or class view the visibilities are set to default Menu edit generation settings The biggest menu in BOUML used to specify a default definition declaration for all the generated forms This entry is only available in the project s menu for the package point of view the associated dialog s tab is the last one named Directory 23 of 357 07 10 2007 16 00 24 of 357 file C uml BOUML bouml_3 0 doc TOUT html EEUU TE PIIETAGDPEILIDPC NEUE Types stereotypes cemy e t cm em entm aat savagei Javaia savas Phony Pera repa ener er enn ie Description Direc Defining project root directory allows to pec
173. dialog gm rr Liml CR Java Php IDL Properties The generation directories may be relative In case the root directory is specified through the project menu entry edit generation settings headers directory Browse Set it absolute sources directory Browse Set it absolute namespace 2lof 357 07 10 2007 16 00 22 01 3517 file C uml BOUML bouml_3 0 doc TOUT html a2 Package dialog 5 nein Lim cr Java Phe io Properties The generation directory may be relative in casa the root directory is specified through the project menu entry edit generation settings directory Browse Set it absolute package a Package dialog 5 Liml ce Java Php io Properties The generation directory may be relative in casa the root directory is specified through the project menu entry edit generation settings directory Browse i Package dialog ee cn i Liml ce Java Php IDL Properties The generation directory may be relative in case the root directory is specified through the project menu entry edit generation settings directory Browse module When a directory specification is empty the generation is made in the directory specified through the last tab of the generation settings dialog As it is mentioned in the dialogs in case a root directory is specified through the generation settings dialog the directory specification
174. directory then it reads all the sources placed under the selected directo sub directories The sources read by the Php code reverse are the ones having the extension specified in the generation settings The tree formed by the sub directories produce an equivalent tree of sub packages on whose the needed class view and deployment view are made to support the classes and artifacts When a type is referenced but not defined in the reverse files a class having the sam name is defined under an additional package named unknown Obviously the Php code reverse tries to produce the definitions made in BOUML at the artifact class operation relation attribute levels When it is possible it creates a relation rather than an attribute The Php code reverse works in two steps during the first step it scans all the files to establish the list of defined types then the second step may reverse the files When the Php code reverse has a problem for instance on a syntax error it produces a warning in the trace window The trace window is automatically opened by BOUML it may also be manually opened through the Tools menu The reversed files are considered composed in three parts e a header without class definition and containing lt php This part if placed at the beginning of the generated artifact e only classes interfaces definition this part start with the first class or interface and stops before the first form which is not a class
175. doc TOUT html e multiplicity is replaced by the multiplicity of the relation see the UML tab e name is replaced by the attribute s name see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc valuetype s attribute The macros known by the Idl code generator are e comment is replaced by the description of the item adding e description is replaced by the item description without adding e visibility produce the visibility see the UML tab e type is replaced by the type of the attribute see the UML tab e stereotype is replaced by the translation in Idl of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab e name is replaced by the attribute s name see the UML tab e fxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc union s attribute The macros known by the Idl code generator are e comment is replaced by the description of the item adding e description is replaced by the item description without adding e readonly produce readonly when the attribute is read only see the UML tab e case is replaced by the case as
176. duced by the code generator are not sufficient To limit the included files number and to not prc circular include the C code generator does not produce an Zinclude to define a type only used by pointer or reference amp or place between lt gt in a template form The C code generator does not look at in the operations body only th operation s profiles relations and attributes classes inheritances etc are used to compute the needed include list fincludes and all includes are exclusive Note the generation settings allows to choose between four ways to produce include without path ask for the C code generator to generate the include without relative or absolute path with absolute path ask for the C code generator to generate the absolute path of the automatically included files with relative path ask for the C code generator to generate the relative path of the automatically included files relative to the file containing the include with root relative path ask for the C code generator to generate the relative path of the automatically included files relative to the directory specified by the generation settings all includes is replaced by all the automatically generated Zinclude and using forms it is also a good place to add your Zinclude and using forms when the ones produced by the code generator are not sufficient In this case the code generator doesn t prodt declarations in the header fil
177. duced unchanged the only allowed keywords are name Name and NAME Operation The Php definition of an operation is set through the Uml and Php tabs of the operation dialog The indentation of the first line of the declaration definition give the indentation added to the class definition for all the oper definition In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Php code generator are e comment is replaced by the description of the operation adding e description is replaced by the operation description without adding e visibility produce the visibility see the UML tab except if the visibility is package use this case to produce Php4 code e static produce static when the operation is a class operation see the UML tab e final produce an empty string when the check box final is not checked else produce final e abstract produce abstract when the operation is abstract see the UML tab e name is replaced by the name of the operation e and produce and but there are also a mark for BOUML to find the parameters list e t n and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter etc e staticnl produce a line break when the operation is static else an empty string In case you do not like this notation change the generation settings to remove this mac
178. during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected 267 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c is a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them Multiple selection menu select linked items IE align top copy selected Ctri c Qe align bottom cut selected Ctri x remove from vie E align left remove selected fram view Suppr H align right delete selected Control d iD align center F align center verticaly H8 align center horzontaly If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally Mul
179. e Also for each author s protection and ours we want to make certain that everyone understands that there is no warranty for th software If the software is modified by someone else and passed on we want its recipients to know that what they have is not original so that any problems introduced by others will not reflect on the original authors reputations Finally any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a fre program will individually obtain patent licenses in effect making the program proprietary To prevent this we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for copying distribution and modification follow 392 0f 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING DISTRIBUTION AND MODIFICATION 0 This License applies to any program or other work which contains a notice placed by the copyright holder saying it may I distributed under the terms of this General Public License The Program below refers to any such program or work and a wc based on the Program means either the Program or any derivative work under copyright law that is to say a work containing Program or a portion of it either verbatim or with modifications and or translated into another language Hereinafter translati includ
180. e dir a self bi dir radir b self bi dir dir b x he thecz tatheC CandC2 sek bi dii Es thec ec si hos in E El CF xl B dir a ratheC CandCz raa self mono dir re friend lt dependency gt C3 Bca ET ET To add a new relation between classes select the appropriate relation through the buttons on the top of the diagram sub window click on the start class with the left mouse button move the mouse each time the mouse button is raised a new line break is introduced at least click on the end class To abort a relation construction press the right mouse button or do a double click with the left mouse button A line may be broken during its construction of after clicking on the line with the left mouse button and moving the mouse with mouse button still pushed To remove a line break a double click on the point with the left mouse button is enough or use the lin break menu of the point using the right mouse button By default the lines go to the center of their extremities to decenter a line click near the desired extremity and move the mouse c down To come back to a center line use the menu geometry A right mouse click on a relation in a diagram or a double click with left mouse button calls the following menu supposing the relation editable CandC 2 edit E select in browser select labels labels default positon geometry Ciril b remove from view delete from model t
181. e const produce const when the attribute is read only see the UML tab e var produce var when the relation is not read only nor static see the UML tab and the visibility is not package else produce an empty string e name is replaced by the role s name see the UML tab e value is replaced by the initial value of the relation see the UML tab e stereotype is replaced by the translation in Php of the relation s stereotype see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the relation if not found for the class containing the relation etc Inheritance The class inheritance are managed at the class level 308 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html e type is replaced by the name of the inherited class Extra member The Php definition of an extra member is set through the Php tabs of the extra member dialog No macros Previous Java catalog Next Php reverse 309 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Php reverse The Php code reverse is a plug out directly written in C Note that the Php code reverse cannot be used as a Php code round trip and doesn t allows to update already defined classes having at least one member The Php code reverse plug out may be applied only on a package When you start the Php code reverse it ask for a
182. e exception and stream are the standard UML properties The flags exception and stream are exclusive choose standard to be not exception nor stream The editor button visible above and associated here to the default value and description allows to edit the default value or the description in other window or to call an external editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog closed I do not like very much this polling but this works even QT isn t compiled with the thread support Pin dialog tab Ocl The Ocl tab allows to specify the selection using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention 161 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Pin dialog RU ic lh nias Um oct Cu Jav Properties selection Activity opaque action dialog tab C This tab allows to specify the selection in C but in fact BOUML doesn t check the syntax this is just a convention Um Oel hea dava Properties Lreeaar selection Activity opaque action dialog tab Java This tab allows to specify the selection in Java but in fact BOUML doesn t check the
183. e use this case to produce Php4 code e static produce static when the attribute is a class attribute see the UML tab e const produce const when the attribute is read only see the UML tab e var produce var when the relation is not read only nor static see the UML tab and the visibility is not package else produce an empty string e name is replaced by the attribute s name see the UML tab e value is replaced by the initial value of the attribute see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc Relation The Php definition of a relation is set through the Uml and Php tabs of the relation dialog The indentation of the first line of the definition give the indentation added to the class definition for all the relation definition Relation equivalent to an attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Php code generator are e comment is replaced by the description of the attribute adding e description is replaced by the attribute description without adding e visibility produce the visibility see the UML tab except if the visibility is package use this case to produce Php4 code e static produce static when the attribute is a class attribute see the UML tab
184. e UML tab e stereotype is replaced by the translation in C of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab must be used in case the multiplicity is a vector or dimensioning and are added when they are not present e name is replaced by the attribute s name see the UML tab e value 1S replaced by the initial value of the static attribute in the definition part generated in the source file see the UML tab value and h_value are exclusive e h_value is replaced by the initial value of the static attribute in the declaration part generated in the header file see the UML tab value and h_value are exclusive e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc enumeration item The macros known by the C code generator are 293 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e comment is replaced by the description of the item adding e description is replaced by the item description without adding e name is replaced by the item s name see the UML tab e value is replaced by the value of the item see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for
185. e diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram To add a new relation between classes select the appropriate relation through the buttons on the top of the diagram sub window click on the start class with the left mouse button move the mouse each time the mouse button is raised a new line break is introduced at least click on the end class To abort a relation construction press the right mouse button or do a double click with the left mouse button A line may be broken during its construction of after clicking on the line with the left mouse button and moving the mouse with mouse button still pushed To remove a line break a double click on the point with the left mouse button is enough or use the lin break menu of the point using the right mouse button The scale may be changed from 30 up to 200 To allows to see the operation message kinds even with a small scale the size of the unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve 239 of 357 07 10 2007 16 00 times on fit may give several scales file C uml BOUML bouml_3 0 doc TOUT html Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection ma
186. e diagram is read only the fields of the dialog are also read only object diagram dialog tab Uml Object diagram dialog T nere Ul Proper name object Diagram stereotype 1 description Editar 243 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level di
187. e filtering searc replacement At most one replacement is done by form Examples of use e you want to replace everywhere comment by description all the filters must be empty set any artifact class operation attribute and relation set the right languages set current to comment and new to description press Replace e n the old releases the operation body indent must be set inside the body because the form body was not preceded by two spaces to replace the old definitions by the new default one where body is placed after two spaces and to keep the definition having these to spaces unchanged the first filter must be set to space space body where space is a space character and you set without the other filters are empty set operation only set the right languages set current to 331 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html body and new to lt space gt lt space gt body where lt space gt is a space character press Replace When you ask for a replacement a dialog indicate how many changes was done and may be how many can t be done because it is not possible to set the definition declaration of a read only element Warning global changes may have dramatic consequences when the filtering is not sufficient Previous Deploy classes Next plug outs 332 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Plug outs
188. e from madel Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a activity in a diagram all the settings are set to default Diagram Drawi i ile diagrami color show conditions deaur activity color a drawing language default 1 show conditions Allows to show Or not the activity s pre and post conditions depending on the drawing language Note on an upper level for instance at the diagram level this drawing follow the value o drawing show info notes In the diagram above show conditions is true if false the drawing become Process Order singleExecutian order rejected drawing language Allows to specify the used language in case the activity s pre and post conditions are shown activity color To specify the fill color Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the activity representation in a diagram or the browser After that the only way to edit the activity 1s to choose the edit entry in the menu 139 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Menu tools Appears only when at least one p
189. e generation of the global menu Languages the code generator is verbose or not The Php code generator plug out may be called on e a class in this case the code generation is in fact applied on the class s artifact then on all the classes associated to this artifact e a artifact in this case the code generation is in fact applied on all the classes associated to the artifact e a class view the code generation will be applied on all the sub classes then on all the artifacts associated to these classes e a deployment view the code generation is applied on all the sub artifacts e package may be the project itself the code generation will be applied on all the sub class views and deployment views then on all their sub classes and artifacts When the Php code generator is ask through the Tools menu it is applied on the project then on all the artifacts The name of the generated files depend on the artifact name the extension depend on the language and is fixed for each by the generations settings see below the directory where the files are generated may be set in each package containing directly or indirectly the artifact see generation directory artifact The Php definition of a artifact is set through the Php source tabs of the artifact dialog The code generation depend on the stereotype of the artifact e text the Php definition of the artifact is produced without changes the name of the
190. e nor include in the source file except the ones added by you all includes and includes are exclusive e declarations is replaced by the class declarations when the Zinclude form is not produced it is also a good place to add your declarations when the ones produced by the code generator are not sufficient Produce nothing if all includes is used e namespace_start is replaced by the namespace xx forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact is defined e definition is replaced by the definition of the classes associated to the artifact 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e namespace_end is replaced by the forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact 1s defined e fxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the artifact if not found for the deployment view containing the artifact if not found in the package containing the deployment view etc artifact source C The generated file name is the artifact s name with the extension specified in the first C tab of the generations settings In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the C code generator are e comment is replaced by
191. e part png Save optimal picture part svg save visible picture part svg Set prefered size and scale Set preferred scale size unset Restore oreferred size and scale Unset preferred size and scale Format E Unda all changes Picture Menu edit all the messages To edit all the messages appearing in the diagram to change the messages themselves or their numbering recursively or not or delete some of them recursively or not Collaboration diagram amen on ng 5 Rank Hierarchical rank F TENES 777 ETE organist ey greatkeyboard greatkeyboard blowt Stop stan singi pipe greatkeyboard keyDown surellkeyboard swelltkeyboard blow stop Stop singt pipe The proposed messages are the operations defined on the message receiver more the current one but you may also give any o message A mouse click on the appropriate line and column allows to modify the appropriate cell Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram also done through a control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size Similar to the button H change the size of the windows to see all the diagram s elements with the current scale 226 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT htm
192. e produce abstract The external check box must be used when the class must not be defined in Php by BOUML but you want to specify the name of the class t follow the Uml C Php Idl name members produce the declaration of the class members relations attributes operations and extra members following the browser order items produces the enumeration items of an enum other members are not produced extend is replaced by the class inheritance implement is replaced by the interface inheritance The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Class dialog tab Idl This tab allows to give the Idl definition of the class it is visible only when Idl is set through the Languages menu 54 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Class dialog mre I external r M custom amp comment abstract custom valuetype name inherit members Declaration valuetype Cl af Result alter substitution Default declaration Not generated in IDL cesa local produce an empty string when the check box local is not checked else produce local this one is only available when the stereotype of the class is interface in Idl see generation settings custom produce an empty string when the check box c
193. e project files associated to the packages This allows to set the write permission independently of the OS you use To use project images In this case each user has an own copy of the project and sometimes all the modifications done in parallel are grouped You may adopt two strategies to allows any user to modify any part of the project in this case you will have to merge the modification yourself or to allow only one user to modify a given project file Even the Project files are Ascii files I may be difficult to merge several version of the same file I know several companies use this way but it is possible to not have to merge the modifications using the write protection through File control or Project control and to resynchronize the model using Project Synchro To work without merge Let s suppose Bruno Olivier and Annie work on the same project and decide to use Project Control and Project Synchro At the beginning an unique image of the project exist If the project already exists using Project Control you give the write access of the package to at most one person If you start from scratch with an empty project immediately create at least a sub package for each this may be changed later Because the project itself is used to memorize generation settings and other global information I propose you to decide immediately what are the settings and to protect the package supporting the project this means it is not owne by Bruno O
194. e some of them recursively or not see edit Message Menu edit all the messages To edit all the messages appearing in the diagram to change the messages themselves or their numbering recursively or not or delete some of them recursively or not see edit Message Menu edit drawing settings This dialog allows to specify how the operation message must be drawn you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level 228 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html drawing fanguage defaut show operations full definition defaut show hierarchical rank defaut write nametype horlzantally default 1 packages name in tab default 1 show package context default 1 draw all relations default 1 draw shadow default 1 see operation drawing language and show full operation definition Message Menu select linked items Select linked items select all the items connected this the current one through any line Class instance Menu The menu appearing with a right mouse click on a class instance is something like these supposing the diagram not read only swell Keyboard Upper Lower Edit drawing settings Edit drawing settings Select in browser Select class in browser Select class in browser Select linked tens
195. e synchronization is not possible for an image having a read only file Project Synchro is not a plug out it is launch like BOUML or any tool when you start it the following window appears m M r nm Project synchro Project Style Help The menu Project is used to load several images of the same project to synchronize them or a part of them it is also possible to start the tool given a list of project images in parameter To avoid inconsistencies you can t apply Project Synchro several times on a given project and you can t use it on a project while it is edited by BOUML or by Project Control if this is the case a message warns you The project is already locked by Project control or Project syncho the directory hame bruno uml pr alllock exists A project directory must also not contain bak files these temporary files are present when BOUML or File Synchro crash during the modification of the files Synchro projicis When only one project image is load the aspect is the following 342 of 357 07 10 2007 16 00 Project synchro Project Style Help V name bruno uml Modified by 18 Jor El Package B Package Package Package B Package3 DJPackage1 Package4 amp Package3 ala i DJPackage B Packanes bruna 2 Bruna 2 Bruna 2 bruna 2 Bruna 2 Bruna 2 file C uml BOUML bouml_3 0 doc TOUT html When you load a second project im
196. eating a new project copying the tools file of an old project cpp_includes contains the C include amp using specifications for the non defined types used by the C generator and set through the C generation settings e java imports contains the Java imports associated to the non defined types not already used by the Java generator and set through the Java generation settings idl includes contains the Id imports includes to the non defined types not already used by the Id generator and set through the Idl generation settings user id session contains the session state opened diagrams browser view set when the project is closed number user id d contains the new definition of a diagram until a save number user id b contains the new definitions of a class s operations until a save user id lock a directory created when you load the project and deleted when you close the project see Multi users considerations Note in a plug out the supportFile operation defined on UmlBaseltem then applicable on all the browser items returns the absolute pathname of the file memorizing the item In general an item is saved in a file associated to its package the exceptions are 348 of 357 e the body of the operations of a class which definition contains the keyword body This path name is returned when you apply supportFile on any operation of the class e the drawing of the d
197. ecified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the default value and description allows to edit the default value or the description in other window or to call an external editor for instance Xcoral specified through the environment variable BOUML EDITOR Note 163 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog closed I do not like very much this polling but this works even QT isn t compiled with the thread support Pin dialog tab parameters Allows to specify the pins part of the parameter set ParameterSet dialog lt 3 Sabah anil Parameters aut af Parameter Set Parameters in Parameter Set other pin chapter actinnzacti pin chapter action activity ir Menu duplicate The menu entry duplicate clone the pin without its children Menu mark See mark Menu delete The menu entry delete is only present when the pin is not read only Delete the pin and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browse
198. ect linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu upper lower edit fant remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove fram view The other diagram s elements have an own chapter refer to them 221
199. ed on e aclass in this case the code generation is in fact applied on the class s artifact then on all the classes associated to this artifact e a artifact in this case the code generation is in fact applied on all the classes associated to the artifact e a class view the code generation will be applied on all the sub classes then on all the artifacts associated to these classes e a deployment view the code generation is applied on all the sub artifacts e package may be the project itself the code generation will be applied on all the sub class views and deployment views then on all their sub classes and artifacts When the C code generator is ask through the Tools menu it is applied on the project then on all the artifacts The name of the generated files depend on the artifact name the extension depend on the language and is fixed for each by the generations settings see below the directory where the files are generated may be set in each package containing directly or indirectly the artifact see generation directory artifact The C definition of a artifact is set through the C header and C source tabs of the artifact dialog The code generation depend on the stereotype of the artifact e text the C definition of the artifact is produced without changes the name of the generated file is the name of the artifact including the extension e source see below e else nothing
200. ed without limitation in the term modification Each licensee is addressed as you Activities other than copying distribution and modification are not covered by this License they are outside its scope The act running the Program is not restricted and the output from the Program is covered only if its contents constitute a work based o Program independent of having been made by running the Program Whether that is true depends on what the Program does 1 You may copy and distribute verbatim copies of the Program s source code as you receive it in any medium provided conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty keep intact a notices that refer to this License and to the absence of any warranty and give any other recipients of the Program a copy of thi License along with the Program You may charge a fee for the physical act of transferring a copy and you may at your option offer warranty protection in exchange for a fee 2 You may modify your copy or copies of the Program or any portion of it thus forming a work based on the Program and copy and distribute such modifications or work under the terms of Section 1 above provided that you also meet all of these conditions a You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change b You must cause any work that you distribute or publish that in wh
201. edit the component is to choose the edit entry in the menu Previous flow 186 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Next artifact 187 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Artifact Artifacts are used to produce source file s when the stereotype is source or to specified how libraries or an executable are composed E EAPI USER Deployment view 1 executable executable source Main 1 sources UmlActualParameter 3 source UmiClassitem 3 source UmlF ormalParameter 3 source UmlAttribute An artifact stereotyped source potentially associated to classes to produce their code but you may directly give its source s contain for instance to define the C main function as it is made in the plug outs An artifact stereotyped text is not associated to classes and allows to produce its C Java Php or Idl definition as it is set without any changes The generate file is named like the stereotype including the extension The non source nor text artifacts may be associated to other artifacts this allows to define libraries and executable to genera Makefiles etc see the plug out genpro producing a pro file from the artifact executable of the plug outs An artifact may be created through the new artifact entry of the deployment view menu through the artifact button of a deployment diagram or through the create source
202. efault stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level STETIT Drawing Settings sis i diagrami color drawing fanguage umi default pack lor defaut show operations full definition defaut aut Package color show hierarchical rank default default fragment color default write name type horlzantally default ackages name in tab default 1 P af default nate color default
203. elete the region and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu tool The menu entry fool is only present in case at least a plug out may be applied on an expansion region The selected tool is called and applied on the current region Interruptible region menus The interruptible region menu appearing with a right mouse click on its representation in the browser is something like these supposing the region not read only nor deleted see also menu in a diagram 142 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Interruptible region asd Plsrmipiibie mou add expansion region add activity action add object node edit duplicate set it nested In regian above extract it from current parent region delete mark Menu add These entries of the menu allow to add a nested region or an activity node activity action object node or control node Menu edit edit allows to show modify the region properties In case the region is read only the fields of the dialog are also read only Interruptible region dialog tab Uml Interruptible Activity Region d sess Jinterruptibie region Stereotype 1 description Editar OK Cancel The proposed stereotypes are the default one specified through the Default stereotype
204. em on the same line of on two lines show information note to show or not the selection drawing language Allows to specify the used language showing the expression Class instance color To specify the fill color Menu tools Appears only when at least one plug out is associated to the activity objects To apply a plug out on the activity object Previous activity action 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Next activity control node 173 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Activity control node The activity control nodes are e 9 initial e final e flow final ow merge e i decision 0 fork E join In the browser a activity control node is placed under its activity or region and may contain flows when this is legal The activity control node s properties will be exposed below Menus The activity control node menu appearing with a right mouse click on its representation in the browser is something like these supposing the activity control node not read only nor deleted see also menu in a diagram activity final edit duplicate delete referenced by mark Menu edit edit allows to show modify the activity control node properties In case the activity control node is read only the fields of the dialog are also read only activity final dialog 2 mape muri hi ea Umi Pronerties name
205. ements at great as possible Picture Menu optimal window size change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy optimal picture part Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy visible picture part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened 255 of 357 07 10 2007 16 00 Picture Menu restore preferred size and scale In case a preferred sub window size and
206. emorizing a project refer to Project files The plug out API define the UmlBaseltem supportFile to know whose file s support a given item Notes When it loads a project BOUML checks the write permission of the file done through the OS or the applicative perm indicated inside the file In the browser the writable objects are written in bold When you load a project this one must be consistent else the references to the unknown items are removed and these unknown items are considered deleted When you are several working on the same project you have to choose between two ways To share the same project files In this case all the users work on the same project files this means that no one has a copy of the project files This 1s possible because when you do a save only the modified files are written However this suppose at most one user may modify a given projec modifications made by several will quickly be done There are two way to allow at most one user to modify a file to use the write permission set using your OS difficult under Windows with the help of File Control or to use Project Control File Control File control is a plug out mainly dedicated to be an interface between BOUML and a file control like Clearcase CVS or Subversion etc however to use a file control may affect the write permission of the files Project control Project control is a tool managing an applicative write permission optionally memorized in th
207. emplate class else an empty string members produce the declaration and definition of the class members relations attributes operations and extra members following the browser order and repartition in the header and source files inline produce the definition of the operations and extra members declared inline may be an empty string Refer to the generation settings for more details The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Class dialog tab Java This tab allows to give the Java definition of the class it is visible only when Java is set through the Languages menu Generic definition Umi Parametrized ce Java i User p T public comment public final labstract class nmame extends implements aie S members Definition class Dict lt V E gt sae Key Resultater value substitutian Default definition Not generated in Java Generic instantiation Umi Parametrized instantiate Cr Java ioc user I public comment public final labstract class name extends implements is Imembers Definition class theredheaded extends Dict String String gt Result after substitutian Default definition Not generated in Java For a JDK 5 enum class with the stereotype enum 07 10 2007 16
208. ems is modified or to duplicate the marked items into it The menu is context dependent for a marked item it proposes to unmark the item or to unmark all the marked items and for instance for a component view it just proposes to mark it because the two marked diagrams cannot be placed into the component view or after the marked diagrams cannot be placed into the package containing the component view When you remove an item from the model the icon contains a red cross for instance DX note that a deleted item is never saved when you save your project but it may be undeleted with or without its children until you close the project Sometimes it is no possible to delete an items because this one contains read only items or is referenced by a read only relation A double mouse click on an item allows to edit it except when the item have an associated diagram in this case the diagram is showed The other mouse buttons show a menu depending on the item kind control s is a shortcut to save the project control d and suppr are a shortcut to delete the selected item Package A Package may be the project itself is first something like a directory and may contain e packages e use case Views e class views e component views e deployment views e relations A package may indicate where the code must be produced by the generator for each language and may specify the C namespac Java package Idl module A generator producing code
209. en A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove from view The other diagram s elements have an own chapter refer to them Previous state diagram Next component diagram 270 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Component diagram component diagram mfe EI E et 0 C oe scale 100 E d Account The component diagrams may be placed in a component view B Component view component diagram E 8 Store amp lOrder E jCustomer Product A component diagram is created through the new component diagram entry of the component view browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings duplicate delete mark tool Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only component diagram dialog tab Uml 271 of 357 07 10 2007 16 00 file C uml
210. enerated in lell ROLE 2 icommenti visibility type namel Declaration private C thet Result after substitution Default declaration Nat generated in Ial coe In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for Idl supposing you do not modify the Idl code generator When you push the button default declaration the form specified through the generation settings depending on the stereotype of the class the stereotype and multiplicity of the relation and of course the language is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this relation defined in Idl empties the declaration manually or using the button not generated in Idl It is possible to follow the visibility as it is set in the UML Tab or to change it replacing visibility by the desired one type is replaced by the class pointed by the relation see the UML tab name is replaced by the relation s role name see the UML tab The check box truncatable 12 Ob 337 07 10 2007 16 00 73 of 357 file C uml BOUML bouml_3 0 doc TOUT html is available when the relation is an attribute or a generalization or a realization and allows to produce the Idl keyword truncatable The forms property are replaced by the value of the corresponding user property 1
211. eneration depend on the stereotype of the artifact e text the IDL definition of the artifact is produced without changes the name of the generated file is the name of the artifact including the extension e source see below e else nothing is generated for the artifact The generated file name is the artifact s name with the extension specified in the first Id tab of the generations settings 311 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html GenerationSettings dialog lt i abt ha Types Stereotypes cest cest em cta etm Jevaji devatz Javea itr iae ieta taita Directory ifndef NAME H define NAME H comment ie ami i inelidag file extension ia comment ln E members zj j y 5 4 z L In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Idl code generator are e NAME produce the artifact name capitalized Name produce the artifact name with the first letter capitalized at least name produce the artifact name without modification e comment is replaced by the artifact description adding e description is replaced by the artifact description without adding e includes is not yet managed by the Idl generator and produce an empty string e module_start is replaced by the module xx forms dependent on the module specifications associated to the
212. ent f volatile f typel inamal fT ivalus l inameifivelue T comment fuera amon hte comment peebiic static final int Pineamel waiue public static final iclas t name new ficiascs _ mame 1 case name return fTinamal The first Php tab allows to define the default Php class definition depending on the stereotype 59 of 357 07 10 2007 16 00 60 of 357 file C uml BOUML bouml_3 0 doc TOUT html a GenerationSettings dialog a nm hi comment finalj ivisibility abstract class name lextends implemeants members Class default declaration S comment i visibility interface name members Interface default declaration comment final visibility class name iitems Enum default declaration The first dl tab allows to define the default Id class definition depending on the stereotype GenerationSettings dialog ER Types Stereotypes et e t cea cra CHS Javafi Javai Java a eifndef NAME M F far artat define f MANGE M 4 content te 7m amm ac ues b comment abstract il0ocal interfaces s inherit Interface default ej members declaration comment abstract custom valuetype name inherit Valuetype default 5 members declaration comment struct name Struct default members declaration TUE comment union name switch switch U
213. ent default passing for them cse fava ich Ceci Coe out Cetinout Cre retum do itype amp sine Sipe amp void void baal char unsigned char unsigned char Short unsigned short Int int int unsigned int unsigned long unsigned long float double acstring char vor char The fourth allows to specify the default declaration and definition of an operation without the parameters the default argument pass enumeration s item and an argument whose type is not one of the types defined in the first tab and if a throw must be generated when the operation does not have exception They are visible only if C is set through the menu Languages 105 of 357 byte GSocketDevice Socket vould Object boolean char char byte short short init long lang float double String String lang void army boolean char octet octet short itype itype amp const type tyne Sityper Sityper itypej Pitypey itype unsigned short Bitype l ng Siypey unsigned lang Stype unsigned lang Stype lang Stype unsigned long type laat double string string item id octet Socket C ditype Bitype type Bitypey Stype t type amp itype amp Ditype amp itype amp itype amp pype amp type amp itype amp dite amp jityne Biltype amp itype amp Sitype amp typ
214. eption depending on the generation settings staticnl produce a line break when the operation is static else an empty string In case you do not like this notation change the generation settings to remove this macro body is replaced by the body of the operation this macro may also be replaced by the body itself BOUML use this way for the get and set operations associated to a relation attribute The usage of body has a great advantage when you hit Default definition the body is not cleared At least BOUML share the definition forms of the operations and other objects to minimize the neec memory size body help for this The indentation of the keyword body is added at the beginning of each line produces the annotations when it is present in the definition the button Edit annotation is active a specific dialog allows you to enter the annotations proposing the default annotations Deprecated and the ones defined through the classes stereotyped interface Ta add an annotation at the cursor position you may select it in the fist and press add Add Deprecated The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted The edit body button is active when the definition contains body to edit it through the editor you want define the environment variable BOUML_EDITOR furthermore when you set a
215. er the stereotype of the class control to draw the control icon whatever the stereotype of the class boundary to draw the boundary icon whatever the stereotype of the class entity to draw the entity icon whatever the stereotype of the class actor to an actor whatever the stereotype of the class natural the draw the class depending on its the stereotype show context To indicate if the context where the class is defined must be written and if yes how The context may be the UML context which 62 of 357 07 10 2007 16 00 63 of 357 file C uml BOUML bouml 3 0 doc TOUT html is the path of the class in the browser or the C namespace or the Java package or at least the Idl module In case the class has an associated artifact the namespace package module is the one specified by the package containing the artifact else by the package containing the class itself Obviously nothing is written in case the namespace package module is not specified For instance the package p2 specify the C namespace nsp the Java package pck and the Idl module mdl The C picture is depending on the show context H context UML C namespace Java package Id module amp Package1 E Package2 Package Package C pck C B FaClass views EC hide attributes To hide or not the attributes it is also possible to specify the visibility for each one hide operations To hide or not the operations it is also possible
216. eration add set operation add get and set operation delete select C2 mark tool Menu edit edit allows to show modify the relations properties In case the relation is read only the fields of the dialog are also read only Relation dialog tab Uml 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The tab Uml is a global tab independent of the language CDREUEUEe a i ree Url ces Java IDL Properties o mo Cm type association stereotype d associatlon EE r inc name inecz multiplicity initial value Editor D class relation l volatile l read only public protected C private package eal Editar lescription Detauit constraint Edito r in C2 name nec multiplicity initial value Edito I class relation l volatile read only C public protected private C package Editor description Default constraint Edita Here the two roles are editable because the relation is bi directional and because it is an association or aggregation The default name of a relation is its kind between and for instance association the default name does not appears in a diagram It is possible to change the kind of the relation through the combo box type but it is not possible to reverse a relation the role A is always attached to the start class used to draw
217. erred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e iso A5 592 x 840 e iso A4 840 x 1188 e iso A3 1188 x 1680 e iso A2 1680 x 2376 e iso Al 2376 x 3364 e iso AO 3364 x 4756 e USAA 864x 1116 e USAB 1116x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored 246 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Link Menu The menu appearing with a right mouse click on link is something like these supposing the diagram not read only in the first case the link is doesn t have an associated relation edit select relation in browser select labels Edit labels default position Geometry Coit geometry Coil remove from view Remove fram view OLink Menu edit edit allows to choose the relation supported by the link the available relations depends on the type of each extremities the current relation if set is shown by the selec
218. es parameter stereotypes Activity Drawing A activity is drawn in a diagram as a rectangle with rounded corners Bouml home bruno uml EX activity activity prj a5 Project Windows Jools Miscellaneous Help lus d b ED NO 8 activity e tirleeesoneseengxposones os os zz Ei PalClass view T M E 4 Zan activity ERE Process Order Process Order lt lt singleExecution gt gt Blpiagram precondiion order complete i spostcondition order closed a Requested Order oos flow Be amp OhReceive Order Requested Receive 20 A t oxflow t xflow Fi Order EC Ship Order Close Order A gri 2D E CSend Invoice p low BOMake Payment EX Accept Payment EH Tnvoice Process Order Note the activity sub elements are forced to be inside their activity rectangle So when you want to draw in a diagram both ai activity and some of its elements I strongly recommend to add first the activity then the elements else when you add the activity the elements may be moved to be inside the rectangle broking their pretty respective positions 138 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html A right mouse click on a activity in a diagram calls the following menu supposing the activity editable Process Order adc parameter Upper lower edit drawing settings edit activity select in browser set associated diagram remove from view delet
219. es artifactzs Result after batitutlon You can modify it as you want except the constructor eris eiass UmlArtifact public UmlBaseA rtifact UmlArtifacti htnl SEKind hi In BOUML the generated code is obtained by the substitution of macros in a text only the Definition part is editable the other one help you to see what will be generated for C supposing you do not modify the C code generator When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to generate the C header file for instance for the main empties the declaration manually or using the button not generated in C NAME produce the artifact name capitalized Name produce the artifact name with the first letter capitalized at least name produce the artifact name without modification comment is replaced by the artifact description adding description is replaced by the artifact description without adding includes is replaced by the automatically generated include and using forms done by the C code generator not made by the dialog which produce a fixed form It is also a good place to add your include and using forms when the ones produced by the code generator are not sufficient The C code generator does not look at in the operations body only t
220. es operations extra members and dependencies on packages The order of the class s sub items is very important because it is followed by the C Java Idl generators AS UmiClassDiagram r generalisation UmlBaseClassDiagram peUmiClassDiagram vx sKind w memo ref wsref index ssgenerate index mna diagrams ex nitialization The representation of a class in the browser indicates if the class is abstract or is a template class furthermore a nested class icon has a reduced size E BgiClass view E EjStandardClass BeEmbeddedClass SeEmbeddedlemplateClass ES AbsiractClass EdTemplateClass A class is the support to define all kinds of class depending on the languages the stereotype specify what a class is The way a stereo translated for each language is configured and is specified through the generation settings You can set a default list of stereotypes for the classes and their relations through the edit default stereotype entry of the project s menu Some stereotypes have a special meaning for BOUML e typedef a class having this stereotype may have an associated base type used to construct the typedef It is not pi relation attribute operation to a class stereotyped typedef nor to define it as a template but it may instantiate a template This stereotype doesn t have sense in Java e enum a class having this stereotype is an enum need at least the JDK 5 in Java Because a Java JDK 5 enum may hav attributes relatio
221. escription macro appears in the class definition as a comment The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support The default button visible above associated to the description allows to set the description with a default contain specified through the generation settings Useful to generate comments compatible Java Doc or Doxygen for instance Class dialog tab Parametrized The parametrized tab allows to specify the formals of a template generic class For instance with Class dialog ie rm er e Umi Parametrzed c Java IDL user Enter formals in case the class is parametrized Name Defaut value C4 Extends Javaj dal KO if the class have the default proposed class definition the C class definition named Dict is template lt class V class K string class Dict Class dialog tab Instantiate The instantiate tab allows to specify the actual of a class inheritin
222. et to default Settings ssl eis write node instance default horzontaly Node color write node instance horizontally Allows to write the the node type and the instance name on the same line see host below or on two lines see laserwriter below Menu select linked items To select all the items connected by one or several lines whatever the line represent relation anchor help to quickly select them for a moving etc Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the node representation in a diagram browser After that the only way to edit the node is to choose the edit entry in the menu Previous artifact Next use case diagram 201 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Use case diagram key down ect GDPBFPI Dn scale 100 aj D keyboards and pedalboards organist key down The use case diagrams may be placed in a use case view or a use case El zexternal events i Overall E cC okey down Fakey down A use case diagram is created through the new use case diagram entry of the use case view and use case browser menus Browser Menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings d
223. ete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved 203 of 357 07 10 2007 16 00 Menu mark See mark Browser Menu tools file C uml BOUML bouml_3 0 doc TOUT html The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Format Use ca se diagram menu Edit drawing settings select diagram in browser Select all Ctri a Optimal soni B Optimal window size Copy optimal picture part Copy visible picture part Save optimal picture part pnr Save visible picture part png Save optimal picture part svg Save visible picture part svg Set preferred size and scale set preferred scale size unset Restore oreferred size and scale Unset preferred size and scale Unda all changes Select all the items of the current diagram also done through a control a Picture Menu optimal scale similar to the fit scale button change sca
224. f it is defined for the class or at an upper level else it is not substituted Refer to the generation settings and Idl generator for more details and explanation of the other keywords Menu duplicate The menu entry duplicate clone the relation in the two directions when the relation is bi directional The name of the role s is empty in the new relation s Menu add These entries allow to produce get and set operations on the relation contrarily to the similar operations made by hand these two ones are linked to the associated relation to be updated or deleted when the relations is deleted The default name of the operations and their characteristics are set through the generation settings By default the get and set operations generated for the C s relation theC2 are C Java Php inline const C2 C get theC2 const public final C2 get theC2 final public function getTheC2 return theC2 return theC2 return this 5thec2 void Cisset_theC2 C2 value public void set theC2 C2 value theC2 value theC2 value public function setTheC2 value Sthis gt theC2 Svalue Menu delete The menu entry delete is only present when the relation is not read only Delete the relation associated get and set operations when they exist and all the representation of them in the opened diagrams After that it is possible to undelete them from the browser until you close the project obv
225. f the instance is not fixed to help you by default an instance is inserted on the top of the picture use the mouse to move it horizontally or vertically Message Menu Insert in model exit from model There are two kinds of class instances instances part of the model visible in the browser and pure graphic instances to not pollute the model with many useless instances The button H add or create an instance part of the model The button Ed add or create a pure graphical instances But after that you are able to transform a pure graphical instance to a modeled one or to replace the drawing of a modeled instance by a pure graphic on the modeled class instance itself is unchanged Message Menu Replace it This entry appears on a pure graphical instance and allows to replace it by a modeled instance of the same class Continuation Menu The size of an activity bar is updated when it is renamed and the name is to long to be written inside the drawing else the continuation drawing may may be resized by hand The menu appearing with a right mouse click on a continuation is something like these supposing the diagram not read only 217 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html edit drawing settings select linked items remove from view Message Menu edit drawing settings This dialog allows to specify the color of the continuation ellipsis Message Menu select
226. f them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on an interruptible region The selected tool is called and applied on the current region Expansion node menus The expansion node menu appearing with a right mouse click on its representation in the browser is something like these supposing the node not read only nor deleted see also menu in a diagram expansion node edit duplicate delete referenced by mark Menu edit edit allows to show modify the expansion node properties In case the node is read only the fields of the dialog are also read only Expansion node dialog tab Uml Expansion Node dialog 2 umm Umi od ee Java Properties name expansion node Stereotype 1 rriultipilcity ordering unordered in state F is control description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The proposed types are the non class types defined in the first tab of the generation settings more all the classes defined in the project with their localization to distinguish synonymous classes
227. file C header class EM ifdef NEEDED decl publro v id Opt tendif ifdef NEEDED f def inline void EM op tendif Extra member dialog tab Java The tab Java allows to specify the code generated in Java it is visible only if Java is set through the menu Languages for instance 112 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html with EM2 init amp GEM weht ax init static H new Hashtable and Lim c Java id user l transient Declaration protected Hashtable ht Result after substitution Default declaration Mat generated In Java The generated code for EM2 is class EM2 protected Hashtable ht static H new Hashtable Extra member dialog tab Php The tab Php allows to specify the code generated in Php it is visible only if Php is set through the menu Languages a Extra Class Member dialog 45 TI Extra member dialog tab Idl 113 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The tab Idl allows to specify the code generated in Idl it is visible only if Idl is set through the menu Languages roo Lim c Java Iai user Idi Menu duplicate The menu entry duplicate clone the extra member Menu delete The menu entry delete is only present when the extra member is not read only Delete the
228. file C uml BOUML bouml 3 0 doc TOUT html BOUML User Manual 1 of 357 07 10 2007 16 00 2 of 357 file C uml BOUML bouml 3 0 doc TOUT html BOUML BOUML is a UML tool box allowing you to specify and generate code in C Java Php and IDL The main key points of BOUML are e it is free it runs under Linux Sun Solaris MacOS X and Windows it allows to program simultaneously in C Java Php and IDL thank to a full access to the generated forms you are the master and you decide what must be generated it is extensible and the external tools I name them plug out because they are executed outside BOUML may be developed in C or Java using BOUML for their definition as any other program clearly I do not like very much language like Visual Basic and I do not understand how this one can be imposed in a UML environment e it is fast and doesn t need a lot of memory to manage several thousands of classes see benchmark To develop BOUML alone at home during the nights and weekends is hard and tiring perhaps crazy The reasons inciting me to do it are mainly the pleasure to develop freely a tool and I hope to see it used by many people I already had this very plea experience with two friends for Xcoral and frankly a reaction to the very expensive price of the commercial UML tools The graphic part of BOUML is based on Qt many thanks to Trolltech for this marvelous GUI application framework clearly BOUML exists
229. fine shortcuts to apply a plug out a Shortcut dialog prin we Command Tool Here are the shortcuts to call a tool plug aut or emi mi A plug out is specified by its display specified through the plug out editor The available plug outs are proposed on a mouse click in the column tool display Icons bar e Ep ep Gm ti These buttons allow to e open a project e save the current project e print the active diagram a first menu appears to choose the printer or print in a file ans set properties then a second dialog ask you to print the diagram on 1 4 or 9 pages e search for an element through its name and may be its kins or to search for a string in the declarations definitions or operation bodies a Browser search 5 TET kind lt Any gt Containing D case sensitive T even deleted name description declaratlon definitiorvbady Result e navigate in the historic of the last selected elements in the browser e describe the behavior of a button or a menu entry for that hit the button then the desired button or select a menu entry a short description will be given When you maintain the mouse on a button a very small description also appears 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Previous starting Next browser items 10 of 357 07 10 2007 16 00 11 of 357 Browser items El hrowseritems I other Package EH Package E PajUse Case
230. g out upgrade of the menu Tools this entry doesn t appears while a dialog is opened or when the project is not a plug out Show Trace Window CtieT Generate C Cii4 c Generate Java Chri Generate idi Ctrl Reverse C Reverse Java Java Catalog Plug out upgrade Generate pro html java version html C version Java catalog Tools settings import setings When it is applied the plug out ask you for a confirmation thus it adds the needed classes etc When all is done a new dialog appears for information and a save as is called asking you to save your plug out in a new location thus in all the cases the project is closed Previous Rose import Next C utilities 326 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html C Utilities Some utilities concerning C When it is applied to a class it allows to add specific operations not yet defined SSS mae C utilities for the class moteur the class doesn t have cantructor add constructor the class doesnt have destructor F add destructor virtual lM add copy constructor with const argument D add copy constructor with non const argument the class doesn t have copy contructor F add assignment i with const argument the class doesn t have assignment operator D add assignment with nan const argument The content of the dialog depend on the already defined operations Previous Plug out upg
231. g templates classes It appears only when the edited class inherits or realizes at least a template class Obviously a template class may inherit another ones For instance with this definition of Dict 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Diagram X Class dialog lt 3 imme Liml Farametrizec c Java IDL user Enter formals in case the class is parametrized Type C Default value C Extends Java de 1 V string E string co if the class have the default proposed class definition the C class definition of theredheaded is class theredheaded public Dict lt string string the Java class definition is class theredheaded extends Dict String String When the class theredheaded 1s edited only the actuals are editable in the tab Instantiate both for C and Java Supposing you have a template class vector and you want to define a vector or boolean obviously the right definition is not class vectorOfBoolean public vector lt bool gt the right definition is template lt gt class vector lt bool gt To do this you just have to define the class named vector lt bool gt Class dialog tab C This tab allows to give the C definition of the class it is visible only when C is set through the Languages menu Template definition Class dialog lt 2 gt pm Java IDL User Texoma S comment template e
232. generated file is the name of the artifact including the extension e source see below e else nothing is generated for the artifact The generated file name is the artifact s name with the extension specified in the first Php tab of the generations settings 305 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html i GenerationSettings dialog ap er Ty Types Stereotypes etii cesa C ca c Java Java Javaj Jawata Prefi lt php comment file default a ion generated reversed content file extension i inailfivisibillity fiabetract cilass Ff iteme ti ent eteda T implioement s In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Php code generator are e comment is replaced by the artifact description adding e description is replaced by the artifact description without adding e definition is replaced by the definition of the classes associated to the artifact e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the artifact if not found for the deployment view containing the artifact if not found in the package containing the deployment view etc Class The Php definition of a class is set through the Uml Parametrized Instantiate and Php tabs of the class dialog A Php type definition may be a class an
233. gh the miscellaneous menu the form defining the operation in the editor is added at the beginning of the edited file home bruno uml html gen cpp decl body 87ffa30 2 cpp E munie Hinds Edit Hodes Search Ewginn Font Misg void Uml ttribute gen cpp decli CString s bool descr 1 SibodyF3 these lines will be automatically removed const char ni if descr t writel cppVisibilityl DefaultVisibilitu 7 visibility cppVisibility TRUE Tu urite j penzcpp deci body WF T2302 cpp Cerne Operation dialog tab Java This tab allows to give the Java definition of the operation it is visible only if Java is set through the Language menu TET erem uen ee Java ia Properties I final synchronized FISH POR EE a ee mune qe PETERE CER ORRERANTE AREA sinana Sith s p0 t1 Hpi S t2 amp ip2iS ey throws etaticnl i body Definition Li entry to produce the hinl code receiving chapter number path rank in the mother and level in the browser tree public void htnl string pfix int rank int level throws I0Exceptian body Result afer subsiilulion Edit body Default definition Mot generated in Java In BOUML the generated code is obtained by the substitution of macros in a text only the Definition part is editable the other one help you to see what will be generated for Java supposing you do not modify the Java code generato
234. grams Activities others Interruptible activity region stereotypes expansian regian Stereotypes Mare OSs Te DES ein expansion node stereutypes Expansion region drawing An expansion region is drawn in a diagram as a dashed rectangle with rounded corners with the indication of the mode A right mouse click on a the region in a diagram calls the following menu supposing the region editable Menu add expansion node set associated diagram expansion region add expansion node upper lower edit drawing settings edit expansian region select in browser remove from view delete from madel These entries of the menu allow to add an expansion node Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A 147 of 357 settings valuing default 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a region in a diagram all the settings are set to default Expansion region Color default To specify the fill color Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the region representation in a diagram or the browser After that the only way to
235. hapter sequence diagram for more details Collaboration diagrams A class instance is drawn in a collaboration diagram as a rectangle the value of the attributes and relations don t appears zeiz aje P383 BaB fAo ioo ii fitt Sot A right mouse click on a class instance in a collaboration diagram calls the following menu supposing the instance editable sandrine Woman Upper Lower Edit drawing settings Edit Select in browser Select class in browser Exit from madel Remove from view Delete from model Please refer to the chapter collaboration diagram for more details Object diagrams A class instance is drawn in a collaboration diagram as a rectangle the value of the attributes and relations appears 117 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html husband A right mouse click on a class instance in an object diagram calls the following menu supposing the instance editable joana Woman Unser u mi Lower Edit drawing settings Edit Select in browser select class in browser select linked items Remove from view Delete fram model Please refer to the chapter object diagram for more details Previous extra member Next state 118 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html State Currently BOUML manages only the behavioral states A state represents a state machine a sub machine a composite state or a simple s
236. has a multiplicity greater than 1 Menu duplicate The menu entry duplicate clone the class instance except the value of the relations Menu referenced by To know who reference the current class instance Menu mark See mark Menu delete The menu entry delete is only present when the class instance is not read only Delete the instance and all the representation of it in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu tool The menu entry fool is only present in case at least a plug out may be applied on a class instance The selected tool is called and applied on the current class instance Drawing Sequence diagrams 116 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html A class instance is drawn in a sequence diagram as a rectangle or an icon depending on the class s stereotype and the drawing settings the value of the attributes and relations don t appears sd x le Eigeoe ec n 100 A o max O O 6 3 Entity Boundary Control Actor A right mouse click on a class instance in a sequence diagram calls the following menu supposing the instance editable pascal Man Upper i Lower Edit Become mortal Edit drawing settings select in browser select class In browser Exit from madel Remove from view Delete from model Please refer to the c
237. he Php code generator When you push the button Default definition the form specified through the generation settings is proposed adding all the operation parameters given in the UML tab These forms may be modified as you want even to produce illegal source code When you do not want to have this operation defined in Php empties the definition manually or using the button not generated in Java visibility produce the visibility see the UML tab except if the visibility is package use this case to generate Php 4 code final produce an empty string when the check box final is not checked else produce final static produce an empty string when the operation is not a class operation see the UML tab else produce static abstract produce abstract when the operation is abstract see the UML tab else an empty string name is replaced by the name of the operation and produce and but there are also a mark for BOUML to find the parameters list t lt n gt and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter add modifiers like array or amp etc staticnl produce a line break when the operation is static else an empty string Not used bu default to add it change the generation settings to use this macro body is replaced by the body of the operation this macro may also be replaced by the body itself BOUML use this way for the get
238. he activity s properties are exposed below Activity parameter To simplify in Bouml a parameter is both a UML parameter and a UML parameter node this means that the properties of a parameter also contains the properties of a parameter node In the browser a parameter is placed under its activity and may contains flows A flow can t directly connect two parameters a parameter is connected through a flow to an expansion node or an activity node activity action object node or control node whose must be in the activity owing the parameter Note parameter sets are defined on actions see actions Activity Menus The activity menu appearing with a right mouse click on its representation in the browser is something like these supposing the activity not read only nor deleted see also menu in a diagram sd activity New activity diagram acd parameter add interruptible activity region new expansion region add activity action add object node edit duplicate mak Menu add These entries of the menu allow to add as activity diagram a parameter a region or an activity node activity action object node or control node The activity diagrams nested in a activity are the ones for the activity this means that in case you use this activity 132 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html diagram to create a new region or an activity node these ones will be a child of the activity i
239. he button Edit annotation is active a specific dialog allows you to enter the annotations proposing the default annotations Deprecated and the ones defined through the classes stereotyped interface To add an annotation at the cursor position vau may Select it in the fist and press add Add Deprecated Refer to the generation settings and Java generator for more details and explanation of the other keywords Attribute dialog tab Php This tab allows to give the Php definition of the attribute it is visible only when Php is set through the menu Languages 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html For a standard attribute i Attritoute ialog sa mi hic Lim c Java Php idi Pranerties icomment visibility f const statici var name value the name of the stop Reeds are trumpet cromorne Flutes are bourdon rhorilote Result after Principal are montre prestant ewe Strings are viola unda maris substitution Mutation are nazard thierce Compound are mixture cornet protected name zi Default declaration Mot generated in Php coe For an enumeration s item of course in the generated code is replaced by the rank of the item in the enum a Enum item dialog TTR Liml ce java Php idi Properties const name value comment Declaration const Compound have mo
240. he current user is unchanged e Protect unassigned packages recursively from this one to protect all the unprotected packages from the current and going down recursively the state of the other packages unchanged e Protect all packages recursively from this one Alt p to protect all the packages from the current and going down recursively e Assign to user unassigned packages recursively from this one to protect except for the current user all the unprotected packages from the current and going down recursively the state of the other packages is unchanged e Assign to user all packages recursively from this one Alt a to protect except for the current user all the packages from 340 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html the current and going down recursively e Unassign user s packages recursively from this one to not protect the packages own by the current user from the current package and going down recursively the state of the other packages is unchanged e Unassign all packages recursively from this one Alt u to not protect the packages from the current package and going down recursively Warning the change is immediately made and these is no undo Change the current user To change the current user use the button representing an actor or the entry in the project menu a dialog appears Choose iss Select a user ta get its identity you may change or set his name U
241. he menu Languages Not generated in Php lt php abstract abstract class Cl extends C2 implements I Result after sipi substitution PP Va 191 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to generate the Php source file empties the declaration manually or using the button not generated in Php comment is replaced by the artifact description adding description is replaced by the artifact description without adding definition is replaced by the definition of the classes associated to the artifact The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Artifact dialog tab Idl source This tab is only available for the source artifacts and allows to give the definition of the Id source file generated for the artifact it is visible only if Idl is set through the menu Languages In the picture given for the UML tab the Idl tab is not enabled because the artifact is not associated to at least one class defined in Idl else Mifndef NAME H tdefine NAME H E comment File E includez definition medule start definition module end te
242. he ones defined through the classes stereotyped interface To add an annotation at the cursor position vau may Select it in the fist and press add Add Deprecated carea The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Class dialog tab Php This tab allows to give the Php definition of the class it is visible only when Php is set through the Languages menu For an enum class with the stereotype enum 53 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html a Class dialog TTR Liml Parametrized C Java Php IDL Properties T final T extemal comment final visibility class name Siitems Definitlan final class Enum 2 One Result after irs substitution Default definitian Not generated in Php Standard class Limi Parametrized C Java Php io Properties T final lI external Definition Result after substitution Default definition Not generated in Php visibility produce an empty string when the visibility except if this one is package If you want to generate Php 4 set the visibility to package final produce an empty string when the check box final is not checked else produce final abstract produce an empty string when the check box abstract is not checked els
243. he operation s profile relations and attributes classes inheritances etc are used to compute the needed Zinclude list includes and all includes are exclusive all includes is replaced by all the automatically generated Zinclude and using forms it is also a good place to add your Zinclude 189 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html and using forms when the ones produced by the code generator are not sufficient In this case the code generator doesn t produce declarations in the header file nor include in the source file except the ones added by you all includes and includes are exclusive declarations is replaced by the class declarations generated automatically done by the C code generator not made by the dialog which produce a fixed form It is also a good place to add your declarations when the ones produced by the code generator are not sufficient namespace_start is replaced by the namespace xx forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact is defined definition is replaced by the definition of the classes associated to the artifact namespace_end is replaced by the forms dependent on the namespace specifications associated to the package containing the deployment view where the artifact is defined The forms property are replaced by the value of the corresponding user prope
244. he project Creating a new plug out The distribution of BOUML contains a project named empty this one is a plug out doing nothing for you point of view in fact it implements in C and Java the API allowing to interact with BOUML To develop a new plug out open the empty project BOUML will ask you to save it in an other project to keep empty unmodified You may also develop a plug out from one of the others available plug outs you just have to know that these ones was developed at different step of the BOUML definition then they do not contain all the BOUML API and some operations may not be defined By definition empty contains all the API The empty plug out contains several already defined classes with their associated artifact half of them are placed under the package API BASE and implement the API with BOUML you cannot modify them they define the system part of a plus out The other half is yours each of these user classes inherits to a system class and sometimes a system class inherits of a user class for instance the classes associated to the classes are 333 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html s members classes inheritance diagram Class and clas eat v E 1 E t o4 4 d a 4 DO HH at Scale 90 eus E In this diagram the blue classes are the system classes the other classes are yours UmlItem is the user class inherited by almost all the other classes
245. he right mouse button or do a double click with the left mouse button 257 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html A line may be broken during its construction of after clicking on the line with the left mouse button and moving the mouse with mouse button still pushed To remove a line break a double click on the point with the left mouse button is enough or use the lin break menu of the point using the right mouse button The scale may be changed from 30 up to 200 To allows to see the operation message kinds even with a small scale the size of the unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to rem
246. hen the class view is not read only Delete the class view and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Menu generate To generate the C Java Idl code of all the sub items Refer to C generator Java generator and Idl generator for more details Menu tools The menu entry fool is present in case at least a plug out may be applied on the class view Menu select associated deployment view Only present when the class view has an associated deployment view select it as you do this manually except that you do not have to search it Previous use case view Next component view 37 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Component view A component view may contains components and component diagrams in any order Ee Component view Order 4 Customer Product bcomponent diagram Menus The menu appearing with a right mouse click on a component view in the browser is something like this supposing it is not read only nor deleted Component view new component diagram new component edit edit drawing settings delete mark teal Menu edit Component view dialog 2 name Component view Stereotype 1 description Editar The stereotype of a component
247. hine then you recall this plug out the classes are updated The classes operations and attributes produced by a previous state machine definition but now useless are deleted Warning if a state or other elements is renamed oi moved to have a new parent the corresponding class or class member is deleted and a new one is created If you add classes members these ones will not be deleted while their container is not itself deleted and if they don t have a user property named STM generated so don t duplicate elements created by the state machine generator to not have this property or remove it after Some parts of the generated source code are instrumented to produce a debug message using the function puts of stdio The instrumentation is always a form Zifdef VERBOSE STATE MACHINE puts the message Zendif To activate these traces you must compile the code defining VERBOSE STATE MACHINE Previous Roundtrip body Next XMI generator 319 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html XMI generator As it is signified by their name the XMI generators generates the definition of the project using XMI They are two generators one producing XMI 1 2 the other XMI 2 1 XMI 1 2 generator To be compatible with existing tools the used format is xml 1 0 xmi 1 2 for UML 1 4 This plug out must applied on the project itself it asks you to specify where the xmi file must be generated and if you wa
248. hrough the menu Languages For a standard attribute as you can see string is automatically translated into String thanks to the generation settings Attribute dialog a pimp Lm c Java it User M transient icomment visibility istatic final transient volatile type name value Declaration ithe name of the stop Reeds are trumpet cromorne Flutes are bourdon rhorflote Result after Principal are montre prestant substitutian Strings are viola unda maris Mutation are nazard thierce Compound are mixture cornet protected String name For an enumeration s item 07 10 2007 16 00 86 of 357 file C uml BOUML bouml 3 0 doc TOUT html idimi Cx Java m re icomment public static final int i name valus Darinralion public static final class name new class name have more than one pipe souding per note public static final int Compound mes public static final StopKind Compound new BStopKind Compound Default declaration Not generated in Java In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for Java supposing you do not modify the Java code generator Result after substitutian When you push the button default declaration the form specified through
249. i n ilu ml Oct ce Java Pranerties Fra condition Past condition activity dialog tab C This tab allows to specify the pre and post conditions in C but in fact BOUML doesn t check the syntax this is just a convention 133 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity dialog amp Pa je Liml oct Kec Java Properties Fra condition Post conditian cre activity dialog tab Java This tab allows to specify the pre and post conditions in Java but in fact BOUML doesn t check the syntax this is just a convention Activity dialog 4 Pa m ie i pem i Umi Oct c Kava Properties Pra condition Post conditian Menu duplicate The menu entry duplicate clone the activity without its children Menu referenced by To know who reference the current activity through a dependency or a call behavior action Menu mark See mark Menu delete The menu entry delete is only present when the activity is not read only I speak about the file permission not about the read only UML property Delete the activity and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from 1 browser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on an
250. iagram Drawing Settings dialo bss soeurs class sequence collaboration object state act drawing language default drawing language default classes drawing mode default hide classes attributes default iut hide classes aperatians default show operations full definition default d show classes members full definition default show classes members visibillby default show operation parameter directian default write nametynae horizontally default show operation parameter name default draw all relations default show packages name In Lab default draw all relations default show classes and packages context default automatic labels position default show information note default draw shadow default draw shada default Cancel Cancel Dymo 35 of 357 07 10 2007 16 00 36 of 357 drawing language show operations full definition show hierarchical rank write nametype horizontally show packages name in tab show packages context draw all relations Craw shadow shaw packages name in tah show packages context automatic labels position write transition horizontally show transition definition drew all relations show state activities draw state s regions horizontally drawing language a Diagram Drawing Settings dialo s class sequence collaboration object
251. iagrams this path name is returned when you apply supportFile on the diagram e the configuration of the tools edited throw the entry Tools Settings of the menu Tools is saved in the file tools e the configuration of the Zinclude and using forms associated to the external type and edited through the last C tab of the Generation Settings dialog is saved cpp_includes e the configuration of the imports forms associated to the external types and edited through the last Java tab of the Generation Settings dialog is saved java imports e the configuration of the Zinclude forms associated to the external type and edited through the last Idl tab of the Generation Settings dialog is saved in idl includes Previous Multi users considerations 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Next Troubleshootings 349 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Troubleshootings The plug outs start but do nothing The exchanges between BOUML and each plug out are supported by a TCP IP socket When you ask BOUML to start a plug out it search for a free port number starting at 1024 on localhost 127 0 0 1 this port is given in argument to the called plug out In case you have a firewall it may be necessary to configure it to allow BOUML and the plug outs to use a socket A modification made by a plug out is not see by the other ones To reduce the number of exchange
252. iary boundary control entity enum enum_pattem exception focus Implementation class interface interface metacla Maret ypes Mares VES As you can see it is possible to set a default stereotypes list for the classes and all the relations between classes 07 10 2007 16 00 58 of 357 file C uml BOUML bouml_3 0 doc TOUT html The code generators does not distinguish the generalization and the realization even they do not have the same meaning in UML Generation settings This very important dialog allows to specify many default definitions concerning the classes more details will be given in C generator Java generator Php generator and Idl generator The tabs associated to a given language are only visible when the corresponding language is set through the Languages menu The tab Stereotypes allows to specify how the class s stereotypes are translated in each language a GenerationSettings dialog rr eye Stereotypes cert copay em e certs Javatiy Javatz Javars Javaj Phot Types E C class class class class interface interface interface class class class exceptian num enum enum enum enum enum pattern enum enum struct class class struct union class class union Valuetype Classes s stereotypes COMmespondence typedef class class Class ignored ignored class class class ignored ignored class class class ignored typedef interface
253. ically included files e with relative path ask for the C code generator to generate the relative path of the automatically included files relative to the file soni the include e with root relative path ask for the C code generator to generate the relative path of the automatically included files relative to the diecon specified by the generation settings The first Java tab allows to set the default Java file content associated to an artifact it is visible only if Java is set through the menu Languages 195 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html GenerationSettings dialog E F is es UN generated reversed s fle default definition file extension Content generate Javadoc style comment commenti f ipublic fifinalif abetracticlass name fi exztends iaplements 0 neater jicommaent tipablic interfece name fT ieztendts mentor f ioommentifipubilcififinallflabstract eevum f namalfiimplementse el items i i member a fioomsent ifipublic final class fineme f member e private int value public int value return value The first Php tab allows to set the default Php file content associated to an artifact it is visible only if Php is set through the menu Languages ix GenerationSattings dialog E Hee en generated reversed file extension comment f ifinalifivisibility f abetract class tiname tieate
254. icomment Fie public static final int _ name f value Enum pattern tem public static Final ficlass f iname new f class Unama are imime returm Enum patter hp Taw prem inf Visibility Wadifiers Get operation get Name E default definition L public C protected C private C package F final pare ety iama T ost in timi Set operation default defrtion public protected private C package T final final parameter Mame eet iName T alan in um fioomment fie Fivisibility ifinal Fistetics t Pirynchronttei Coe ater tibody Visibiliby The form in from of also in uml allows to specify the name of the operation in Java the same rule is followed in UML if also in uml is set The second Php tab allows to specify the default Php generated code for the relations and to specify the get and set operati specificities in Php 1 fi comment E ivisibilityl istaticifiveri f iname f value or Association and S eomment visibility const 1 stat io var name value aggregatian default declaration comet Diname f ivalue ioomment E numer atom pes uta it cepto r Visibility shared with Java Modilers default definition public protected private F final name aet Name I also in uml S GpBGOn Visibility shared with Javaj Madifiers poo default definition public C protected C private T final n
255. ifact dialog tab associated artifacts This tab 1s not enabled for a source artifact to set the unordered list of artifacts associated to the current one For instance for th artifact executable of the plug out html artifact dialog lt gt i et Wmi C headel i SDIUTE d ra gource fh S000Ce Associated classes use Stereotype filtering Unassociated artifacts Associated artifacts UmiGuitin API BASE p ClassGlabalCmd API BASE LImiParameter AP BASE CmoFamily AFI BASE LimiStereotype AFI BASE CopSettings API BASE CppsetingsCmd AFI BASE FileWriter Aux IdiSettings AF BASE IdiSettingsCmd AP BASE JavaSettings AFI BASE JavaSettingsCmd AP BASE Main AFI USER MiscGlobalCmd API BASE OnlnstanceCmd AP BASE PackageGlabalCmd API BASE liewlArhialberorictor TAD Mee Menu delete The menu entry delete is only present when the artifact is not read only Delete the artifact and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu generate The menu entry generate is only present when the artifact is a source artifact Allows to call the C generator Java generator Php Generator and Idl generator 193 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Menu edit The menu entry edit is only present when the artifact
256. ified by any user using BOUML e W the package is protected no users may modify it using BOUML e I the package is own by the current user only the current user can modify it using BOUML e L1 the package is own by an other user indicated by the columns Owner id Owner name only this user can modify it using BOUML e 8 the package is not protected and its associated file is read only you can t modify the write access e W he package is protected and its associated file is read only you can t modify the write access e the package is own by the current user and its associated file is read only you can t modify the write access e 8 the package is own by an other user and its associated file is read only you can t modify the write access Package menu A menu appears when you do a right mouse click on a package its content depend on the package access the entries are Ctrl is replaced by Apple under MacOS X e Protect this package Ctrl p to protect the current package no user will be able to modify it using BOUML e Unassign this package Ctrl u to not protect the current package all the users will ne able to modify it using BOUML e Assign this package to user Ctrl a to protect the current package except for the current user e Protect user s packages recursively from this one to protect the packages own by the current user from the current package and going down recursively the state of the packages not own by t
257. ify packages s generation directory relative to the ront directory rather than absoluta A root directory may itsen be relative to the project path Cee root dir rmpreamuicppy Browse Sat It relati Java root dir Ampriminsvs Browse Set it relai Php root dir Browse Set it ab sol id root dir Browse Set rt absolu Gm This one allows to specify a root directory where the generations will be made this the possibility to change it at each package level as it was previously said This root directory may be relative to the project The browse buttons call a file browser Menu edit drawing settings W Diagram Drawing Settings dialo nous c class sequence collaboration object USE CASE collaboration object use CASE drawing language umi classes drawing made drawing language hide classes attributes hide classes aperatians show operations full definition na show classes members full definition no show classes members visibility no show operation parameter direction yes write namgtype horizontally show operation parameter name yes v draw all relations show packages name in tab draw all relations show classes and packages context automatic labels position show information nate draw shadow draw shadow Cancel Cancel 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html a Diagram Drawing Settings dialo aoa class sequence collabora
258. ilc The parameters have obviously a direction but I known a commercial UML tool which does not manage it a name a type following the considerations about the return value type and a default value unfortunately this one is not yet managed by the code generators The last column do of the parameters table allows to insert delete move a parameter Insert param before insert param after delete parar copy param cut param paste param move param d The exceptions produced by the operation may be specified even for C these types follow the considerations about the return value type The last column do of the exception table allows to insert delete move an exception By default the description is used to produce comments by the code generators The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support The default button visible above associated to the description allows to set the des
259. ings and for instance when the elements are classes in a class diagram drawing language unchanged lt unchanged gt drawing mode show context unchanged hide attributes unchanged hide operations unchanged show members full definition unchanged show members visibiliby lt unchanged gt show parameter direction unchanged show parameter name unchanged show information note sunchanged The settings valuing unchanged are not changed for the selected elements in the other case the same value is set for all the elements Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu E dit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window to end the edition 220 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html ais bouml 5 bic saab te A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu font b edit drawing settings sel
260. ings dialog n Visible abstract bool java final boo _tpp extemal bool ddl external boai TT T idi custom baal idi local bool java external bool java pubilc bool classes UmiClass 3 i i Show all Hide all Hide private se DE PEVE protected ones Specify visible members rather than hidden ones If you set specify visible members rather than hidden ones when you will add new attributes these ones will not be added in the class picture Menu individual operation visibility To specify the hidden written operations of the class through the following dialog Pe dialog Ty Hidden actuals UmlActualParaneter UmibaseClass in td item id in n string addFormaliin rank uint in formal LimlFormalParameter read cpp void assaciatedArtifactr UmlArtifact read idl void assaciatedComponents LimlComponent read java vold assaciatedDlagram UmlCiassDiagram read uml vold baseTyper UmiTypeSspec reread if needed void create inaut parent Limiltem im s str UmiCTass formals LimiFarmalParameter get in n string In p UmlPackage 0 Umlclass is amp bstract bogal IsCppExternal bool iajeliCustemh baal f b aaan T Hide private and Show all Hide all Hide private oe Akene ones Specify visible members rather than hidden ones If you set specify visible members rather than hidden ones when you will add new operations these ones wil
261. inked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu upper lower edit fant remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove fram view The other diagram s elements have an own chapter refer to them 278 of 35
262. inked items set associated diagram remove from view delete from madel Menu add pin To add a pin Menu edit drawing settings read variable value action ade pin upper lower edit drawing setings edit activity action select In browser select variable in browser set associated diagram remove from view delete from model file C uml BOUML bouml_3 0 doc TOUT html call behavior action add pin upper lower edit drawing settings edit activity action select in browser select behavior in browser set associated diagram set associated diagram from behavior remove from view delete fram model These drawing settings concerns only the picture for which the menu is called A settings valuing add pin select operation in browser set associated diagram delete from model call operation action Upper lower edit drawing settings edit activiry action select In browser remove from view default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a activity action in a diagram all the settings are set to default show opaque definition defaut show information nate defaut defaut 1 OK Cancel drawing language show opaque definition To write an opaque action s name or its behavior show information note
263. interface or an enum defined through a class depending on the stereotype and its translatior in Php see generation settings In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Php code generator are e comment is replaced by the description of the class adding e description is replaced by the class description without adding e public produce public when the class is declared public e final produce final when the class is declared final e abstract produce abstract when the class is abstract e name is replaced by the class s name e fextend is replaced by the class inheritance e limplement is replaced by the interface inheritance e members is replaced by the code generated for all the class s members relations attributes operations and extra members following the browser order e fitems produces the enumeration items of an enum other members are not produced e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the class 306 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html if not found for the container of the class an other class of a class view etc In the special case where the class is declared external its Php type declaration must contains a line indicating how the name of tl class is generated by default name meaning that the name is pro
264. iously the deleted items are not saved Menu mark See mark Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the relations Default stereotypes dialog 5 mpi vere relations stereotypes 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html As you can see it is possible to specify a default stereotypes list for each kind of relation Associated to a multiplicity the stereotype is used by the code generators to produce the desired forms the translation in each language of the UML stereotype is specifiec through the generation settings Generation settings This very important dialog allows to specify many default definitions concerning the relations more details will be given in C generator Java generator and Idl generator The tab Stereotypes allows to specify how the relation s stereotypes are translated in each language except Php Sequence Sequence Sequence Relations s i SEQUENCE stereotypes correspondence E pe I E z F m Faar tee icoommentilistaticif mutable T ivolatile jficonst fitypel fineame fiveice lot wab 1 commntilfistaticif imutablei T volatile f consti d stereotypel Sitypel f ineme i value x espana AT ficomsment f stat ici d mutable f volattlejf const f it ype finamel fimultiplicity f ivaluel or hultipliciby Association and aggregation Association unspe
265. is made after the class definition as for an inline operation The definition part is produced in the source file rather than in the header one For instance with Editor EM ifdef endif B EIEM s TU m ax ifdef Umi Ce Java iat User Umi Ce Java iat User M inline inline endif C tifdef NEEDED C tendit declaration 9991 declaration E ditor Editor C ifdef NEEDED C Kendif definition SS definition E ditor and 111 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Lim C Java jdi User E follow uml public public protected private DI const l volate T friend T virtual T inline comment friend static virtual type iname 1 const volatilel Declaratian es void opij Result after substitution Default declaration From definition Not generated in C inline 4 typa iclass gt name ii I TE 5 const I t volat ilei ithrow ist at icnl l Definition Result after substitution Default definition From declaration Not generated in C The generated code for the class is C header C source class EM ifdef NEEDED ifdef NEEDED def decl void EM op publao void opt endif tendir In case the extra members and op are inline all is generated in the header
266. is mutable e volatile produce volatile when the relation is volatile e stereotype is replaced by the translation in C of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab must be used in case the multiplicity is a vector or dimensioning and are added when they are not present e fassociation is replaced by the association class see UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the relation if not found for the class containing the relation etc Dependency A dependency having the stereotype friend produce a C friend declaration of the pointed class Inheritance The class inheritance are managed at the class level e type is replaced by the name of the inherited class more the actuals if the generated class instantiate a template Extra member 294 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The C definition of an extra member is set through the C tabs of the extra member dialog No macros Previous deployment diagram Next C reverse 295 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html C reverse The C code reverse is a plug out directly written in C as the C generator Note that the C code reverse cannot be used as a C code round trip and doesn t allows to u
267. is not read only and is a source artifact Allows to edit one of the generated files for instance the header file ti M n inn M Ma gua i UmlArtifact h oo Tm ifndef UMLARTIFACT H tdefine UMLARTIFACT H lh include UmlBase rtifact h include lt qcestring h gt This class manages artifacts yf You can modify it as you want except the constructor class Uml amp rtifact public UmlBaseArtifact public Uml rtifact void id const QCString amp n UmlBaseArtifact id n ilz fentry to produce the html code receiving chapter number path rank in the mother and level in the browser tree virtual void htmliQcCString prix unsigned int rank unsigned int level returns a string indicating the king of the element virtual QCString sKindli Menu referenced by To know who are the classes associated to the artifact and the artifact referencing the current one through a relation Menu mark See mark Menu tool Appears only when at least one plug out is associated to the artifacts To apply a plug out on the artifact Menu select associated class Menu select an associated class Only for the artifact source appears only when at least one class is associated to the artifacts To quickly select the appropriate class the current artifact may also be quickly selected from its associated classes Default stereotypes The dialog allowing to set the default stereotype
268. is signified by its name the HTML documentation generator generates HTML pages describing the object on which it is applied and its sub objects with some indexes When the generator is started some dialogs appear to configure the result you may also se them using the options see below The diagrams are produced in the generated page s the used scale and picture size are the default ones except when there are set for instance see use case diagram The HTML code generator manages the following options in order e flat optional to produce the class definitions in index html rather than in separate files e svg optional to produce SVG images rather than PNG ones generated Html files directory must not contains space mandatory if the next arguments are given except the port number given by Bouml itself del html optional to remove already existing HTML files in the specified directory del css optional to replace the file style css if it already exists in the specified directory do not use this option if you have your own styles Of course in all the cases style css is created if it doesn t exist In case the generated files directory is specified the dialogs don t appears this allows to generate the HTML documentation withou any manual action These options may be set through the Tool setting dialog or when you ask to start a plug out when Bouml is lauched see here Previous XMI import Next genpro 323 of
269. iso Al 2376 x 3364 e iso AO 3364 x 4756 e USAA 864x 1116 e USAB 1116x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes 283 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored Network Menu The menu appearing with a right mouse click on a network line is something like these supposing the diagram not read only edit select stereotype and label default stereotype and label position remove from view Network Menu edit edit allows to edit the network label ethernet stereatype Network Menu select stereotype and label To select the network label and stereotype Useful when you are lost after many label movings Artifact association Menu The menu appearing with a right mouse click on an association between artifacts is something like these supposing the diagram not read only Association edit select stereotype and label default stereotype and label position delete from model Association Menu edit edit allows to edit the association label lethernet stereatype Cancel Association Menu select stereotype and label To selec
270. items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level diagram color packages name in tab defaut default nate color defautt show package context default default use case color defautt automatic labels position defaut default package color default draw all relations defaut 1 default fragment color default draw shadow default 1 default subject color default e package name in tab to indicate if the package s name must be written in the tab which is the small rectangle on the top note a transparent package doesn t have shadow e show packages context to indicate if the context where the package is defined must be written it is not the case just above The context may be t UML context which is the path of the package in the browser choice followed for awt below or the C namespace specified by the package or the Java package specified by the package choice followed for picture below or at least the Idl module Image jave awtinage e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited connected items are moved etc Java ew Browser Menu duplicate Clone the diagram in a new one Browser Menu del
271. k tool b select the required class select the provided class Menu edit edit allows to show modify the component properties In case the component is read only the fields of the dialog are also read only Component dialog tab Uml The tab Uml is a global tab independent of the language mum Ul Required classes Providedirealized Classes User name order stereotype 1 description Editor The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern 183 of 357 07 10 2007 16 00 184 of 357 file C uml BOUML bouml 3 0 doc TOUT html editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Component dialog tab Required classes This tab allows to specify the list of interface the component require Lindl Required class 5 Pr
272. kly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu Overall short cul upper lower open select diagram in browser select linked Items remove fram view The other diagram s elements have an own chapter refer to them Previous component diagram Next C generator 288 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html C Generator The C code generator is a plug out directly written in C the C code generator does not generate itself The generated sources follows the definition made in BOUML at the artifact class operation relation attribute extra member levels When the code generation is applied on a artifact associated to several classes the code generation is made for all these cl Nevertheless the C code generator produce first the code in memory and update the appropriate files only when it is necessary t not change the last write date of the files for nothing Depending on the toggle verbose code generation of the global menu Languages the code generator is verbose or not The C code generator plug out may be call
273. l Previous class diagram Next activity diagram 261 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity diagram es eee Bouml home bruno uml EX activity activity prj oe Project Windows Jools Miscellaneous Help js w ew amp activity jeu FED e OO E Dr lt b oo th oo Ca ob fiore A es eng E FajClass view T LL E 4 an activity SBE Process Order Process Order lt lt singleExecution gt gt Diagram lt lt precondition gt gt order complete pastcandition order closed E x A Requested Order oct slows B E OhReecelve Order Requested Receive I axe Order tosflows flows Fill Order EX Ship Order E COClose Order Bx S3 E E CSend Invoice p flows Make Payment EO AC cept Payment EH Oinveice Process Order P The activity diagrams may be placed in an activity A activity diagram is created through the new activity diagram entry of the activity browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings duplicate delete Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields
274. l e When you import a project the body of the imported operations must be the right one in the imported model The preservi bodies of the imported operations will not be find because the identifier of an operation used to mark its body changes during the import e The bodies under the model are not updated by the code generation a new plug out must be made for that Only the operations using the keyword body may have a preserved body The only modification you can do in the lines containing the delimiters is the indent The toggle is saved in the file associated to the project be sure the save is done when you change this toggle 307 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Attribute The Php definition of an attribute is set through the Uml and Php tabs of the attribute dialog The indentation of the first line of the definition give the indentation added to the class definition for all the attribute definition An attribute may be a standard attribute or the item of an enumeration defined through a class standard attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Php code generator are e comment is replaced by the description of the attribute adding e description is replaced by the attribute description without adding e visibility produce the visibility see the UML tab except if the visibility is packag
275. l Picture Menu copy optimal picture part Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy visible part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s
276. l The tab Umil is a global tab independent of the language a2 Extra Class Member dialog e Uri c Java Php Properties name DM T stereotype 1 description Editor 110 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html The name and the stereotype do not have meaning for BOUML The description is not used by the code generators The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Extra member dialog tab C The tab C allows to specify the code generated in the header and or the source file s it is visible only if C is set through thi menu ZLanguages a Extra Class Member dialog es kai F inline C declaration Editor CT definition Editor The declaration part is generated in the definition of the class containing the extra member except if the inline toggle is set in this case the generation
277. l action These options may be set through the Tool setting dialog or when you ask to start a plug out when Bouml is lauched see here XMI 2 1 generator The used format 1s xml 1 0 xmi 2 1 for UML 2 0 or 2 1 This plug out must applied on the project itself it asks you to specify where the xmi file must be generated and if you want to produce the UML C or Java definitions following some options 320 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html generated mpm xMI fle itmp m xmi l Encoding urs Limi L uml 2 0 uml 2 1 Generate views as package r P Generate pk_ prefix for parameter direction Generate vis prefix for visibility V Use PrimitiveType rather than DataType Generate extensions I Generate If and cr characters in string rather than amp 10 and x13 Umi C Java Cancel The XMI generator manages the following options in order uml or C or java to specify the target language mandatory if other arguments are given except the port number given by Bouml itself generated XMI file path must not contains space encoding for instance UTF 8 view optional to generate views as package uml2 0 optional to generate for UML 2 0 rather than UML 2 1 pk optional to prefix the parameter direction by pk_ vis optional to prefix the visibility by vis_ primitiveType optional to define primitive and derived types like int through
278. l is called and applied on the current state action Default stereotypes The dialog allowing to set the default stereotypes F F a I Default stereotypes dialog lt i Package Class UseCase Artifact Views Diagrams Others rribul state action send signal recelve signal M RES suce Wr ary Faea fem Sr ie Drawing Depending on its stereotype a state action 1s drawn in a diagram as a rectangle a convex pentagon or a concave pentagon A right mouse click on a state action in a diagram calls the following menu supposing the state action editable upper lower edit drawing settings edit state action select in browser remove from view delete from model tool Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a state action in a diagram all the settings are set to default 127 of 557 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html 1 L drawing language detaut state action color defaut 1 drawing language Allows to specify the used language showing the expression State action color To specify the fill color Menu tools Appears only when at least one plug out is associ
279. l not be added in the class picture Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the class representation in a diagram browser After that the only way to edit the class is to choose the edit entry in the menu Menu tools Appears only when at least one plug out is associated to the classes To apply a plug out on the class Previous use case Next relation 64 of 357 07 10 2007 16 00 65 of 357 file C uml BOUML bouml 3 0 doc TOUT html Relation We consider in this chapter only the relations between classes To add a relation to a class you have to use a class diagram obviously the diagram or the relation drawing may be deleted just after it is not possible to add a relation through the browser It is als possible to move a relation into an other class or elsewhere The icon in the browser indicates if the relation is public protected private or package The protected and package visibilities are translated in private in Idl The package visibility is translated in private in C and doesn t produce a visibility in Php use this case to produce Php 4 code A class relation is underlined A bi directional relation is supported by two relation items in the browser A relation have a name a stereotype may have one or two roles and multiplicity one by direction Note that it is not possible specify
280. lass name inherit 2 Declaration members tl 1 inlines E template lt class V class K string class Dict Result after EEY z Value substitution Default declaration Mot generated in C Template instantiation of course a class may be both a template definition and a template instantiation 49 of 357 07 10 2007 16 00 50 of 357 file C uml BOUML bouml_3 0 doc TOUT html Class dialog lt 2 gt 4 repe a ey Liml Parametrized instantiate C Java IDL user T external comment templatejclass iname inherit Declaration imembers Is 1 inlines fA famous french dictionary Result alter class theredheaded public Dictestring string substltutian V 7 ii Default declaration Enum class with the stereotype enum or enum_pattern M external I comment enum name itema Declaration t enum Enum O0ne Resultater Tyo substitution ra Default declaratian Not generated in C Standard class Java io user T external f comment template eclass name inherit D claration members h linlines This class manages classes notes that the class ClassItem is a mother class of the class s children fi Tou can modify it as you want ezcept the constructor eiass UmlClass public UmlBaseClass Result after Umlclas
281. le plug out defined in C and Java both like the HTML code generator to automatize the creation of the artifact for all the classes of the class view on which the plug out is applied e If the class view doesn t have an associated deployment view an associated deployment view having the name of the class view is created in the same package e An artifact with the stereotype source is created and associated to all the classes of the class view without associated artifact the name of the artifact is the name of the class Previous File control Next global change 330 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Global change This plug out defined in C allows to do global modification of the artifact classes operations attributes and relations definitions working recursively from the browser element on which it is applied When you change default definitions or declarations in the generation settings these changes are not propagated in the already existing elements to not broke them This plug out allows you to apply these changes if needed on a controlled way This plug out may be applied on a package including the project itself class view deployment view or a class and works through this dialog global change 2 repel Py ye and Cor filter z with C without and C or filter 3 with without Stereatyne any C is C is not
282. le to see all the diagram s elements at great as possible Picture Menu optimal window size Similar to the button H change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy visible part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality To easily get all the diagram s elements use optimal window size It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality 204 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s canvas size is 840 x 1188 points corresponding to a
283. le value remove variable value call behavior call operation send object L send signal broadcast signal unmarshall or value specification L object nodes control nodes initial final amp flow final ay merge 40 decision X fork sb join Activity nodes may contain e flow e n pins action only Refer to activity action object node and control node for more information E Component 17 Of 357 07 10 2007 16 00 18 of 357 file C uml BOUML bouml 3 0 doc TOUT html A component is an autonomous unit with well defined interfaces that is replaceable within its environment A component may contains e relations e components Refer to component for more information F Artifact Artifacts are basically used to produce source file s when the stereotype is source or to specified how libraries or an execut composed A source artifact is potentially associated to classes but you may directly give its source s contain for instance to define the C main function The other artifacts may be associated to artifacts Note In the old release of BOUML up to the 1 5 1 the behavior of the artifact was defined at the component level An artifact may contains e relations Refer to artifact for more information Node To specify how the deployment is made a node may represent a CPU a device etc Refer to node for more information Use case diagram Refer to use case diagram for more informa
284. lete the component and all its representation in the opened diagrams After that it is possible to undelete it from the browser un 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html you close the project obviously the deleted items are not saved Menu referenced by To know who are the classes associated to the component and the components referencing the current one through a relation Menu mark See mark Menu tool Appears only when at least one plug out is associated to the components To apply a plug out on the component Menu select the required class Menu select a required class Menu select the realized class Menu select a realized class Menu select the provided class Menu select a provided class Appears only when at least one class is required provided realized by the components To quickly select the appropriate class t current component may also be quickly selected from its associated classes Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the components Package Class UseCase Views Diagrams Others component source library executable 0 source library executable stereotypes E o aee Drawing A component is drawn in a component diagram or a deployment diagram following the drawing settings they may be drawn as a rectangle containing the component icon UML 2 0 notation or as a component icon being a rectangle
285. lic int value return wailue sj In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Java code generator are e comment is replaced by the artifact description adding e description is replaced by the artifact description without adding e package is replaced by the package xx forms dependent on the package specifications associated to the BOUML package containing the deployment view where the artifact is defined e fimport is replaced by import forms specified by dependencies stereotypes import from classes produced by the artifact to classes or packages e definition is replaced by the definition of the classes associated to the artifact e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the artifact if not found for the deployment view containing the artifact if not found in the package containing the deployment view etc Class The Java definition of a class is set through the Uml Parametrized Instantiate and Java tabs of the class dialog A Java type definition may be a class an interface or an enum may be defined through a class depending on the stereotype translation in Java see generation settings In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Java code generator are e comment is replaced by
286. livier or Annie When the write accesses are set duplicate the project files in fact the directory of the project to have three images and perhaps fourth image placed under a file controller Bruno Olivier and Annie work each on its private image and don t change the wri accesses except to loose the write access or to get the write access to a protected package s not own by the others sinc synchronization Sometimes for instance because Annie define a class used by Olivier you have to synchronize the parallel developments In this case using File Synchro Annie Olivier and may be Bruno get the modifications done by the others When the project is synchronized it is also possible to change the write access from a user to an other one obviously this must be made on all the images or on on image and copying it in the others Obviously like in any development when an element is removed from the model by Bruno for instance a class he has to ask fc 346 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Olivier and Annie except if this element was not yet delivered to them To move an element inside the browser is not a problen element is referenced through an internal key not through its location In a similar way an element may be renamed because the doesn t contains the name but this may have impact in the body of the operations where the renaming is not taken into accoun BOUML itself Previous Project synchro
287. ll be exposed below Menus The state action menu appearing with a right mouse click on its representation in the browser is something like these supposing the action not read only nor deleted see also menu in a diagram edit duplicate delete referenced by Menu edit edit allows to show modify the action properties In case the action is read only the fields of the dialog are also read only State action dialog tab Uml The tab Umil is a global tab State Action dialog SE LL Umi oc cH Java User Stereotype description Editor The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support State action dialog tab Ocl The Ocl tab allows to specify the st
288. llow the visibility as it is set in the UML Tab or to change it replacing visibility by the desired one to not generate the visibility set it to package static produce an empty string when the relation is not an class relation see the UML tab else produce static 71 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html const produce an empty string when the relation is not read only see the UML tab else produce const var produce var when the relation is not read only nor static see the UML tab and the visibility is not package else produce an empty string name is replaced by the relation s role name see the UML tab value is replaced by the initial value of the relation see the UML tab The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Refer to the generation settings and Php generator for more details and explanation of the other keywords Relation dialog tab Idl This tab allows to give the Idl definition of the relation it is visible only when Idl is set through the Languages menu For an association or an aggregation without multiplicity Relation dialog lt rap ee e Liml C Java fio User ROLE 1 r comment visibility S type namel Declaration private Ce thec2 Result after substitution Default declaration Not g
289. lug out is associated to the activitys To apply a plug out on the activity Parameter Drawing A parameter node is drawn in a diagram as a rectangle with the indication indicating if the parameter is a stream or an exception parameter stream parameter exception A right mouse click on a parameter in a diagram calls the following menu supposing the parameter editable upper lower edit drawing settings resize other like it edit parameter select in browser select class in browser select linked Items delete from model Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a parameter in a diagram all the settings are set to default parameter node color default 1 wa Menu select class in browser Appears when the type of the parameter is a class to select it in the browser Previous pseudo state Next activity region 140 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Activity region There are two kind of regions expansion region and interruptible region both may be placed under an activity or a region In the browser an expansion region may contain sub activity regions expansion nodes and activity
290. m by all those who receive copies directly or indirectly through you then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program 354 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html If any portion of this section is held invalid or unenforceable under any particular circumstance the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices Many people have made generous contributions to the wide range of software distribi through that system in reliance on consistent application of that system it is up to the author donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License 8 If the distribution and or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces tl original copyright holder who places the Program under this License may add an explicit geographical distribution limitatio
291. m in from of also in uml allows to specify the name of the operation in C the same rule is followed in UML if also in uml is set The second Java tab allows to specify the default Java generated code for the relations in Java am sanerationSettings dialog E m i gen Types Stereotypes ce t eta etm eta Corts dava Javalz savers Javaj ie iet ioi iata tals Description bi comment d ie S ivisibilityi Tistaticif finali f itranzienti f volatile f itype finamel f ivalus iinei Y Acree iiome 10 Fivieibility f iatatici fl final t transient f volatile fieterest ype ft inane f ivaius seat mab floomment it idi T ivisibilityiT atat tcififinaii itrangient f wolatile fitypelf imultiplhicity fima f val geetoatiy a a comment a Ivisibilityl static final transient volatile type name value multiplicity T or unspecifie Association and S comment visibllity static final trangient volatile stereotype namel value aggregation multiplicity default or a b declaration comment a ivisibility statiec final transient volatile typel multiplicity name val probably a number The third Java tab allows to specify the get and set operations specificities in Java 150f 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html t
292. ml BOUML bouml_3 0 doc TOUT html Class Settings d Ofer ies volle Sa default relations visibility protected Orta operators vule ont omen By default the description is used to produce comments by the code generators The editor button visible above and associated here to the description and initial value allows to edit the description or initial value in an window or to call an external editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very much this polling but this works even QT isn t compiled with the thread support The default button visible above associated to the description allows to set the description with a default contain specified through the generation settings Useful to generate comments compatible Java Doc or Doxygen for instance Relation dialog tab C This tab allows to give the C definition of the relation it is visible only when C is set through the Languages menu For an association or an aggregation without multiplicity om s Java io User ROLE 1 Visibility follow uml protected public protected private T mutable
293. mpiled with the thread support Activity opaque action dialog tab Ocl The Ocl tab allows to specify the activity action behavior and the pre and post condition using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog ml Oct ce Java Properties Behavior Editor Pre condition Post condition Activity opaque action dialog tab C This tab allows to specify the activity action behavior and the pre and post condition in C but in fact BOUML doesn t check the syntax this is just a convention I510F557 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog Liml Ocl cre Java Properties Behavior Editor Pre condition Post condition cw Activity opaque action dialog tab Java This tab allows to specify the activity action behavior and the pre and post condition in Java but in fact BOUML doesn t check the syntax this is just a convention Behavior Editor Pre condition Post condition cw Activity accept event action dialog tab Uml Activity Action dialog 5 cale iia Urni trigger Ocl trigger C trigger Java Properties name action stereotype 1 accept even acion description Editar Activity accept event action dialog tab Ocl The Ocl tab allows to specify the trigger and the pre and post condition using
294. ms are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only 212 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Sequence diagram menu Edit drawing settings select diagram in browser Select all Ctri a Optimal scale Optimal window size Copy optimal picture part Copy visible picture part save optimal picture part png Save visible picture part png Save optimal picture part svg Save visible picture part svg Set preferred size and scale set preferred scale size unset Restore oreferred size and scale Unset preferred size and scale Format Unda all changes Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram also done through a control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size Similar to the button H change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy optimal picture part Copy all the
295. n excluding those countries so that distribution is permitted only in or among countries not thus excluded In such case this incorporates the limitation as if written in the body of this License 9 The Free Software Foundation may publish revised and or new versions of the General Public License from time to time Such new versions will be similar in spirit to the present version but may differ in detail to address new problems or concerns Each version is given a distinguishing version number If the Program specifies a version number of this License which applies to i and any later version you have the option of following the terms and conditions either of that version or of any later versio published by the Free Software Foundation If the Program does not specify a version number of this License you may choose version ever published by the Free Software Foundation 10 If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different write to author to ask for permission For software which is copyrighted by the Free Software Foundation write to the Free Softwa Foundation we sometimes make exceptions for this Our decision will be guided by the two goals of preserving the free stati derivatives of our free software and of promoting the sharing and reuse of software generally NO WARRANTY 11 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE THERE IS NO WARRANTY FOR THE PROGRAM T THE EX
296. n and a generalization e dependency only the dependency having the stereotype friend are considered by the C code generator e unidirectional association to define a directional relation the code generators will produce an attribute having the role name In C the default generated code use pointer s e directional aggregation to define a directional relation the code generators do not distinguish association and aggregation e directional aggregation by value to define a directional composition the code generators will produce an attribute having the role name In C the de generated code does not use pointer s e association to define a bi directional relation the code generators will produce two attributes whose names are the roles s name e aggregation to define a bi directional aggregation the code generators will produce two attributes whose names are the roles s name T kind of relation may considered to be a shortcut to define two directional aggregations e aggregation by value 07 10 2007 16 00 66 of 357 file C uml BOUML bouml 3 0 doc TOUT html to define a bi directional composition the code generators will produce two attributes whose names are the roles s name This kind of relation may considered to be a shortcut to define two directional aggregations by value By default the example above produce the following codes the visibility may be replaced by var to be compatible with Php 4
297. n is showed see below like for the class drawing in a class diagram For instance the class C has the operation op returning an uchar supposed translated unsigned char in C char in Java and octet in Idl and having the input parameter p having the type uchar and only in Idl a second out parameter p2 of the same type Depending on the drawing language 211 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html _ Sequence Diagram zif xi env E El Bl o m m epe Fite aes opin p uchar int drawing language UML int aprunsigned char p L drawing language C int ap char p drawing language Java ap p an in p uchar int e instances drawing mode to draw an instance in the standard way or tu use one of the icons actor boundary control or entity e show operations full definition to show all the operation profile or just its name may be with the arguments specified at the operation level in the diagram see edit e write class instance horizontally To write the instance type and name on the same line or on two lines Browser Menu duplicate Clone the diagram in a new one Browser Menu delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted ite
298. n iso A4 format 210 4 x 297 4 all the available formats are e iso A5 592 x 840 e iso A4 840 x 1188 e iso A3 1188 x 1680 e iso A2 1680 x 2376 e iso Al 2376 x 3364 e iso AO 3364 x 4756 e USAA 864x 1116 e USAB 1116x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes Undo all the changes made since the diagram was openned the last time Note that the diagram is restored independently of the project saving Obviously the deleted browser items was not restored Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams 205 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Default stereotypes dialog amp TT jl 4 Package Class UseCase Artfact Views Diagrams Activities Others class diagram NEM NNNM stereotypes l object diagram PO stereotypes collaboration diagram stereotypes sequence diagram P Stereotypes use case diagram PO stereotypes state diagram PO stereotypes activity diagram PO stereotypes component diagram OO Stereotypes deployment diagram P sterentypes Drawing key down aD x TE ti e pElI o2 n scale 10056 fit d keyboards and pedalboards organist key down A use case diagram may contain actors classes use cases packages fragment
299. n the browser Menu edit edit allows to show modify the activity properties In case the activity 1s read only the fields of the dialog are also read only activity dialog tab Uml The tab Umil is a global tab Activity dialog 4 Pa vui Oe Umi oct cH Java Properties name fan activity stereotype 1 l readonly T single execution description Editor The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it Read only and single execution are the standard UML flags The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support activity dialog tab Ocl The Ocl tab allows to specify the pre and post conditions using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention Activity dialog amp i dil
300. n the imported model The preserv bodies of the imported operations will not be find because the identifier of an operation used to mark its body changes during the import e The bodies under the model are not updated by the code generation a new plug out must be made for that Only the operations using the keyword body may have a preserved body e The only modification you can do in the lines containing the delimiters is the indent The toggle is saved in the file associated to the project be sure the save is done when you change this toggle Attribute The Java definition of an attribute is set through the Uml and Java tabs of the attribute dialog The indentation of the first line of the definition give the indentation added to the class definition for all the attribute definition An attribute may be a standard attribute or the item of an enumeration defined through a class standard attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Java code generator are e comment is replaced by the description of the attribute adding e description is replaced by the attribute description without adding e visibility produce the visibility see the UML tab e static produce static when the attribute is a class attribute see the UML tab e final produce final when the attribute is final e f transient produce transient when the attribute is tr
301. nd scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale 274 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e USA B 1116 x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes iso A5 iso A4 iso A3 iso A2 iso Al iso AQ 592 x 840 840 x 1188 1188 x 1680 1680 x 2376 2376 x 3364 3364 x 4756 USA A 864 x 1116 Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams 275 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc T
302. ndent of the language 177 Of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Flow dialog mepe name tow Stereotype 1 Umi oct c Java Properties description Editor The proposed stereotypes are the default ones specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype and the multiplicity are used both may be witl the stereotype of the class es in Idl to compute the default declaration The editor button visible above and associated here to the description and initial value allows to edit the description or initial value in an window or to call an external editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel with BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very much this polling but this works even QT isn t compiled with the thread support Flow dialog tab Ocl This tab allows to give the Ocl definition of the flow but in fact BOUML doesn t check the syntax this is just a convention Flow dialog 5 eye Liml Oct cH Java Properties weight guard Editar selection Editar
303. ndif Editor Default definition Not generated In Idi Rifndef UMLARTIFACT H Rdefine UMLARTIFACT H lt include a needed fi11e h produced by the IDL generator Resultafter This class manages artifacts Sec if substitution ijy you can modify it as you want except the constructor valuetype UmlaArtifacr oo shtml a SkKind he fandif When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to generate the Idl source file empties the declaration manually or using the button not generated in Idl NAME produce the artifact name capitalized Name produce the artifact name with the first letter capitalized at least name produce the artifact name without modification comment is replaced by the artifact description adding description is replaced by the artifact description without adding includes will be replaced by the automatically generated include forms not made by the dialog which produce a fixed form in a future version of the Id generator it is a good place to add your Zinclude forms module start is replaced by the module xx forms dependent on the module specifications associated to the BOUML package containing the deployment view where the artifact is defined definition is replaced by the definition of the cla
304. nds ti implements i E eon a tivieibi lity interface i iccement final fiviei ibility clase f riteoms The first Id tab allows to set the default Id file content associated to an artifact it is visible only if Idl is set through the menu Languages 196 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html GenerationSettings dialog tifndef _ NAME _H define _ NAME _H comment includes file extension fid S module start fi comment interface Finame fiinherit i I mamira l i members M Ii ioomment struct inama JE i mantere l en Denis fficommentiunion Finame switchiflewiten i eciar atio fi imanbersi E um optulit comment anum finame kitika item Typecei defaut fF icommeent typedef fitypel finamel or E reception rat f comment except 106 lita ceci ation pf imenbers 1 ke Lie LIS Lis bebe Le Drawing An artifact is drawn in a deployment diagram as a rectangle containing the artifact icon Diagram afk Ea Oye oa o a pem E The default color of an artifact may be set through the drawing settings A right mouse click on an artifact in a diagram calls the following menu supposing the artifact editable 197 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html lib Upper Lower Edit drawing settings Edit artifact select in browser select linked items apt associated diagram
305. ne plug out is associated to the regions To apply a plug out on the region Expansion node drawing A expansion node is drawn in a diagram as pins s suzuazszcraus WHNENENENENENNENENL A right mouse click on as expansion node in a diagram calls the following menu supposing the node editable expansion node upper lower edit drawing settings edit expansion node select in browser delete from model Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a node in a diagram all the settings are set to default expansion node color default To specify the fill color Menu tools Appears only when at least one plug out is associated to the expansion nodes To apply a plug out on the node Previous activity Next activity action 149 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Activity Actions An activity action is an activity node In the browser an activity action is placed in an activity or an activity region and may contain pins parameter sets and flows ELE Saetivity Bi interruptible region EC Faction E 5 pin flows xflow other pin E EHe expansion region E action floe
306. nej amp const type pype amp Stype Sitype type amp Biyper amp jitype amp Tityper amp iypey amp Sitype amp type amp Styne amp itype amp itype amp Bitype amp Styne amp itypej amp Sitype amp Sitype amp Sitype amp Sitype amp Sityper amp ipej amp itypey amp Bitype amp Jipe amp tab icit Stereotypes 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html GenerationSettin gs dialog E dpat ditor eee oor con 09 pet inam F ase uni cst notan paie C pomcmt prata F vta F const paran F bye name zst t name V ase inui i name f ivaius commen i wm ata te dimit Delito Default type utput pid acid pad beo IE typel jt F itype amp pudiese E typa amp mE 5 type for the enums S UR parameter parameter Default type forms for the types mot given pa Fitypel AC itype NEUE UTE type amp iss E T Itype beh tus parameter parameter parameter Ejcomment static virtual itypel inamelsi s 5iconst Eu lelSiabstract Operation default declaration inline type class 1name 0 31 const volatile staticn1 Operation default body definition cu The second Java tab allows to set the default operation definition without the parameters in Java it is visible only if Java is se through the menu Languages
307. new one in the same deployment view Browser Menu delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only Picture Menu edit drawing settings see edit drawing settings Picture Menu select all Select all the items of the current diagram may also be done through control a Picture Menu optimal scale similar to the fit scale button change scale to see all the diagram s elements at great as possible Picture Menu optimal window size Similar to the button HH change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy optimal picture part 282 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy
308. nion default imembarz declaration icomment enum nama Enum default ttitems declaration Tyuedef default B comment typedef itype iname declaration comment exception name Exception default fe i members declaration The tab Description allows to set a default description the default description is used when you hit the button default in the description part of a class of the class dialog 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html GenerationSettings dialog S default description Ot anion deim rieng Ampie e M Smeaton Usar ceri ih euscnpnun Drawing A class is drawn in a diagram as a rectangle or an icon depending on the class s stereotype and the drawing settings Diagrami eat x B BHE 4 4 it Oe te scaie 10056 E A right mouse click on a class in a diagram calls the following menu supposing the class editable StandardClass upper lower edit drawing settings individual attribut visibility individual operation visibility edit class add attribut edit attribut d add operation edit operation b select in browser set associated diagram remove from view delete from model generate tool Menu edit drawing settings 61 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html These drawing settings concerns only the picture for which the menu is called A settings valuing defa
309. nodes activity action object node or control node In the browser an interruptible region may contain sub activity regions and activity nodes activity action object node or control node Et activity Birinterruptible region UPinterruptible region expansion region B mexpansion region snexpansion node expansion region iPinterruptible region The region s properties are exposed below Expansion region menus The expansion region menu appearing with a right mouse click on its representation in the browser is something like these supposing the region not read only nor deleted see also menu in a diagram expansion region add expansion node aod nested expansion region add interruptible activity region add activity action add object node edit duplicate set it nested in region above extract it from current parent region delete mark Menu add These entries of the menu allow to add an expansion node a nested region or an activity node activity action object node or control node Menu edit edit allows to show modify the region properties In case the region is read only the fields of the dialog are also read only Expansion region dialog tab Uml 141 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Expansion Region dialog 5i mmm Umi Properties name expansion regian stereotype 1 made iterative 1 T must isolate description The pr
310. nor an interface The classes and interfaces must be at the toplevel level this means not embeded in a if or other form This part produces definition in the definition of the artifact e the rest if the file probably containing the marker this part is placed at the end of the definition of the artifact When the reverse is done the number of reversed classes operations attributes and relations is written for instance in case I revers the sources of Joomla 1 5RC i Bouml tmp vide vide prj Project Windows Jools Languages Miscellaneous Help Joomla 15AC e FaJoomla 1 5AC Jadministrator amp libraries amp eemponents g includes Php reverse done amp installation amp language 583 classes amp g modules 1412 attributes amp plugins 410 relatians amp templates 9928 operations amp mirpe Previous Php generator Next Idl Generator 310 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Idl generator The Idl code generator is a plug out directly written in C The generated sources follows the definition made in BOUML at the artifact class operation relation attribute extra member levels When the code generation is applied on a artifact associated to several classes the code generation is made for all these cl Nevertheless the the Idl code generator produce first the code in memory and update
311. notes texts diagram icons subjects and the relations To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram The scale may be changed from 30 up to 200 To allows to see the relation kinds even with a small scale the size of the arrows anc unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected 206 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted
312. ns and operations it is possible to add these kinds of members to a class having the stereotype enum but default definitions are empty in C and Idl it is not possible to define or instantiate a template they are not yet managed in Java In Php an enum produces a class having only const variables e enum pattern a class having this stereotype is an enum even in Java for which a special definition compatible with JDK release less than 5 is produced it is not possible to add a relation operation to a class stereotyped enum nor to define or instantiate a template e union a class having this stereotype cannot instantiate a template e actor just to change the representation not relevant for the code generators Obviously because you may change the stereotype at any time it is possible to define for instance a class with an operation and aft that to change its stereotype to enum pattern In this case BOUML does nothing for instance it does not delete itself the operation to help you to come back to a more appropriate stereotype without undesirable modifications The extend of the previous stereotypes include C and Java and Idl both This means for instance that you cannot add an operation to an enum pattern independently of the translation of this stereotype in C Java Idl specified through the generation settings But it is also possible to have stereotypes with an extend limited to each language through the definition of new stereotypes
313. nspeciie Constant default multiplicity comment const sterectype lt itypel gt name value declaration or a b X probably comment const stereotype e typel t imultiplicity name value cm The third Idl tab allows to set the default definition of an attribute in a union the enumeration item default definition and the get anc set specificities for Idl only visible when Idl is set through the menu Languages number 93 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html comment case icase PEE ETY name multiplicity 1 nr unspecified Union item comment case case readonlyl stereotype type iname daetault declaration multiplicity or a b comment case cage readoniyl stereotype e type multiplicity iname A probably a number Enumeration item f namae f comment default declaratian doakan PNIS get s name also in uml vim finem jj T iis n default definition erator aat Locmment ifioneveyifitypel Finameltitifitifiratisesnilf raises Aera or The tab Description allows to set a default description GenerationSettings dialog 5 Attribute default description Drawing The attributes are only drawn with their class in a class diagram here the drawing language is UML the full member definitions and the visibility are shown 94 of 357 07 10 2007 16 00 95 of 35
314. nt to produce the UML C or Java definitions gxmi S rrr eme O browse XI file PPP EISE Encading windows 1252 Generate views as package Tagged values generation C Not generated lt UML Tagged alue tags value _ gt C ahil Tagged alie Liml Tagged V alue tag gt lt Uml Tagged value tags lt m Tagged value value Um Tagged v alue value JhML Tagged alue gt Currently only the UML definition of the packages views generated as package or not generated depending on the toggle above classes attributes relations operations use cases components without UML2 0 features and nodes are saved in the produced file Classes defined under a use case or a use case view are generated as actor their operations attributes and relations are not generated except dependencies and generalizations The XMI generator manages the following options in order e uml or C or java to specify the target language mandatory if other arguments are given except the port number given by Bouml itself generated XMI file path must not contains space encoding for instance windows 1252 view optional to generate views as package simpleTv to generate tagged values with the simple form complexTv to generate tagged values with the complex form else the tagged values are not generated In case these arguments are given the dialog doesn t appears this allows to export a project in XMI without any manua
315. o end the edition boum Ses This note s under edition A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu 269 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html upper lower enit fart i edit drawing settings select linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu font remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not writt
316. o end the edition i boumi Sesa A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu upper lower edit font b edit drawing settings select linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified 232 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html A right mouse click on a text show the following menu fant remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left
317. o show modify the class properties In case the class is read only the fields of the dialog are also read only Note th consistency purpose you cannot edit a class while any other edition is made and while a class is edited all the other editions impossible Class dialog tab Uml The tab Uml is a global tab independent of the language Class dialog fj a E Url Parametrized C Java Php IDL Properties name uriciass Stereotype 1 C public protected C private package artifact UmiClass AP USER description This class manages classes notes that the class Classitem is amather class of the class s children Editor Defautt You can modify it as you want except the constructor constraint Editor The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is 47 of 357 07 10 2007 16 00 48 of 357 file C uml BOUML bouml 3 0 doc TOUT html possible to choose into the list or to give a new one or to empty it abstract allows to declare that the class 1s an abstract class not instanciable The artifact used to produce the class source code must be chosen in the proposed list or the field may be empty Obviously a nested class can have an associated artifact but a nested class has a visibility The description will be generated in the class source code in case the comment or d
318. o stay in it A right mouse click on a package in a diagram calls the following menu upper lower eit edit drawing settings select in browser set associated diagram remove from view delete from model tool L The drawing settings concerns only the picture for which the menu is called 07 10 2007 16 00 29 of 357 file C uml BOUML bouml_3 0 doc TOUT html Diagram Drawiil mw Diagram Drawi sssi ak Sept cic diagram color Package color defaut 1 name In tab default show context default 1 associated diagram allows to automatically open the current diagram when a double mouse click is made on the package representation in a diagram or the browser After that the only way to edit the package is to choose the edit entry in the menu Previous browser items Next use case views 07 10 2007 16 00 30 of 357 Use case view file C uml BOUML bouml_3 0 doc TOUT html A use case view may contain other use case views use cases actors classes class instances activities state machines use case Menus diagrams object diagrams sequence diagrams and collaboration diagrams in any order B Fause Case View House case gt actors AnActor H Ackass Eiadassinstance Aass C o emarchingss State Machine _ Bactivity E3 Sequence Diagram Filcottaboration Diagram TijOhiect Diagram 1 s Sub Use Case View The menu appearing with a
319. ode reverse loses them generating a warning except the ones declared friend in a class The C code reverse works in two steps during the first step it scans all the files to establish the list of defined types then the second step may reverse the files The first phase try to replace the missing include management but it is not enough because the files whose are not under the selected directory for instance the standard headers files are never taken into account and the synonym types are confusing When the C code reverse has a problem for instance when it reads a C function definition it produces a warning in the trace window The trace wii automatically opened by BOUML it may also be manually opened through the Tools menu To do simple substitution on the read files edit the package where the C reverse will be started perhaps the project itself to add a user property through the tab User with the key file and the value must be the absolute pathname of a file Each line of the specified file must contain e just an identifier in this case this identifier will be ignored during reverse This is like define identifier ea form identifier value in this case the identifier will replaced by the value during reverse The value must a token for instance an other identifier float a string etc This is like Zdefine identifier value Warning the lines must not contains spaces or tabs Previous C generator
320. of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Previous use case diagram Next collaboration diagram 222 01 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Collaboration diagram key down 1 keyDawnt The collaboration diagrams may be placed in a use case view a use case or a class view cause Case View FalCollaboration Diagram E cC lJse Case FaCollaboration Diagram EgClass view FilCollaboration Diagram A collaboration diagram is created through the new collaboration diagram entry of the use case view use case and class view browser menus Browser menu The node menu appearing with a right mouse click on its representation in the browser is something like these supposing the diagram not read only nor deleted show edit edit drawing settings duplicate delete mark tool Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only collaboration diagram dialog tab Uml 223 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Collaboration diagram dialog Umi User name vie down Stereotype 1 description Editar cen The proposed stereotypes are the default one specified through the D
321. of the dialog are also read only Activity diagram dialog tab Uml 262 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity diagram dialog lt T Um Properties name Diagram Stereotype 1 description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level a Diagram Drawing Settings dialo
322. oject control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c is a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items When several diagram s elements are selected the menu appearing on a left mouse click allows to align them 286 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Multiple selection menu select linked items IE align top copy selected Ctri c Qo align bottom cut selected Ctri x remove from view IE align left remove selected fram view Suppr a align right delete selected Contral d align center F align center verticaly H amp align center horzontaly Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu E dit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may c
323. ole or in part contains or is derived from the Program or any part thereof to be licensed as a whole at no charge to all third parties under the terms of this License c If the modified program normally reads commands interactively when run you must cause it when started running for su interactive use in the most ordinary way to print or display an announcement including an appropriate copyright notice and a notic that there is no warranty or else saying that you provide a warranty and that users may redistribute the program under the conditions and telling the user how to view a copy of this License Exception if the Program itself is interactive but does no normally print such an announcement your work based on the Program is not required to print an announcement These requirements apply to the modified work as a whole If identifiable sections of that work are not derived from the Program and can be reasonably considered independent and separate works in themselves then this License and its terms do not apply to those sections when you distribute them as separate works But when you distribute the same sections as part of a whole which is work based on the Program the distribution of the whole must be on the terms of this License whose permissions for other licei extend to the entire whole and thus to each and every part regardless of who wrote it Thus it is not the intent of this section to claim rights or contest your rights to wo
324. ome bruno uml pripr pr home bruno uml singletorvsingletan prj Ampilarb nr Ahome bruno uml rase rose prj Ahame bruno uml genpra gennra pr itmp es es nr homebruno umi emptyempty pr Amp b Atmp em em pr Previous bouml Next top level menus 5 of 357 07 10 2007 16 00 6 of 357 Top level menus The menus accessible from the BOUML s window are Project menu New Create from Template GR Open Save as Close Quit Edit E Ihame brunc uml pr pr prj ihame bruno uml E X organ organ nrj hame bruno uml E art art nrj Ihome bruno uml E x du du pr Ihome brunc uml ntml html prj Ihome bruno uml E relz relz pr Ihame bruno uml E attr2 attrz0 nrj Ahome bruno umilsmizhemig pr Hmp gs g 4 nr Atmp em5 ems5 pr The file C uml BOUML bouml 3 0 doc TOUT html Project menu allows to create a new project load a project save it in place or in a new location print the current diagram close the project or quit bouml The bottom of the menu contains the historic the upper line correspond to last opened project for instance the curre one When you try to close a modified project perhaps to load an other one BOUML ask for a saving If the environment variable BOUML TEMPLATE is defined you can create a project from the one specified by this variable The goal is to get the settings from this project rather than to get the default settings I decide to set This variable must value the absolute pa
325. on will be taken into account by BOUML If there are several images of the project after the use of File Control each image must be updated or you must set the same write access using the tool by yourself All the operations are presented to be done for a given user this user is indicated at the bottom of the window Obviously the user first the one starting the tool the id is the value of BOUML ID for this user Project menu This menu allows 339 of 357 Project control Project Style Help Change user H Search Ctrl s Quit ihomebruno uml pr pr pr Ihame bruno uml htmi html nrj iheme bruno uml E activibyractivity pr 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e to load project may be through the historic list proposed at the bottom this historic is the one of BOUML for the user starting Project Control e to change the current user e to search for a package from its name e or to quit the tool Browser When you load a project only the packages are shown in the browser for example on the project doing the HTML generation if the project package is protected the API USER owned by bruno and Aux by olivier eo oe Project control lt 3 ds Style Help B an lt protected gt BBAPIBASE 1 API USER 2 brung 1 B3Aux 3 olivier 1 User is bruno id 2 dil The icon used to represent a package indicates the write access e B the package is not protected and may be mod
326. ontain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window to end the edition i boumi assis is under edition A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu upper lower enit fart b edit drawing settings select linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text 287 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu Upper lower edit fart remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quic
327. ool Menu edit To edit the relation Menu select labels To select the labels relation s name stereotypes role s and multiplicity ies associated to the relation Useful when you are lost after many label movings 78 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Menu labels default position To place the labels relation s name stereotypes role s and multiplicity ies associated to the relation in the default position Useful when you are lost after many label movings By default when you move a class or a relation point break or edit the relation the associated labels are moved to their default position this may be irritating To ask BOUML to not move the associated labels on the relations in a diagram use the drawing settings of the diagrams Menu geometry Allows to choose one of the line geometry or to recenter a decentered line Z None Note if you manually move the central line of the last two geometries this one stop to be automatically updated when you move ont of the two extremities of the relation Menu tools Appears only when at least one plug out is associated to the relation To apply a plug out on the relation Drawing settings The drawing settings associated to the relations in a diagram may be set through the the diagram itself or one of its parent for instance a Diagram Drawing Settings dialo diagram color Gasing agua Cates cen anie mue C
328. oposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The mode and the flag must isolate are the standard UML information The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu duplicate The menu entry duplicate clone the region without its children Menu set it nested in the region above The menu entry set it nested in the region above is present when the previous element in the browser is a region allows to move the region inside Menu extract it from current parent region The menu entry extract it from current parent region is present when the region is nested in an other one allows to extract the region and place it in its grand parent Menu mark See mark Menu delete The menu entry delete is only present when the region is not read only D
329. or BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level a Diagram Drawing Setting ass drawing language default default note color default Instances drawing mode default default class instance default COM show operations full definitian yes default duration color default write name type horizontally default 1 default continuation color default draw all relations default 1 draw shadow defaut 1 default fragment color default Cancel Cancel e drawing language to indicate in which language the operations must be written when the full definitio
330. ore details Menu tools The menu entry tool is only present in case at least a plug out may be applied on the project package Drawing When a package is drawn in a diagram the available options are e package name in tab to indicate if the package s name must be written in the tab which is the small rectangle on the top e show classes and packages context to indicate if the context where the package is defined must be written it is not the case just above The context may be t UML context which is the path of the package in the browser choice followed for awt below or the C namespace specified by the package or the Java package specified by the package choice followed for picture below or at least the Idl awt module java laut image javg awtimage e package color when you create a new project the packages are transparent by default In all the diagrams a package may be resized When you move a package in a diagram the artifacts classes components deployment nodes sub packages and use cases defined in the package not through an other one and in collision with the package at the beginning of the move are also moved If you want also move the connected elements do a very short move for instance use the keyboard arrows to do a move and its opposite then ask for select linked items and restart the move Note contrarilly to the states when you resize a package the sub elements are not moved t
331. otation change the generation settings to remove this macro Th forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Menu duplicate The menu entry duplicate clone the operation Menu delete The menu entry delete is only present when the operation is not read only Delete the operation and all its representation in the diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved 104 of 357 07 10 2007 16 00 Menu mark See mark Menu tools Appears only when at least one plug out is associated to the operations To apply a plug out on the operation Generation settings file C uml BOUML bouml_3 0 doc TOUT html This very important dialog allows to specify many default definitions concerning the operations more details will be given in C generator Java generator Php generator and Idl generator The first tab allows to specify how the types not supported by an UML class are translated in each language except Php and the default C argument passing for these types depending on the direction more the default type form to return value GenerationSettings dialog 2 Types Stereotypes 1 C 2 C 3 C 4 CHS Java 1 Javaj Java 3 Idi 1 Idif2 Types correspondence and C operation argum
332. ough the Uml and Java tabs of the relation dialog The indentation of the first line of the definition give the indentation added to the class definition for all the relation definition Relation equivalent to an attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Java code generator are e comment is replaced by the description of the attribute adding e description is replaced by the attribute description without adding e visibility produce the visibility see the UML tab e static produce static when the attribute is a class attribute see the UML tab e final produce final when the attribute is final e transient produce transient when the attribute is transient e volatile produce volatile when the operation is volatile e type is replaced by the name of the class pointed by the relation see the UML tab e name is replaced by the role s name see the UML tab e value is replaced by the initial value of the relation see the UML tab e stereotype is replaced by the translation in Java of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab must be used in case the multiplicity is a vector or dimensioning and are added when they are not present e association is replaced by the association class see UML tab e Ofxyz is replaced by the user pro
333. out directly written in C Java catalog is a very practical tool allowing you to import classes into BOUML An imported class comes in BOUML without the body operations and without its private members the goal is to import Java library classes in the model not to generate them Java catalog may also be used to browser through the Java packages search information about a given class etc without sending them t BOUML To work Java catalog need Java sources this must not be a problem these ones are generally available even for your preferred JDK version The Java catalog plug out may be applied only on a package it is used through a window The upper part is a browser like in BOUML except that only the package and classes are showed The lower part reduced when Java catalog starts shows the description of the selected class interpreting the html forms The top level package in the browser part here p is the name of the package in BOUML in which Java catalog is applied To make a catalog use the scan entry of the file menu or the button representing a microscope Java catalog will ask for a directory and scan all the Java files in this one and its sub directories For instance if src contains all the Java sources i k y ha Eile eee Style Help ud GO 3 cb M Ip eB isre amp cam ljava amp javax launcher jorg El sunw interfazes classes deprecated his is a compatibility type to allow Ja
334. ove the selected element s from the diagram these elements are not deleted control c 1s a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them Multiple selection menu select linked items IE align top copy selected Ctri c g align bottom cut selected Cries remove from view E align left remove selected fram view Suppr align right delete selected Contral d 0 align center F align center verticaly H8 align center horizontaly If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally 258 of 357 07 10 2007 16 00 Multiple selection menu Select linked items Align Copy selected Ctri c Cut selected Ctriex remove from view Remove selected from view Suppr Delete selected Control dq EC drawing setting and for instance when the elements are classes in a class diagram The settings drawing language unchanged drawing mode
335. ovidedirealized classes User stereotype fitering Available classes Required classes Account Orderableltem e Person When a component C contains nested components it is useless to repeat the list of required interfaces at the level of C already defined by the sub components the right list will be provided when you will add or Component dialog tab Provided Realized classes This tab allows to specify the list of interface the component realized but hide or provide Stereotype fitering Available classes Provided classes Account OrderEntry 2 e Realized classes xj A class may be provided or realized by only one component When a component C contains nested components it is impossible to repeat the list of provided realized interfaces at the level c already defined by the sub components the right list will be provided when you will add or Menu set it nested in X The menu entry set it nested in X is present when the component follow the component X in the browser Choosing this entry the current component became a sub component of X Menu extract it from X The menu entry extract it from X is present when the component is nested in X perhaps X is itself nested in another one but it is not visible here Choosing this entry the current component became a children of the parent of X Menu delete The menu entry delete is only present when the component artifact is not read only De
336. ows you to remove a parameter etc e f raise is replaced by the form raise when at least an exception is defined in the UML tab e f raisenl produce a line break when the operation have exception In case you do not like this notation change the generation settings to remove this macro e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the operation if not found for the class containing the operation etc Attribute The Idl definition of an attribute is set through the Uml and Idl tabs of the attribute dialog The indentation of the first line of the definition give the indentation added to the class definition for all the attribute definition The definition of an attribute depend on the stereotype of its class interface s attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Id code generator are e comment is replaced by the description of the attribute adding e description is replaced by the attribute description without adding e readonly produce readonly when the attribute is read only see the UML tab e attribute produce attribute e type is replaced by the type of the attribute see the UML tab e stereotype is replaced by the translation in Idl of the relation s stereotype see the UML tab 313 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0
337. pdate already defined classes having at least one member Furthermore the preprocessing phase is not made by the C code reverse whose ignore all the preprocessor forms but some substitutions may be asked see at the end of this chapter The C code reverse plug out may be applied only on packages When you start the C code reverse it asks you for directories enter the directories then choose cancel to start the reverse then it reads all the sources placed under the selected directories and sub directories The sources read by the C code reverse are the ones having the extension specified in the generation settings The tree formed by the directories and sub directories produce an equivalent tree of sub packages on whose the needed class view and artifact view are made to support the classes and artifacts When a type is referenced but not defined in the reverse files a class having the same name is defined under an additional package named unknown Obviously the C code reverse tries to produce the definitions made in BOUML at the artifact class operation relation attribute levels When it is possible it creates a relation rather than an attribute Except for the special case of the templates class definition like vector lt bool gt a artifact is created for each type definition then a future C code generation may not produce a list of files similar to the reversed ones A C function cannot be specified in UML the C c
338. perations defined on the message receiver more the current one but you may also give any o message It is possible to change the synchronous asynchronous state It is also possible to specify explicitly the message operation arguments is possible to give then on several lines obviously in this case BOUML produce the appropriate indent message jop2 inout pi int Inout pz float Message ype aaa IT L synchronous E asynchronous When the arguments are specified they replace the operation s parameters without any check arguments ok Cancel The edition of an explicit return allows to indicate the returned value Message Menu edit drawing settings This dialog allows to specify how the operation message must be drawn you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level default show full operation definition defaut 1 oen see operation drawing language and show full operation definition Message Menu select linked items 215 0f 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Select linked items select all the items connected this the current one through any line Message Menu select label Select the label given the associated message operation Message Menu label default position Move the label given the asso
339. perty are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Refer to the generation settings and Php generator for more details and explanation of the other keywords 87 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Attribute dialog tab Idl This tab allows to give the Idl definition of the attribute it is visible only when Idl is set through the menu Languages For a standard attribute here of a valuetype Attribute dialog lt 3 mp rere Um C Java itd user icomment readonly S5 attribut type namel Declaration the name of the stop if Reeds are trumpet cromorne ff Flutes are bourdcn rhorflote Result after Principal are montre praestant ff Strings are viola unda maris substitution if Mutation are nazard thierce if Compound are mixture cornet attribute string name i Default Attribute declaratian Default State declaration Mot generated in Idi For an enumeration s item Enum item dialog S iss b ilas Lim ce Java idi user name comment Declaratinn Compound have more than one pipe souding per note Default declaration Mot generated in lel In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you
340. perty if searched first for the operation if not found for the class containing the operation etc eA template operation is defined with an empty declaration allowing Bouml to detect this case and placing the actuals between class and in the declaration part If the toggle preserve operations s body is set through the Languages menu the generators do not modify the body of the operations protected by dedicated delimiters This means that for them the body definition set through BOUML is not used The first time 292 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html generate the code with the toggle set because the delimiters are not yet present in the generated code the operation s body will updated depending on their definition under BOUML After while the toggle is set and the delimiters present the bodies will r change allowing you to modify them out of BOUML Notes e n case the file containing a body definition is not consistent with the artifact under BOUML the body will be regenerated by the code generation using its definition under the model Of course an operations becoming inline or stopping to be inline is not a problem e When you import a project the body of the imported operations must be the right one in the imported model The preservi bodies of the imported operations will not be find because the identifier of an operation used to mark its body changes during the import e The bodie
341. perty value in case xyz is the key of this property The property if searched first for the relation if not found for the class containing the relation etc Inheritance The class inheritance are managed at the class level e type is replaced by the name of the inherited class more the actuals if the generated class instantiate a generic Extra member The Java definition of an extra member is set through the Java tabs of the extra member dialog No macros Previous C reverse Next Java reverse 301 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Java reverse The Java code reverse is a plug out directly written in C Note that the Java code reverse cannot be used as a Java code round trip and doesn t allows to update already defined classes having at least one member The Java code reverse plug out may be applied only on a package When you start the Java code reverse it asks you for java catalog files use cancel to finish to give the catalogs may be immediately then it ask for a directory then it reads all the sources placed under the selected directory and sub directories The sources read by the Java code reverse are the ones having the extension specified in the generation settings The tree formed by the sub directories produce an equivalent tree of sub packages on whose the needed class view and deployment view are made to support the classes and artifacts When a type is refe
342. pgrade plug out To start a plug out when Bouml is launch It is possible to apply a plug out on the project when Bouml is started through your shell or command line bouml project file exec plug out plug out options exit e project file indicates the model to load as usual e plug out indicates the plug out to apply on the project The C generator is named cpp generator the Java generator java generator the Php generator php generator the Idl generator id generator the HTML generator ghtml the XMI generator gxmi and gxmi2 If necessary the full path of the plug out have to be done warning under Windows this path must not contain space e plug out options are the optional options you give to the plug out e exit is optional and allows to exit from Bouml when the plug out execution is done For instance HTML generator options are given here XMI generator options are given here e C Program Files Bouml boum1 D aze aze prj exec C Progra 1 Bouml gxmi uml c aze xmi windows 1252 exit e bouml qsd qsd prj exec flat usr lib bouml ghtml tmp qsd html del html exit Exchanges with BOUML The exchanges between BOUML and the plug outs are supported by a TCP IP socket When you ask BOUML to start a plug out it search for a free port number starting at 1024 In case you have a firewall it may be necessary to configure it To reduce the number of exchanges with BOUML and run faster a
343. plug out does not ask for BOUML each time you want to get a value The system classes read and memorize all the data of a given item the first time you access to one of them with the restrictions allowed WITHCPP WITHJAVA WITHPHP and WITHIDL This is transparent for you until two plug outs access to the same data when one plug out modify a value already read by the other the second plug out does not see the new value until it unload an operation defined on UmlBaseltem the object then ask for the value User properties A user property is a couple key value the value may be empty By default the user properties are not used nevertheless they exist It is the only way to add information concerning any item without modifying BOUML 335 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html obviously they are accessible in the plug outs The alone limitation is that the keys and the values must contain string may be on several lines even the editor called by the dialogs is not a multi lines editor The plug out genpro use the properties of the artifact on which it is applied to save its data and give them is a future usage supposing the project saved To see modify them select the last tab named User present in the dialog of any kind of item Compile a Java plug out To compile the java files go in the directory where the files are and do javac java don t compile file by file because some files
344. r When you push the button Default definition the form specified through the generation settings is proposed adding all the operation parameters given in the UML tab These forms may be modified as you want even to produce illegal source code When you do not want to have this operation defined in Java empties the definition manually or using the button not generated in Java visibility produce the visibility see the UML tab final produce an empty string when the check box final is not checked else produce final static produce an empty string when the operation is not a class operation see the UML tab else produce static abstract produce abstract when the operation is abstract see the UML tab else an empty string 101 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html synchronized produce an empty string when the check box synchronized is not checked else produce synchronized type is replaced by the value type see the UML tab name is replaced by the name of the operation and produce and but there are also a mark for BOUML to find the parameters list t n and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter add type modifiers etc throws is replaced by the form throw when at least an exception is defined in the UML tab It is also possible to produce throw when there is no exc
345. r The stereotype of a deployment view doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu edit drawing settings 40 of 357 07 10 2007 16 00 41 of 357 file C uml BOUML bouml_3 0 doc TOUT html i Diagram Drawing Settings dii seks deployment colar deployment catod show packages name in tab default default node colar defaull show packages context default E write node instances horizontally default default artifact calor default automatic labels position default default component color default draw shadow default default note color default 1 draw component as ican default default package color default 1 show rampons required Jeau and provided interfaces default fragment color default 1 show components realizations defaut 1 OK Cancel Cancel This
346. r until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on a parameter set The selected tool is called and applied on the current set Default stereotypes The dialog allowing to set the default stereotypes 164 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html activity action stereotypes usa Mim ree Sher eet ots pin stereotypes paren node stevtc pes Activity action drawing Depending on its stereotype a activity action is drawn in a diagram as a rectangle a convex pentagon or a concave pentagon accept event timer 2x7 action Requested Order m target call behavior m au param action in param E By default the name of an action is its kind this one is written inside the action except if the action is an opaque action and you ask to see the code result value insertAt add variable read variable value action value action request target J send object a action If the action has pre and or post condition these ones are show except if you ask to not show the conditions A right mouse click on a activity action in a diagram calls the following menu supposing the activity action editable 165 of 357 07 10 2007 16 00 ado pin upper lower edit drawing settings edit activity action select In browser select l
347. r the relation between use cases and actors classes I propose also an arrow because I prefe representation Drawing A use case is drawn in a diagram with a sizable ellipse the available options are e use case color e automatic label position this concerns the relation s labels by default BOUML automatically move the labels associated to a relation accordingly to its extremities If you do not like how BOUML place the labels set this option to false and you will be the master note that the labels default position entry of the relation s menus in the diagrams remains available to help you when you are lost A right mouse click on a use case in a diagram calls the following menu upper lower edit edit drawing settings select in browser select linked items set associated diagram remove from view delete from model tool The drawing settings concerns only the picture for which the menu is called select linked items select all the items connected with the current one through any line set associated diagram allows to automatically open the current diagram when a double mouse click is made on the use case representation in a diagram or the browser After that the only way to edit the use case is to choose the edit entry in the menu Previous deployment view Next class 45 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Class A class may contain nested classes relations attribut
348. r to the button H change the size of the windows to see all the diagram s elements with the current scale Picture Menu copy optimal picture part Copy all the diagram elements equivalent to a optimal windows size followed by a copy visible picture part then a restore of the original windows size Picture Menu copy visible part 245 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and pref
349. rade Next Use case wizard 327 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Use case wizard A very simple plug out defined in C and Java both like the HTML code generator to extend use case features When it is applied to a use case it allows to specify through text a summary context pre conditions description port conditions and exception Properties of the use case key down amp immu Summary Context Pre Conditions Description Post Canditians Exceptions The summary of the use case key down Don t hesitate to modify this plug out saving it output of the Bouml installation directory to not loose your modifications on a f Bouml installation for your own purposes Previous C utilities Next File control 328 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html File control A very simple plug out defined in C to control the project files with CVS Subversion Clear Case or other file controller doing the check in out on the appropriate files This plug out asks for the command to be made on each file The command is executed through the function system don t forget t give the option nc for Clear Case Of course in case you don t use a file control you may use this plug out to set the file permissi using chmod in the commands under Linux etc The first parameter of the plug out must be ci or co to know what must be done this
350. ragment color default default subject color default default duration color default default continuation color default This dialog allows to specify how the sub diagrams must be drawn by default Refer to drawing for the settings concerning the use cases Menu delete The delete entry is only present when the use case is not read only Delete the use case and all its children and all the representation of them in the opened diagrams After that it is possible to undel them from the browser until you close the project obviously the deleted items are not saved Menu referenced by To know who reference the use case through a dependency or an inheritance show a dialog for instance Referenced By dialog 2 i eh nie 4 on swell iS relerenced by lt generalization gt external eventszkey down coe Menu mark See mark Menu tools The menu entry tool is only present in case at least a plug out may be applied on the use case The selected tool is called and applied on the current use case Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the use cases 44 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog mein mme Package Class UseCase Artifact Views Diagrams Others USE case mo c stereotypes relations stereotypes UML propose a simple line fo
351. ration is underlined an abstract one is written in italic It is possible to move an operation from a class into an other except for the get and set operations associated to a relation or an attribute gEgc gvoper assOper we abstractOper Menus The operation menu appearing with a right mouse click on its representation in the browser is something like these supposing it is not read only nor deleted edit duplicate delete mark tool Menu edit 96 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html edit allows to show modify the operation properties including the body In case the operation is read only the fields of the dialog read only Operation dialog tab Uml The tab Uml is a global tab independent of the language a Operation dialog Wml c Java Php Properties class LimlOperation AP USER name html Stereotype i value type vold pubie protected C private C package l class operation I abstract parameters exceptions entry to produce the html code receiving chapter number description path rank in the mother and level in the browser tree Editar Default constraint Editor The name may contains spaces to define C operator for instance and a class may have several operations having the same name A constructor have the name of its class The proposed type for the value type et
352. re than one pipe souding per note Result after substitutian Default declaration Not generated in Php coe In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for Php supposing you do not modify the Php code generator When you push the button default declaration the form specified through the generation settings depending on the stereotype and multiplicity and of course the language is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this relation defined in Php empties the declaration manually or using the button not generated in Php It is possible to follow the visibility as it is set in the UML Tab or to change it replacing visibility by the desired one to not generate the visibility set it to package static produce an empty string when the relation is not an class relation see the UML tab else produce static const produce an empty string when the relation is not read only see the UML tab else produce const var produce var when the relation is not read only nor static see the UML tab and the visibility is not package else produce an empty string name is replaced by the relation s role name see the UML tab value is replaced by the initial value of the relation see the UML tab The forms pro
353. re the package is defined must be written it is not the case just above The context may be t UML context which is the path of the package in the browser choice followed for awt below or the C namespace specified by the package or the Java package specified by the package choice followed for picture below or at least the Idl module Java ew OoOo image jave awtinage Browser Menu duplicate Clone the diagram in a new one Browser Menu delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram 225 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only Collaboration diagram menu Edit all the messages Edit drawing settings select diagram in browser Select all Ctri a Optimal e l Optimal window size Copy optimal picture part Copy visible picture part save optimal picture part png Save visible pictur
354. renced but not defined in the reverse files a class having the same name is defined under an additional package named unknown Obviously the Java code reverse tries to produce the definitions made in BOUML at the artifact class operation relation attribute levels When it is possible it creates a relation rather than an attribute A artifact is created for each type definition then a future Java code generation may not produce a list of files similar to the reversed ones The Java code reverse works in two steps during the first step it scans all the files to establish the list of defined types then the second step may reverse the files When the Java code reverse has a problem for instance on a syntax error it produces a warning in the trace window The trace window is automatically opened by BOUML it may also be manually opened through the Tools menu When the reverse is done the number of reversed classes operations attributes and relations is written for instance in case I reverse a full JDK Java distribution Boum tmp vide vide prj Project Windows Tools Miscellaneous Help Java reverse done 12878 classes 38534 attributes 306583 relatians 112870 operations B unknown See also Java catalog Previous Java generator Next Java catalog 302 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Java catalog Java Catalog is a plug
355. right mouse click on a use case view in the browser is something like this supposing it is not read only nor deleted Menu edit edit allows to show modify the use case view properties with the following dialog The pame external events New use case diagram New sequence diagram New collaboration diagram New object diagram New use case New actor New class New class Instance New state machine New activity New sub use case view Edit Edit drawing settings Dalete Ivtark Tool mx o 5L1 L Use case view dialog E Umi User externa events Stereotype 1 Group all the use cases associated with the external events description Editar j The stereotype of a use case view doesn t have a special meaning for BOUML editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu edit dra
356. ription in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support The default button visible above associated to the description allows to set the description with a default contain specified through the generation settings Useful to generate comments compatible Java Doc or Doxygen for instance Artifact dialog tab C header This tab is only available for the source artifacts and allows to give the definition of the C header file generated for the artifact it is visible only if C is set through the menu Languages artifact dialog lt gt ic ih ere C source Java source di source Associated classes tifndef lNAME H define gt NAME _H comment Header fle f lincludes definition declarations namespace end Hendif Editor Default definition Not generated in C ifndef UMLARTIFACT H RBdefine UMLARTIFACT H TPinclude a needed fiie h produced by the C generator l sas a referenced class produced by the C generator This elass manag
357. rk written entirely by you rather the intent is to exercise the right to control the distribution of derivative or collective works based on the Program In addition mere aggregation of another work not based on the Program with the Program or with a work based on the Program on 353 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html a volume of a storage or distribution medium does not bring the other work under the scope of this License 3 You may copy and distribute the Program or a work based on it under Section 2 in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following a Accompany it with the complete corresponding machine readable source code which must be distributed under the terms o Sections 1 and 2 above on a medium customarily used for software interchange or b Accompany it with a written offer valid for at least three years to give any third party for a charge no more than your co physically performing source distribution a complete machine readable copy of the corresponding source code to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange or c Accompany it with the information you received as to the offer to distribute corresponding source code This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executa
358. ro e body is replaced by the body of the operation this macro may also be replaced by the body itself BOUML use this way for the get and set operations associated to a relation attribute The usage of body has a great advantage when you hit Default definition the body is not cleared At least BOUML share the definition forms of the operations and other objects to minimize the needed memory size body help for this The indentation of the keyword body is added at the beginning of each line xyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the operation if not found for the class containing the operation etc If the toggle preserve operations s body is set through the Languages menu the generators do not modify the body of the operations protected by dedicated delimiters This means that for them body definition set through BOUML is not used The first time you generate the code with the toggle set because the delimiters are not yet present in the generated code the operation s body will be updated depending on their definition BOUML After while the toggle is set and the delimiters present the bodies will not change allowing you to modify them ou of BOUML Notes e n case the file containing a body definition is not consistent with the artifact under BOUML the body will be regenerated by the code generation using its definition under the mode
359. rt then a restore of the original windows size Picture Menu copy visible picture part Put the visible part of the current diagram in the clipboard copy it is a screen copy the current scale have impact on the picture quality It is also possible to print all not only the visible part the current diagram on printer or a file through the button Picture Menu save optimal picture part To save all the diagram elements in a file equivalent to a optimal windows size followed by a save visible picture part then a restore of the original windows size Picture Menu save visible picture part To save the visible part of the current diagram in a file it is a screen copy the current scale have impact on the picture quality 237 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Picture Menu set preferred size and scale To memorize the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 forma
360. rtcuts Note that sometimes changing the size of the base font does nothing because the desired font is not available I had introduced t feature mainly because the default size under Linux and Windows is not the same this may change the relative position of the objects and a relation drawn vertically with one font will be inclined with an other Nevertheless because the fonts under Linux and Windows are not strictly the same a diagram can t have the same aspect under the two operating systems This size is memorized in the file memorizing the project but BOUML allows to change the font size even when the file is read only the new font size can t be saved Shortcut edition When you select Edit shortcuts a dialog appears i Shortcut dialog 2 epo ey select all Copy Delete Move down Arrow geametry Move left Redo hienu Move right Save Remave fram view Undo Move up Paste Cut Redo Unda 8 of 357 07 10 2007 16 00 9 of 357 file C uml BOUML bouml_3 0 doc TOUT html A shortcut is a key and the optional modifiers shift control and alt Under MacOS X control is replaced by the apple ab and alt is named option on the old keyboards This first tab allows to define shortcuts to apply a command on the selected element s The available commands are proposed oi mouse click in the column command their correspond to the menu entries In the previous picture you see the default shortcuts The second tab allows to de
361. rty if it is defined for the class or at an upper level else it is not substituted Artifact dialog tab C source This tab is only available for the source artifacts and allows to give the definition of the C source file generated for the artifact it is visible only if C is set through the menu Languages artifact dialog amp P Pye ml C header C source Java Source di spurce Associated classes Associated artifacts liser source ile tinciude UmlClass h definition inamespace_start members namespace end Editor Default definition Not generated in C include a needed file h produced by the C generator include UmlCom h Result after amp include UmlClass h substitution Uml amp rtifact html1 1 UmlA rtifact sKind l zl When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to generate the C source file for instance the artifact is only associated to an enum empties the declaration manually or using the button not generated in C comment is replaced by the artifact description description is replaced by the artifact description without adding includes if all includes is not used in the header definition it is replaced by the automatically generated Zinclu
362. s component diagram P Stereotypes deployment diagram NEM stereotypes i Drawing active entry Time o ut d play massage litt receiver ITPUOIDEDENEXIDUTU EM f get dial tone i play dial tone dial digit n invalid prvalid de play message caller hangs up Husy disconnect connected Taking calla answer enable speech do play ringing tona abort terminate e abon A state diagram may contain states packages fragment notes texts diagram icons pseudo states and the transitions To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram Warning when you use the buttons to add a state or pseudo state and you click on a state drawing the new state will be nested in the other state In case you place the new state or pseudo state out of any state drawing the new one will be nested in state owning the diagram To add a new relation between states and pseudo states select the appropriate relation through the buttons on the top of the diagran sub window click on the start state or pseudo state with the left mouse button move the mouse each time the mouse button is raised a new line break is introduced at least click on t end state or pseudo state To abort a relation construction press t
363. s substitution sK 1nd 1 meme ref s shtml htmnli write mama d Bs m o Default declaration Not generated in C In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for C supposing you do not modify the C code generator When you push the button default declaration the form specified through the generation settings depending on the class stereotype and of course the language is proposed this last may be modified as you want even to produce illegal source code For instance if you do not want to follow the inheritance specified by the class s relations you just have to replace inherit by anything you want When you do not want to have this class defined in C but it must be defined in Java or Idl so the class must have an associated artifact empties the declaration manually or using the button not generated in C an other way is to empty the C definition of the artifact 07 10 2007 16 00 51 of 357 file C uml BOUML bouml_3 0 doc TOUT html The external check box must be used when the class must not be defined in C by BOUML but you want to specify the name of the class to not follow the Uml Java Idl name and or the included files and or using forms or any other forms needed to use it template produce a template declaration in case the class is a t
364. s dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu duplicate The menu entry duplicate clone the region without its children Menu set it nested in the region above The menu entry set it nested in the region above is present when the previous element in the browser is a region allows to move the region inside Menu extract it from current parent region The menu entry extract it from current parent region is present when the region is nested in an other one allows to extract the region and place it in its grand parent Menu mark See mark Menu delete 143 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html The menu entry delete is only present when the region is not read only Delete the region and all its children and all the representation o
365. s execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu edit drawing settings use case sequence collaboration object show packages name in tab default drawing language defaut show packages context default show operations full definitian defaut 1 automatic labels position eraut write nametype horizontally default draw all relations default draw all relations default 1 draw shadow default draw shadow deraut 1 Cancel Cancel am Diagram Drawing Settings omit bject object c 5 usa case sequence collaboration o SENG ep uem a write nametype horizontally default show operations full definition default show packages name in tab default show hierarchical rank defauit write nametype horizontally default show packages context default ki show packages name Intab default automatic labels position default show packages context default draw all relations default draw all relations default draw shadow defui gt draw shadow default 43 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html default note color default x default use case color default s default package color default default f
366. s has a tab reserved for the artifacts Default stereotypes dialog lt 9 nim pe source library executable stereotypes relations sterentypes deploy manifest 194 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Generation settings This very important dialog allows to specify many default definitions concerning the classes more details will be given in C generator Java generator and Idl generator The first C tab allows to specify the default header and source file definitions it is visible only if C is set through the menu Languages Wifndef Ee Kdefine _ NAME H Header file i declarations default content Inamespace start definition 9 namespace end i5 comment iincludes Inamespace end Source file default content eneratedireversed generatedireversed 3 f y A lepp 1 include without path header file extension l source fle extension force namespace P generate Javadoc prefix generation style comment As you can see it is possible to choose the extension of the header and source files to force the production of the namespace heade and to ask for the Javadoc style comment The are four ways to produce include e without path ask for the C code generator to generate the include without relative or absolute path e with absolute path ask for the C code generator to generate the absolute path of the automat
367. s in the three dialogs above may be relative the directory ies used by the code generators will be the root directory collapsed with the appropriate relative directory This allows to move all the generated files changing only one path When a namespace package module specification is empty the generated code will not be placed in a namespace package module else you have to specify the full 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html namespace package module specification this allows to have a browsers package tree different than the namespaces packages modules imbrication For instance in case the C namespace is mynamespace the generated code will be placed in the namespace mynamespace In case the C namespace is mynamespace subnamespace subsubnamespace the generated code will be placed in the namespace subsubnamespace itself nested in the namespace subnamespace itself nested in the namespace mynamespace In Java the separator is 66 66 o a rather than In Idl the separator is Menu edit default stereotypes This entry is only available in the project s menu Allows to set a default stereotypes list for some kinds of object the dialog associated to the packages is Default stereotypes dialog 45 T ic kac inis Lo facade framework stub toplevel Stereotypes Stereotypes relations stereotypes Jaccess import As you can see it is possible to set a
368. s made by several users The tool Project synchro associated to project control allows you to synchronize a repository project with the modifications made by several users supposing each package modified by at most one user Because of the way the project data are saved by BOUML see project files the write access are managed at package level and each information attached to a package except its sub packages have the write access of this package Recall the generation settings default stereotypes etc are associated to the project package a good way is to not define views directly in the project package but to immediately create sub packages each one owned by a different user or protected Project Control is not a plug out it is launch like BOUML or any tool when you start it the following window appears Project control Project Style Help li 3 wo browser Owner id Owner name Revision Madifed by User is bruno id z dd To avoid inconsistencies you can t apply Project Control several times on a given project and you can t use it on a project while it is edited by BOUML or by Project Synchro if this is the case a message warns you Control project cT The project is already locked by Project contro or Project syneho the directory alllock exists The write access are written inside the project files associated to the packages if all the users access to the same shared image c project the protecti
369. s replaced by the role s name see the UML tab e stereotype is replaced by the translation in Id of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab e case is replaced by the case associated to the relation e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the relation if not found for the class containing the relation etc Inheritance The class inheritance are managed at the class level Extra member The Idl definition of an extra member is set through the Idl tabs of the extra member dialog No macros Previous Php reverse Next Roundtrip body 316 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Roundtrip body This is a plug out directly written in C When you set preserve operations s body through the miscellaneous menu you edit the operation s bodies out of Bouml and this one doesn t contains up to date operation s bodies This plug out updates the operation s bodies in Bouml from the sources Roundtrip body works on the artifact not at class level So when you ask for roundtrip body on an artifact or an upper level all the operations of all the classes having the mark in the sources associated to the artifact will be roundtripped You can ask for roundtrip body at package deployment view or artifact level excep
370. s tab allows to give the Java definition of the relation it is visible only when Java is set through the Languages menu For an association or an aggregation without multiplicity Relation dialog S grin rer we Umil c Java to User ROLE 1 F transient comment 8 visibility l static t final transient volatile type name value Declaration protected C2 theC2 Result after substitutian Default declaration Not generated in Java Edit annotation ROLE l transient f aomment visibility static final transient volat ils type name value Declaration protected C thec Result after substitution Default declaration Not generated in Java ce In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for Java supposing you do not modify the Java code generator When you push the button default declaration the form specified through the generation settings depending on the stereotype and multiplicity and of course the language is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this relation defined in Java empties the declaration manually or using the button not generated in Java It is possible to follow the visibility as it is set in the UML Tab or
371. s under the model are not updated by the code generation a new plug out must be made for that e Only the operations using the keyword body may have a preserved body e The only modification you can do in the lines containing the delimiters is the indent e The toggle is saved in the file associated to the project be sure the save is done when you change this toggle Attribute The C definition of an attribute is set through the Uml and C tabs of the attribute dialog The indentation of the first line of the definition give the indentation added to the visibility specification in the class definition for all the attribute definition except for the pre processor commands beginning by whose are placed at the beginning of the line An attribute may be a standard attribute or the item of an enumeration standard attribute In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the C code generator are e comment is replaced by the description of the attribute adding e description is replaced by the attribute description without adding e static produce static when the attribute is a class attribute see the UML tab e mutable produce mutable when the attribute is mutable e volatile produce volatile when the attribute is volatile e const produce const when the attribute is const see the UML tab e type is replaced by the type of the attribute see th
372. s with BOUML and run faster a plug out does not ask for BOUML each time you want to get a value The system classes read and memorize all the data of a given item the first time you access to one of them with the restricti allowed by WITHCPP WITHJAVA and WITHIDL This is transparent for you until two plug outs access to the same data when one plug out modify a value already read by the other the second plug out does not see the new value until it unload an operation defined on UmlBaseltem the object then ask for the value A class is defined with operations attributes but the C Java Idl generator doesn t generate it The class doesn t have an associated artifact or the class artifact is not defined for the language Note that a de definition set through the generation settings may be done at the creation for each language if you ask for it througl the Languages menu I cannot edit a browser item the edit menu entry or button does not appear you do not have the write permission for the associated files or the item is a system item supporting the plug out API It is also not possible to edit delete a class when an other item is already edited I use a multiple monitor side by side configuration and the dialogs are placed partially on each The environment variable BOUML LIMIT DESKTOP is for you This optional variable allows to specify a sub part of all the desktop its value must be x0 y0 x y without any spaces
373. ser name organ stereotype 1 description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the items of the diagram must be drawn by default you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level i Diagram Drawing REDIERE IT LP diagram calor diagram color i drawing language default classes drawing mode default hide classes attributes default default class color default hide clas
374. ser 2 bruno New name Ok Cancel Choose a user from the list set the name through the line editor when it is unknown for the selected BOUML ID Previous Plug out Next Project synchro 341 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Project synchronization This tool synchronize several images of a project developed in parallel by several users The synchronization is made by replacing old files by new ones Note that the files are copied not merged To use Project synchro several conditions must be followed else the synchronization may broke you projects e To detect a file must be replaced by a new one the tool uses the revision not the date when the file was saved the last ti Because the revision is used it is not possible to use the tool to synchronize projects modified by the releases of BOUML strictly less than 2 21 If you already have several images of a project you must first resynchronize them by yourself to obtain a unique image e Each user has his own copy of the project and works only on this copy Obviously each user has his own BOUML ID e A given project file must be modified by only one user for instance thanks to Project Control This means that when the owner of a file change you must perform a synchronization before obviously it is useless to do a synchronization when a file without owner since the last synchronization become owned by someone e Th
375. ses modify them description Editor E 34 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The stereotype of a class view doesn t have a special meaning for BOUML As you can see the association with a deployment view is made through this menu The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Menu edit class settings Class Settings d s default attributs visibility defaut default relations visibility defaut default operations visibility default coe This setting allows to set a default visibility at the UML level for the attributes relations and operations of the classes defined in the class view default means that the visibility of the upper level is followed which itself may be default etc up to the project level When you create a new class view the visibilities are set to default Menu edit drawing settings u D
376. ses aperatians defaull illt show classes members full definition default show members visibility default default nate calor default show parameter directian default show parameter name default draw all relations default T default package color default 1 show packages name in tab default show classes and packages context default automatic labels position default default fragment color defaut 1 show information note default Dymo draw shadeau default Cancel Cancel e drawing language to indicate in which language the operations must be written when the full definition is showed see below see class drawing in a class diagram e classes drawing mode to draw the class using a rectangle or an icon see drawing mode in a class diagram e hide classes attributes to hide or not the attributes it is also possible to specify the visibility for each one 235 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e hide classes operations to hide or not the operations it is also possible to specify the visibility for each one e show classes member full definition to show all the attributes and operation profile or just their name e draw all classes relations to automatically draw or not the new relations obviously a relation will be added in a diagram only when the start and e classes may be the same are drawn e package name in tab
377. sida Drawing A flow is drawn in a diagram with a line may be with the associated labels flow s name stereotypes the stereotype interrupt 1s specially managed and allows to show a zigzag the weight the guard the selection and transformation depending on the drawing ssettings timeout x weight the weight multicast To add a new flow between elements select the flow through the buttons on the top of the diagram sub window click on the st element with the left mouse button move the mouse each time the mouse button is raised a new line break is introduced at least click on the end element To abort a flow construction press the right mouse button or do a double click with the left mouse button A line may be broken during its construction of after clicking on the line with the left mouse button and moving the mouse with mouse button still pushed To remove a line break a double click on the point with the left mouse button is enough or use the lin break menu of the point using the right mouse button A right mouse click on a flow in a diagram or a double click with left mouse button calls the following menu supposing the f editable 180 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html the name the quard weight the weight select in browser edit drawing settings select labels labels default position attach fow label ta this segment attach stereotype to
378. sociated to the attribute e type is replaced by the type of the attribute see the UML tab e stereotype is replaced by the translation in Idl of the relation s stereotype see the UML tab e multiplicity is replaced by the multiplicity of the relation see the UML tab e name is replaced by the attribute s name see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc enumeration item The macros known by the Idl code generator are e comment is replaced by the description of the item adding e description is replaced by the item description without adding e name is replaced by the item s name see the UML tab e Ofxyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the attribute if not found for the class containing the attribute etc constant The macros known by the Idl code generator are e comment is replaced by the description of the item adding e description is replaced by the item description without adding 314 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html e type is replaced by the type of the attribute see the UML tab e name is replaced by the attribute s name see the UML tab e value is replaced by the initial value of the
379. sses associated to the artifact module_end is replaced by the forms dependent on the module specifications associated to the BOUML package containing the deployment view where the artifact is defined Refer to the generation settings for more details 192 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Artifact dialog tab associated classes This tab is only available for the source artifacts and allows to set the list of classes associated with the artifact The order of associated classes is important because it is followed by the code generators to produce the class definitions artifact dialog lt Umi G header C source Java source idi source Associated classes Associated artifacts User Classes without artifact Associated classes LImi amp rtifact API USER go up go down All the classes without associated artifact are given in the left table above all the classes are associated with an artifact the classes associated with the current artifact and given in the table on the right To move classes from a table to the other one select them a click on the appropriate arrow go up and go down allows to change the order of the associated classes Select the wrong ordered classes and use the appropriate button Art
380. state diagram to create a new state or pseudo state these ones will be a child of the state in the browser Menu edit edit allows to show modify the state properties In case the state is read only the fields of the dialog are also read only State dialog tab Uml 119 of 357 07 10 2007 16 00 120 of 357 file C uml BOUML bouml_3 0 doc TOUT html The tab Umil is a global tab State dialog 5 ITI 4 Umi oct cH Java User name ReadAmount stereotype machine 1 description The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML_EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support State dialog tab Ocl The Ocl tab allows to specify the state behavior using the Ocl language but in fact BOUML doesn t check
381. syntax this is just a convention selection OK Cancel 162 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Menu duplicate The menu entry duplicate clone the pin without its children Menu referenced by To know who reference the current pin through a flow Menu mark See mark Menu delete The menu entry delete is only present when the pin is not read only Delete the pin and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on a pin The selected tool is called and applied on the current pin Parameter set menus The parameter set menu appearing with a right mouse click on its representation in the browser is something like these supposing the set not read only nor deleted see also menu in a diagram Parameter Set edit duplicate Menu edit edit allows to show modify the parameter set properties In case the set is read only the fields of the dialog are also read only Parameter set dialog tab Uml The tab Uml is a global tab ParameterSet dialog a5 abes iios Umil Parameters Properties name Stereotype 1 description Editar The proposed stereotypes are the default one sp
382. t duplicate delete referenced by mark Menu add To add a pin or a parameter set Menu edit edit allows to show modify the action properties In case the action is read only the fields of the dialog are also read only The aspect of the dialog depend on the kind of action Activity opaque action dialog tab Uml The tab Umil is a global tab 150 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Activity Action dialog Umi oct cH Java Properties name Jaction stereotype 1 kind opaque actio 1 description Editor The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it It is possible to change the kind of the action this modify the other editor tabs The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t co
383. t 210 4 x 297 4 all the available formats are e iso A5 592 x 840 e iso A4 840 x 1188 e iso A3 1188 x 1680 e iso A2 1680 x 2376 e iso Al 2376 x 3364 e iso AO 3364 x 4756 e USAA 864x 1116 e USAB 1116x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams 238 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog amp TT jl 4 Package Class UseCase Artfact Views Diagrams Activities Others class diagram EEEMMMM Mgctem stereotypes object diagram PO stereotypes collaboration diagram CO Stereotypes sequence diagram o ooo stereotypes use case diagram INE NK stereotypes state diagram NEM stereotypes activity diagram CO stereotypes component diagram P Stereotypes deployment diagram NEM stereotypes i Drawing organ e amp 281 i6 Fa ed Re A le ait scale 10056 t m H A class diagram may contain classes packages fragment notes texts diagram icons and the relations To place these elements in th
384. t a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window to end the edition boum Ses This note s under edition A right click on the edited note calls a dialog allowing some text manipulations thanks Qt A right mouse click on a note show the following menu 241 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html upper lower enit fart i edit drawing settings select linked items remove from view The font may be changed by default the font is the one used to write the other texts Edit drawing settings allows to change the fill color Select linked items select all the items connected this the current one through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a fext is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu font remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the
385. t in this last case the roundtrip is done recursively Previous Idl generator Next State machine generator 317 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html State machine generator The state machine generator create or update the classes implementing a behavioral state machine on which it is applied Currently the state machine generator only generates C definitions When you apply this plug out on a state machine a class having the same name removing non legal characters is created or updated in case it already exist in the same class view to implement it This class doesn t contain static attributes and may have several instances Each sub state is managed through an own sub class the tree of the states and the associated classes is the same For each trigger whatever the state waiting for it an operation having the same name the C trigger must have a legal C name the C guards must be legal C forms etc is defined Currently the triggers can t have parameters and a transitic can t have several triggers You must apply these operations on the instance of the class implementing the state machine to simulate the event the returned value is true until the final state is reached The operation starting the execution is named create the only legal trigger for a transition from an initial pseudo state A trigger s name can t start by the character allowing me to proc operations and
386. t stereotypes 130 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog LT T TR pseudostate f stereotypes Drawing A pseudo state is drawn in a diagram depending on its kind sbe scale 100 4 n NEUE hGBEoeo sxe0e ptp TIPITIT A right mouse click on a pseudo state in a diagram calls the following menu supposing the pseudo state editable Upper lower edit pseudo state select in browser select linked items remove from view delete from model tool Menu tools Appears only when at least one plug out is associated to the pseudo state kind To apply a plug out on the pseudo state Previous state action Next activity 131 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Activity Activity In the browser an activity is placed in a class view a use case view or a use case and may contain parameters expansion and interruptible activity regions activity nodes activity action object node or control node and activity diagrams amp gClass view EI 3an activity Hlactivity diagram 3g parameter parameter stream parameter exception an interruptible activity region man expansion region an activity action an accept timer event action an accept event action Ban activity object initial a final Sa flow final ra merge Sa decision a fork aa join T
387. t the association s label and stereotype Useful when you are lost after many label movings Only appears when the 284 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html association have a stereotype or a label or both Association Menu default stereotype and label position To place the association s label and stereotype in the default position Only appears when the association have a stereotype or a label or both Useful when you are lost after many label movings By default when you move a class or a relation point break or edit the relation the associated labels are moved to their default position this may be irritating To ask BOUML to not move them automatically in a diagram use the drawing settings of the diagrams Association Menu delete from model Remove the association Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams Default stereotypes dialog 5 E aia m ib class diagram P stereotypes object diagram NEMUS MN stereotypes collaboration diagram TO stereotypes i sequence diagram P Stereotypes use case diagram FP stereotypes state diagram stereotypes activity diagram stereotypes component diagram Stereotypes deployment diagram Stereotypes Drawing a Deployment Diagram 285 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Diagram Faj x jak ga ola
388. t want to have this operation defined in C empties the declaration definition manually or using the button not generated in C It is possible to follow the visibility as it is set in the UML Tab or to change it static produce an empty string when the operation is not an class operation see the UML tab else produce static const produce an empty string when the check box const is not checked else produce const volatile produce an empty string when the check box volatile is not checked else produce volatile friend produce an empty string when the check box friend is not checked else produce friend virtual produce an empty string when the check box virtual is not checked else produce virtual inline produce an empty string when the check box inline is not checked else produce inline type is replaced by the value type see the UML tab abstract produce the string 0 when the operation is abstract see the UML tab else an empty string class is replaced by the name of the class containing the operation staticnl produce a line break when the operation is static else an empty string In case you do not like this notation change the generation settings to remove this macro and produce and but there are also a mark for BOUML to find the parameters list t lt n gt and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter add t
389. tate By definition each state placed in a class view a use case view or a use case is a state machine and a state machine may contains sub machines and states By default at the creation time a state machine is stereotyped machine and a sub machine is stereotypes submachine Note for reasons of simplification the final state is considered to be a pseudo state In the browser a state may contain sub states regions pseudo states transitions actions and state diagrams E machine s AState Machine EI COAState region regin CO esubmachine ASubMMachine 2 state Diagram m I O entry sy z x x PT X z LX receive signal L esend signal s The state s properties will be exposed below Menus The state menu appearing with a right mouse click on its representation in the browser is something like these supposing the state not read only nor deleted see also menu in a diagram new state diagram add submachine add state add region edit duplicate delete referenced by mark tool Menu add tool sele mum new state diagram add nested state add region edit duplicate extract t from ReadAmount delete referenced by mark These entries of the menu allow to add a state diagram a sub state or a region the sub machine will have the stereotype submachine The state diagrams nested in a state are the ones for the state this means that in case you use this
390. ted to a relation attribute The usage of body has a great advantage when you hit Default definition the body is not cleared At least BOUML share the definition forms of the operations and other objects to minimize the needed memory size body help for this The indentation of the keyword body is added at the beginning of each line xyz is replaced by the user property value in case xyz is the key of this property The property if searched first for the operation if not found for the class containing the operation etc If the toggle preserve operations s body is set through the Languages menu the generators do not modify the body of the operations protected by dedicated delimiters This means that for them body definition set through BOUML is not used The first time you generate the code with the toggle set because the delimiters are not yet present in the generated code the operation s body will be updated depending on their definition BOUML After while the toggle is set and the delimiters present the bodies will not change allowing you to modify them ou of BOUML Notes 299 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html In case the file containing a body definition is not consistent with the artifact under BOUML the body will be regenerated by the code generation using its definition under the model e When you import a project the body of the imported operations must be the right one i
391. ted to the condition selection and transformation and also to write or not the activity s conditions e drawing language to indicate which language must be used to write the definitions 263 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Browser Menu duplicate Clone the diagram in a new one Browser Menu delete The delete entry is only present when the diagram is not read only Delete the diagram and all its representation in the opened diagrams After that it is possible to undelete it from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Browser Menu tools The menu entry tool is only present in case at least a plug out may be applied on the diagram The selected tool is called and applied on the current diagram Picture menu The diagram menu appearing with a right mouse click out off any item in the diagram picture is something like these supposin diagram not read only Activity diagram menu Edit drawing settings select diagram in browser Select all Ctri a Optimal scale Optimal window size Copy optimal picture part Copy visible picture part save optimal picture part png Save visible picture part png save optimal picture part svg Save visible picture part svg Set prefered size and scale set preferred scale Size unset Restore oreferred size and scale Unset preferred size and scale Format
392. th a right mouse click on a class instance is something like these supposing the diagram not read only 216 of 357 07 10 2007 16 00 b Cl Upper Lower Edit Become mortal Edit crawing settings Select class in browser T s grt in DOBI Replace it Remove from view Message Menu edit drawing settings Edit drawing settings Select in browser Select class in browser Exit from model Remove from view Delete from model file C uml BOUML bouml 3 0 doc TOUT html This dialog allows to specify how a the class instance must be drawn you may choose default for each value in this case the effective value if specified in the upper level which itself may specify default etc up to the project level drawing mode deraut write nametoe horizontally na 7 Message Menu become mortal immortal h j i 2 a diagram calor Diagram Drawiniss ka class instance color default write class instance horizontally To write the instance type and name on the same line or on two lines By default an instance is immortal its life line is infinite else a X is automatically add under the last activity bar and the life line is finite Note that it is possible to add a new message below the end of the instance life the position of the end of life is updated this is done also when you move resize delete the last activity bar Note that the vertical position o
393. th of a project file extension prj and probably this project is empty In this case when you choose create from template the specified project is load and a save as is automatically done Windows menu Winders Cascade Ile t Preferred geometry i Typical Execution Class and class members classes inheritance diagram The Windows menu allows to select an opened diagram or change the sub windows disposition Tools menu 07 10 2007 16 00 7 of 357 Tools Show Trace Window Generate C Generate Java Generate Php Generate Idi Ctri G Ctrl J Ctrl P Cirl l Reverse C Reverse Java Reverse Php Java Catalog HT MIL documentation HTML dac fat HTML doc svg HTML dac flat svg Impart Rose Generate XMI 1 2 Generate AMI 2 1 Import XMI 2 1 Check in Check out Global Change Tools settings Import settings file C uml BOUML bouml 3 0 doc TOUT html The Tools menu allows to re open the trace window where the plug outs write their messages to apply a plug out on the project independently of the browser item currently selected to add remove modify the known plug outs list see plug out or to import the plug outs list defined in an other project Language menu Languages VBrDase code generation Preserve operations s body lv C management and default declaratiorvdefinition Java management and default definition Php management and default definition Idi m
394. thanks to Qt The implementation of BOUML is compatible with Qt version 2 4 up to at least the 3 3 but the releases can t be used because thee releases are compatible with the previous The documentation is written with OpenOffice org writer many thanks for this powerful and pleasant office suite The screen copies are made with Ksnapshot and sometimes modified by Le Gimp to have burred areas thanks to the authors for these practical tools Some of the examples given in this documentation spoke about the organs describing an organ is very easy for me in French not in English I get the English translation of the words associated to the organs from a Marya J Fancey documentation thanks to her Copyright BOUML is a free software distributed on the Internet http bouml free fr Copyleft 2004 2007 by Bruno Pag s This program is free software you can redistribute it and or modify it under the terms of the GNU General Public License as published by the Free Software Foundation either version 2 or at your option any later version This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License for more details The complete text of the GNU General Public License can be found in this document appendix Copying and distribution of the documentation or a part of the documentation an
395. the Ocl language but in fact BOUML doesn t check the syntax this is just a convention 152 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog amp id lh Ales Um trigger Ocl trigger Ces trigger Java Properties M unmarshall D time event conditian condition Unmarshall is the standard UML property time event allows to indicate is the event is a timer to choose between the two representations Activity accept event action dialog tab C This tab allows to specify the trigger and the pre and post condition in C but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 mm rye Umi trigger Ocl trigger C rigger Java Properties tigers Pre condition Post condition Activity accept event dialog tab Java This tab allows to specify the trigger and the pre and post condition in Java but in fact BOUML doesn t check the syntax this is just a convention 153 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog S mpm eye Um Apte trigger C trigger Java i mn trigger dS don Bem ceca Activity read variable value action dialog tab Uml Activity Action dialog 5 mp Umi variable Oct Java Properties name action Stereotype 1 description Editar Activity read variable value a
396. the current diagram sub window size and the current scale These ones will be used the next time the diagram wil opened Picture Menu set preferred scale To memorize the current scale These one will be used the next time the diagram will be opened Picture Menu restore preferred size and scale In case a preferred sub window size and preferred scale was set follow them Picture Menu unset preferred and scale To stop to define a preferred size and scale was set Picture Menu format By default the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e iso A5 592 x 840 e iso A4 840 x 1188 e iso A3 1188 x 1680 e iso A2 1680 x 2376 e iso Al 2376 x 3364 e iso AO 3364 x 4756 e USAA 864x 1116 e USAB 1116x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape 265 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Picture Menu undo changes Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored E Default stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams Drawing 266 of 357 Default stereotypes dialog lt 3 Pape rest ey ae
397. the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on a activity control node of this kind The selected tool is called and applied on the current activity control node Default stereotypes The dialog allowing to set the default stereotypes Default stereotypes dialog 5 icai deas others pedet uat activity contro node stereotypes actu acter Drawing A activity control node is drawn in a diagram depending on its kind 175 01 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html A right mouse click on a activity control node in a diagram calls the following menu supposing the activity control node editable upper lower edit activity node select In browser select linked items remove from view delete from madel Previous activity object Next flow 176 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Flow We consider in this chapter both the control flows and the object flows there are not distinguished by a given flag but by their usage When you try to create a flow through a diagram Bouml checks the validity of the flow for instance you can t have a flow starting from an output pin but you may after edit the extremities of the flow producing an invalid case you are responsible of that perhaps the non consistent flow is temporary To add a flow you have to use
398. the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this attribute defined in Java empties the declaration manually or using the button not generated in Java It is possible to follow the visibility as it is set in the UML Tab or to change it replacing visibility by the desired one static produce an empty string when the attribute is not an class attribute see the UML tab else produce static final produce an empty string when the attribute is not read only see the UML tab else produce final transient produce an empty string when check box transient is not checked else produce transient volatile produce an empty string when the check box volatile is not checked else produce volatile type is replaced by the class pointed by the attribute see the UML tab stereotype is replaced by the translation in Java of the relation s stereotype see the UML tab multiplicity is replaced by the multiplicity of the relation see the UML tab must be used in case the multiplicity is a vector or array dimensioning and are added when they are not present name is replaced by the attribute s name see the UML tab value is replaced by the initial value of the attribute see the UML tab may be used to specify the value of an enumeration s item fo instance produces the annotations when it is present in the definition t
399. the same level When you drag an item it on a container item it2 which may contain itl it will be the first it2 s children in case it may be moved in i72 or after i12 Bouml ask you to choose Multiple selection is not allowed in the browser using the classical way I consider that it is to simple to loose a multiple selecti through a wrong mouse click I replace classical multiple selection with the possibility to mark browser items through the me appearing on a right mouse click or through a control left mouse click Marked items are written on a red background and may be moved or duplicated under condition 12 of 357 07 10 2007 16 00 13 of 357 ise Case Diagram Sequence Diagram FalCollaboration Diagram etl Sub Use Case View BBgcClass view BElAClass Class Diagram Sequence Diagram FalCollaboration Diagram B gComponent view component Component Diagram B BsiDeployment view Node Deployment Diagram suh Lise Case View file C uml BOUML bouml 3 0 doc TOUT html sub Use Case View new Use case diagram new sequence diagram new collaboration diagram new use case new actor new class New sub use case view edit edit drawing settings delete mark move market mto move marked after duplicate marked into tool d On the example above at the menu appearing on the use case view propose to mark it to move the marked items into it to move the marked items after it in this case only the order of the it
400. the selection in C but in fact BOUML doesn t check the syntax this is just a convention Expansion Node dialog 2 nere Umil Ocl Kea Java Properties selectian Expansion node dialog tab Java This tab allows to specify the selection in Java but in fact BOUML doesn t check the syntax this is just a convention 145 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Expansion Node dialog 2 equi mgr Um oci ee Java Properties selectian OK Cancel Menu duplicate The menu entry duplicate clone the expansion node without its children Menu delete The menu entry delete is only present when the region is not read only Delete the region and all its children and all the representation of them in the opened diagrams After that it is possible to undelete them from t browser until you close the project obviously the deleted items are not saved Menu referenced by To know who reference the current parameter through flow Menu mark See mark Menu tool The menu entry tool 1S only present in case at least a plug out may be applied on an interruptible region The selected tool is called and applied on the current region Ie Default stereotypes The dialog allowing to set the default stereotypes 146 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html wo o Default stereotypes dialog Package Class UseCase Artfact Views Dia
401. through any line in the previous picture this select all except the package the text upper diagram and the use case diagram icon Text Text is another way to write a text contrary to the note a text is written alone see upper diagram on the picture below by default a text contains blabla a text cannot be empty The edition of a text is done like for a note A text is resizeable a resize is not automatically done when the contains is modified A right mouse click on a text show the following menu font remove from view Diagram icon A diagram icon is a shortcut to a diagram this allows to quickly navigate through the diagram without limitation a actor or some other item kinds may be associated to only one diagram The used icon indicates the diagram kind but its name is not written A double mouse left click on a diagram icon opens the diagram the open entry of the diagram icon menu does the same thing A right mouse click on a diagram icon show the following menu upper lower open select diagram in browser select linked Items remove from view The other diagram s elements have an own chapter refer to them Previous class diagram Next state diagram 251 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html State diagram Boum home bruno uml EX state state prj cB mr Project Windows Tools Miscellaneous Help js a amp l praw sar Diagram m
402. tion i Object link dialog 25 rim To set the association select one clicking on a cellule or on the first column then press Ok To unset the association press Unset then press Ok TE ee 1 mother CVE MTE ESON i _ Bruno Persen father Evelyne Person BrunoPerson husband wife Evelyne Person 14 _ Evelyne Person mother Bruno Person Is Evelyne Person father Bruno Person e Evelyne Person husband wife Bruna Person New Unset OK Cancel Link Menu select relation in browser Is of course only available when the relation is set Message Menu select labels Of course only available when the relation is set to select the labels relation s name stereotypes role s and multiplicity ies associated to the relation Useful when you are lost after many label movings Message Menu labels default position Of course only available when the relation is set to place the roles s name associated to the relation in the default position Usefu when you are lost after many label movings By default when you move a class instance or a link point break or edit the link the labels are moved to their default position this may be irritating To ask BOUML to not move the labels in a diagram use the drawing settings of the diagrams Class instance Menu The menu appearing with a right mouse click on a class instance is something like this supposing the diagram not read only 247 of 357 07 10 2007 16 00 file
403. tion Sequence diagram Refer to sequence diagram for more information Collaboration diagram Refer to collaboration diagram for more information Class diagram Refer to class diagram for more information H Activity diagram Refer to activity diagram for more information 4 State diagram Refer to state diagram for more information Object diagram Refer to object diagram for more information Component diagram Refer to component diagram for more information A Deployment diagram Refer to deployment diagram for more information 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Previous top level menus Next package 19 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Package A Package is first something like a directory and may contain other packages use case views class views component views and deployment views and dependencies in any order Package a fase Case View mfaClass view amp figComponent view Deployment view a subPackage1 lt dependency gt other Package A package allows also to indicate where the code must be produced by the generator for each language and to specify the C namespace Java package Idl module A generator producing code for a component looks at the package containing the compon view where is the component to get these information The project is in fact the top level package The relation between packages are dependencies an
404. tion object use case drawing language umi show operations full definition no show hierarchical rank l show packages context write name type horizontally show packages name in tab T automatic labels position yes show packages context drew all relations yes 1 draw all relations draw shadow yes draw shadow show packages name in tab show packages name In tab no show packages context show packages context no automatic labels position yes 1 draw all relations yes 1 automatic labels position yes draw shadow draw all relations yes draw component as icon show component s required and provided interfaces draw shadow YES 1 show components realizations 23 OL 3537 07 10 2007 16 00 26 of 357 oration object use case component depl i 1 1 L show packages name in tab na show packages context write node Instances horizontally yes automatic labels position yes draw all relations yes draw component as icon show component s required and provided interfaces show component s realizations na show packages name in tab no show packages context automatic labels position write flow label horizantally show opaque action definition no draw all relations ves draw shadow show information nate drawing language file C
405. tion for all the oper definition In BOUML the generated code is obtained by the substitution of macros in a text the macros known by the Java code generator are e comment is replaced by the description of the operation adding e description is replaced by the operation description without adding e visibility produce the visibility see the UML tab e final produce final when ye operation is specified final e static produce static when the operation is a class operation see the UML tab e abstract produce abstract when the operation is abstract see the UML tab e synchronized produce synchronized when the operation is synchronized e type is replaced by the value type see the UML tab e name is replaced by the name of the operation e and produce and but there are also a mark for BOUML to find the parameters list e t lt n gt and p lt n gt produce the type and the name of each parameter count from 0 this allows you to remove a parameter etc e throws is replaced by the form throws when at least an exception is defined in the UML tab e staticnl produce a line break when the operation is static else an empty string In case you do not like this notation change the generation settings to remove this macro e body is replaced by the body of the operation this macro may also be replaced by the body itself BOUML use this way for the get and set operations associa
406. tiple selection menu select linked items Align Copy selected Ctri c Cut selected Ctri x remove from view Remove selected from view Suppr Delete selected Control q Edit drawing settings and for instance when the elements are classes in a class diagram 268 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html a Diagram Drawing Settings diagram color drawing language unchanged drawing made unchanged show context unchanged hide attributes unchanged hide operations unchanged show members full definition unchanged M show members visibility unchanged z show parameter direction lt unchanged gt show parameter narme unchanged show information note sunchangeds The settings valuing unchanged are not changed for the selected elements in the other case the same value is set for all the elements Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu E dit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window t
407. tiplicity is a vector or array dimensioning and are added when they are not present name is replaced by the attribute s name see the UML tab value is replaced in the source file by the initial value of the attribute see the UML tab when this one is not an enumeration item 84 of 357 07 10 2007 16 00 85 of 357 file C uml BOUML bouml_3 0 doc TOUT html enumeration items the value is of course generated in the header file h_value is replaced in the header file by the initial value of the attribute see the UML tab h value must be used when you want to set the value of a const attribute mutable produce an empty string when the check box mutable is not checked else produce mutable volatile produce an empty string when the check box volatile is not checked else produce volatile The definition of the attribute stops may be Attribute dialog i wah al Lim Ct Java Idi User Visibillty follow umi protected public protected private comment static mutable volatile i const vector type iname valus Declaration vectorsBStop stops Result after substitution Default declaration Not generated in C Refer to the generation settings and the C Generator for more details and explanation of the other keywords Attribute dialog tab Java This tab allows to give the Java definition of the attribute it is visible only when Java is set t
408. to default stereotype and generation settings for instance to produce a vector The friend stereotype is a special case for a dependency and is used to produce a C friend declaration Refer to relation for more information E Attribute There is not restriction for the attributes an attribute s type may be a class or an int for instance The icon in the browser indicate if the attribute is public protected or private The protected visibility is translated in private in Idl Refer to attribute for more information 15 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html a Operation The icon in the browser indicate if the operation is public protected or private The protected visibility is translated in private in Idl Refer to operation for more information i ex Extra member An extra member is an alien allowing you to specify directly the generated code for each language This allows to manage non U items for instance C pre processor directives Java attribute initializations etc Refer to extra member for more information L1 Class instance A modeled class instance a sequence diagram object diagram or collaboration diagram may contain modeled class instances and graphical classes instances out of the model Refer to class instance for more information O State A state represents a state machine a sub machine a composite state or a simple state A state may
409. to specify the visibility for each one show full members definition To write all the attribute operation definitions or just their names See also drawing language show members visibility To write or not the visibility show parameter direction To write or not the direction of the operation s parameters show information note To show or not the constraints as a note This note 1s able to contain the constraints of the class itself the constraints of its member and the inherited constraints To choose which constraint must be written edit the node and a dedicated dialog will appears Lm 5 ope r z Eu M 4 Constraints visibility dialog 25 TT Click on Vfisible H idden to change the constraint visibility element constraint visibility API BASE UmiBaseClasshiember mm volatile API BASEsUmiBaseClassMember all API USER Umiltem annotation constraint API USER UmiClassMember apply AFI BASE UImlBaseltem bypass comment AF USER Umilltem chapter AP USER Limilltem chapterp API USER Umiltem Ba IE all oes ome Te Per Pa eer Ga Lt 7 T Specify visible elements rather than hidden ones Show all Hide all Hide inherited class color To specify the fill color Menu individual attribute visibility To specify the hidden written attributes of the class through the following dialog 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Sett
410. tr remove from view E align lett remove selected fram view Suppr a align right delete selected Control d ID align center F align center verticaly H amp align center horzontaly If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally Multiple selection menu select linked items Align i Copy selected Ctri c Cut selected Ctriex remove from view Remove selected from view Suppr Delete selected Control dq Edit drawing settings and for instance when the elements are classes in a class diagram 23 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html D Diagram Drawing Settings diagram color drawing language unchanged z drawing mode unchanged gt show context unchanged hide attributes unchanged hide operations unchanged show members full definition unchanged show members visibiliby unchanged show parameter direction unchanged show parameter name unchangeds show information mote unchanged The settings valuing lt unchanged gt are not changed for the selected elements in the other case the same value is set for all the elements Note A note may contain any text a note is resizeable To change the text of a note choose the edit entry of its menu or double click on it this open a window containing the text close the window t
411. tring name Default declaration For an enumeration s item Enum item dialog Wml Ken Java idi User Siname value l comment Declaration Compound have more than one pipe souding per note Default declaration Not generated in C OK Cancel In BOUML the generated code is obtained by the substitution of macros in a text only the Declaration part is editable the other one help you to see what will be generated for C supposing you do not modify the C code generator Result after substitutian When you push the button default declaration the form specified through the generation settings is proposed this last may be modified as you want even to produce illegal source code When you do not want to have this attribute defined in C empties the declaration manually or using the button not generated in C It is possible to follow the visibility as it is set in the UML Tab or to change it static produce an empty string when the attribute is not a class attribute see the UML tab else produce static const produce an empty string when the attribute is not read only see the UML tab else produce const type is replaced by the type of the attribute see the UML tab stereotype is replaced by the translation in C of the relation s stereotype see the UML tab multiplicity is replaced by the multiplicity of the relation see the UML tab must be used in case the mul
412. ttings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level write horizontally To made the label indicating the name weight and guard on one line or several show information note To show or not the selection and transformation Drawing language To choose the language used to write the weight guard selection and transformation Previous activity control node Next component 182 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Component A component is an autonomous unit with well defined interfaces that is replaceable within its environment In the old release BOUML up to the 1 5 1 the behavior of the artifact was defined at the component level A component may be placed in a component view or is nested in another component Bg fic omponent view component diagram B 8 Store amp lOrder E jCustomer t Product A component may be created through the new component entry of the component view menu or through the component button of a component diagram Browser Menu The component menu appearing with a right mouse click on its representation in the browser is something like these suppos component not read only nor deleted see also menu in a diagram Customer add nested component edit set It nested In Order extract it from Store delete referenced by mar
413. tton iexcept for the self operation message move the mouse to the receiver maintaining the mouse button down then mouse button up BOUML doesn t fix the vertical size of the rectangle representing the activity duration you are the master To do this click down the left mouse button on the top or bottom and move the mouse The size of an activity bar is updated when you try to move a messa above the top or below the bottom of the bar When you move vertically a message operation out of its current activity durati rectangle a new one is automatically added is needed The scale may be changed from 30 up to 200 To allows to see the operation message kinds even with a small scale the size of the unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give several scales Classically the left mouse click may be used to select an element or several when the control key is down a multiple selection may also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements
414. ublic C protected C private nist aa f trei eame sex wane F asain uni m Sicomment final t visibility abstract static function name i 12 default definition bodyl I su Ta ASh defaut icomment livisibility h type finan deci Mon m vahiy Comtant deta yid eppe iname Linen Bpm Bram L comment Ernumerabon tem detaut darin ebyn t Sinima r r name get_ atc m umi n F onay mme t Rino ge umi TERN Siconment onewsy t type name 6 5S lraisesnl Sirsises Operation default deciaration The tab Description allows to set a default description 107 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html T GenerationSettings dialog S n feri ee eta eor savani savate aot nr rae ena sons js gt Operation defautt description Drawing The operations are drawn with their class in a class diagram and alone in a sequence diagram or a collaboration diagram The way an operation is written or not in its class picture in a class diagram depend on the class drawing settings options drawing language hide operation show full members definition and show member visibility and also on the class menu entry individual operation visibility For instance in a class diagram the drawing language is UML the full member definitions and visibility are shown and the attributes are hidden UmlOper
415. ugh the generation settings By default the get and set operations generated for the Stop s attribute name are C inline const string Stop get_name const return name void Stop set_name string new_value name new_value Java public final String get_name return value public void set name String new value name new value Php final public function getName return Sthis gt name public function setName value Sthis name Svalue Idi string get name void set name string new value Menu delete The menu entry delete is only present when the attribute is not read only Delete the attribute associated get and set operations when they exist and all the representation of them in the opened diagrams After that it is possible to undelete them from the browser until you close the project obviously the deleted items are not saved Menu mark See mark Menu tool Appears only when at least one plug out is associated to the attributes To apply a plug out on the attribute 89 of 357 07 10 2007 16 00 90 of 357 Default stereotypes file C uml BOUML bouml_3 0 doc TOUT html The dialog allowing to set the default stereotypes has a tab associated to the attributes Default SRE ROLLS OR dialog A es i co The stereotype of an attribute does not have a special meaning for BOUML Generation settings
416. ult indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a class in a diagram all the settings are set to default a Diagram Drawing Settings dialo sss wa b iiit diagram color drawing language default drawing mode default show context default hide attributes default hide operations default show members full definition default class color defaut 1 show members visibility default show parameter direction show parameter name default taut wma sex sex en er em KE show information note default cu drawing language Allows to choose how the operations and attributes of the class must be written in case show full members definition is true at the class level or an upper level this may hide an operation or an attribute when it is not defined for the chosen language For instance the class C has the attribute a having the type uchar supposed translated unsigned char in C char in Java and octet in Idl the operation op returning an uchar and having the input parameter p having the type uchar and only in Id a second out parameter p2 of the same type The C picture is depending on the drawing language language drawing mode Allows to draw the class using a rectangle or an icon class to draw a rectangle whatev
417. ult stereotypes The dialog allowing to set the default stereotypes has a tab reserved for the diagrams Default stereotypes dialog amp a mi Package Class UseCase Artfact Views Diagrams Activities Others class diagram X stereotypes abject diagram PO stereotypes collaboration diagram TO stereotypes sequence diagram CO Stereotypes use case diagram NEEMMMMESUS CcCcCI stereotypes state diagram PO stereotypes activity diagram PO stereotypes component diagram OO stereotypes deployment diagram CO sterentypes Drawing key down 1 keyDownt 1 2 1 blow 3 diagram icons packages and the operations messages To place these elements in the diagram use the buttons on the top to create a new element or choose from the already defined one then click at the appropriate position in the diagram or grab the element from the browser into the diagram To add an operation message on an already existing link double mouse click on it or use the menu appearing though a right mouse click The scale may be changed from 30 up to 200 To allows to see the operation message kinds even with a small scale the size of the 230 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html unmodified fit allows to set the largest scale allowing to show all the picture as it is possible Because of the scrollbar management hitting seve times on fit may give
418. ult the diagram s canvas size is 840 x 1188 points corresponding to an iso A4 format 210 4 x 297 4 all the available formats are e iso A5 e iso A4 e iso A3 e iso A2 e iso Al e iso AO 592 x 840 840 x 1188 1188 x 1680 1680 x 2376 2376 x 3364 3364 x 4756 e USA A 864 x 1116 e USA B 1116 x 1728 e USA C 1728 x 2236 e USA D 2236 x 3456 e USA E 3456 x 4472 Each format also exists in landscape Picture Menu undo changes Undo all the changes made since the diagram was opened the last time Note that the diagram is restored independently of the t project saving Obviously the deleted browser items was not restored Operation message Menu The menu appearing with a right mouse click on an operation message arrow is something like these supposing the diagram not read only Message Menu edit 214 of 357 edit drawing settings select operation in browser select linked Items select label label default position remove from view 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html edit allows to edit the message In case the diagram is read only the fields of the dialog are also read only Message dialog lt To m message joptin p uchar aut pz uchar uchar Message type synchronous asynchronous When the arguments are specified they replace the operation s parameter s without any check The proposed messages are the o
419. uplicate delete Menu edit edit allows to show modify the pin properties In case the pin is read only the fields of the dialog are also read only Pin dialog tab Uml The tab Uml is a global tab Um ocr C Java Properties name i 0 stereotype P SS 3 direction out mutpiy prdering unordered efect none M In state j i T is control T unique standard C exception C stream description Editar The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The proposed types are the non class types defined in the first tab of the generation settings more all the classes defined in the project with their localization to distinguish synonymous classes You are not limited to the proposed list and any form even invalid for the target language s may be given The button type shows a menu proposing e if the current type of the pin is a class to select this class in the browser e if the pin is not read only and if a class is selected in the browser to set the type to be this class e if the view containing the activity is not read only to create a class and to choose it The direction multiplicity ordering effect in state default value is control uniqu
420. uplicate delete mark tool Browser Menu show show allows to show the diagram picture and edit it in case it is not read only Browser Menu edit edit allows to show modify the diagram properties In case the diagram is read only the fields of the dialog are also read only Use case diagram dialog tab Uml Use Case diagram dialog 3 it a Lil User name ie down stereotype 1 description Editor 202 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html The proposed stereotypes are the default one specified through the Default stereotypes dialog more the current one empty here It is possible to choose into the list or to give a new one or to empty it The stereotype of a diagram doesn t have a special meaning for BOUML The editor button visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Browser Menu edit drawing settings This dialog allows to specify how the
421. ur others Package Class UseCase Artfact Views Diagrams Activities activi ject node ty obj datastore centraiBuffer Stereotypes Drawing An activity object is drawn in a diagram as a rectangle with its stereotype it type if set and its selection except if you ask to not show it 171 of 357 07 10 2007 16 00 172 08 357 file C uml BOUML bouml_3 0 doc TOUT html A right mouse click on a activity object in a diagram calls the following menu supposing the activity object editable Upper lower edit drawing settings edit activity object select in browser select class in browser select linked items set associated diagram remove from view delete from madel Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a activity object in a diagram all the settings are set to default p Diagram Drawing Se aes Diagram Drawing Se aes agr coer sagre write name type default horizontally show information note default class instance color default drawing language mm Cancel Cancel write name type horizontally usefull when the object has a name and a type to write th
422. us ur ates uhe Curie Ser amo se Cdp riers ll Dediniten wipe enters venini draw all relations show Dacimges are i tab Vna Vue Caer and pacte content automatic labels position na show information note default Tes iip etat A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level 07 10 2007 16 00 80 of 357 file C uml BOUML bouml 3 0 doc TOUT html draw all relations To automatically draw or not the new relations obviously a relation will be added in a diagram only when the start and end classe may be the same are drawn class diagram automatic labels position To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited or the associated class pictures moved etc show information note TO ask Bouml to write the relation s constraint in the note attached to the class except if this setting is set to false on the class o1 when you ask for hide at least relation s constraint Previous class Next attribute 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Attribute Contrarily to the relations there is no restriction concerning the types of the attributes whose may be a class or an int for instance An attribute is created through the class menu called from
423. ustom is not checked else produce custom custom is available when the stereotype of the class is valuetype in Idl see generation settings The external check box must be used when the class must not be defined in Idl by BOUML but you want to specify the name of the class to follow the Uml C Java name and or the included files needed to use it Not yet implemented in the Idl generator members produce the declaration of the class members relations attributes operations and extra members following the browser order Refer to the generation settings for more details The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted Menu duplicate The menu entry duplicate clone the class and all its children including the nested classes The self relations a self relation is a relation between a class and itself are specially managed they became a self relation to thi clone For instance if the initial situation is the following 55 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Project Windows Jools Miscellaneous Help FLET dl Olagram KiB Es i BAF p ep e 4 4 4k o D ee abe ioo 4 Mu B Class view amp Diagram Bec rac list the_e2s lt unidirectio reself cunidirectional associati BSC g lt unidirectional
424. utton visible above and associated here to the description allows to edit the description in an other window or to call an extern editor for instance Xcoral specified through the environment variable BOUML EDITOR Note that this external editor have to create an own window its parameter is the pathname of the file containing the description its execution is done in parallel wi BOUML which looks each second at the file contents to get the new definition until the dialog is closed I do not like very mucl polling but this works even QT isn t compiled with the thread support Class dialog tab Attributes This tab allows to specify the value of the attributes of the instance including the inherited ones 115 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html 4 Class instance dialog 5 umi Attributes Relations Properties Attribute Cass Value aircolor Unfortunately an attribute can t be set several times this is a problem when an attribute has a multiplicity greater than 1 Class dialog tab Relations This tab allows to specify the value of the relations of the instance including the inherited ones 4 Class instance dialog 5 Urmi Attributes Relations Properties moe kina Role css nst Delete 1 gt Wile sandrine Woman i2 pascathan gt hild joana Weman Unfortunately a relation can t be set several times this is a problem when a relation
425. va Beans that were developed under JDE 1 0 2 to run correctly under JOK 1 1 The corresponding JDE 1 1 type is javalo Seralizable see java lo Serializable B Obviously it is possible to do several scan phase in different directories to complete the catalog At this level nothing is done BOUML side To save your catalog use the save entry of the file menu or the associated button Open allows to get an already made catalog may be to complete it The main goal of Java catalog 303 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html is to send a class or all the classes under a package and its sub packages to BOUML using the menu appearing with a right mou button click on a class or a package into the Java catalog browser Serialt able show file In case the sent class es reference other classes for instance to inherits them these classes are also sent with the classes the reference etc For instance in case the BOUML project p is empty and the class sunw io Serializable is sent the result will be Bouml Sia i Project Windows Tools Miscellaneous Help ce Ed S amp S GO M browser Ep E jsre E sunw Bio Bfgio EE e interface Serializable a generalisaion Serializable Reed ritis js a compatibility type ta allow Javi Be E java were developed under JOK 1 0 2 to run correctly under JL E lo corresponding JDK1 1 type is java ia Serializable E alia B lt lt interf
426. vanced gt environment variables To define an environment variable under Linux t csh place the following line in your cshrc setenv lt var gt lt value gt To defined an environment under Linux bash place the following line in your bashrc export lt var gt lt value gt Previous GNU public license 357 of 357 07 10 2007 16 00
427. variable value action Activity write variable value action Activity add variable value action Activity remove variable value action The dialog is equals to the read variable value action case Activity call behavior action dialog tab Uml 155 0f 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Activity Action dialog S icale i ile Umil behavior Oel c dava Properties name faction Stereotype 1 description Editor Activity call behavior action dialog tab Ocl The Ocl tab allows to specify the behavior a state or an activity and the pre and post condition using the Ocl language but in fact BOUML doesn t check the syntax this is just a convention Activity Action dialog 5 pump Umil behawvlar Oel c Java Properties V synchronous behavior Pre conditian Post condition The button behavior shows a menu proposing e if the current behavior is set to select this class in the browser e if the action is not read only and if a state or activity is selected in the browser to set the behavior to be the selected element e if the view containing the activity is not read only to create an activity or a state machine and to choose it Activity call behavior action dialog tab C This tab allows to specify the pre and post condition in C but in fact BOUML doesn t check the syntax this is just a convention 156 of 357 07 10 2007 16 00 file
428. w E align lett remove selected fram view Suppr H align right delete selected Control d IG align center F align center verticaly H8 align center horzontaly Multiple selection menu select linked items Align Copy selected Ctri c Cut selected Ctri x remove from view Remove selected from view Suppr Delete selected Control q Edit drawing settings and for instance when the elements are classes in a class diagram 240 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html a Diagram Drawing Settings diagram color drawing language unchanged drawing made unchanged show context unchanged hide attributes unchanged hide operations unchanged show members full definition unchanged M show members visibility unchanged z show parameter direction lt unchanged gt show parameter narme unchanged show information note sunchangeds The settings valuing unchanged are not changed for the selected elements in the other case the same value is set for all the elements Fragment A fragment is resizeable To change the fragment s name choose the edit entry of its menu or double click on it A right mouse click on a note show the following menu E dit Add separator Edit drawing settings Remove from view Edit drawing settings allows to change the fill color Note A note may contain any tex
429. where the package is defined must be written and if yes how The context may be the UMI context which is the path of the package in the browser or the C namespace or the Java package or at least the Idl module See package context e automatic labels position To ask BOUML to move or to not move the associated labels on the relations in a diagram when the relation is edited associated State pictures moved etc e write transition horizontally to write the transition s trigger guard constraint and activity on only one line or each one on a different line 253 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html Borm a dgger c a guard an activity e show transition definition to write the name of the transition or its trigger guard constraint and activity e show state activities to show or not the state s activities in a compartment depending on the drawing language stated entry behavior done on entry xit behavior done on exit d behavior in state e draw state s regions horizontally to indicate if the regions are drawn horizontally or vertically for instance Processes Diagram eu rmElozeoeexeg89eoxeumpon Note the regions are not visible while the state picture is too small e drawing language to indicate in which language the transition and state s compartment must be written Browser Menu duplicate Clone the diagram in a new one Browser Menu
430. where x0 yO specify the top left corner and x y the bottom right corner These limits are taken into account only for the initial size and position of the BOUML s windows and when a dialog is opened after that you are able to go out of these limits up to the true desktop limits After editing a description or other part the font is modified or several characters are replaced by a space During the edition the characters encoded with a 16 bits unicode character set but out of the editions the characters are saved on only 8 bits When you use non ISO 8859 1 latinl characters you must specify how to do the convers through the environment variable BOUML CHARSET When this variable is undefined or has an empty value the character set is ISO 8859 1 If its value is not a knc character set s name a dialog appears when you start Bouml giving the available names So to know the possil character sets set BOUML_CHARSET to wrong for instance and call Bouml Examples the list depends on the release of Qt ISO 8859 1 latinl for English French Italien German ISO 8859 7 for Greek e KOI8 R or KOI8 RU or CP 1251 to allow Cyrillic e JIS7 for Japan 350 of 357 07 10 2007 16 00 351 of 357 file C uml BOUML bouml 3 0 doc TOUT html The specified encoding is used for the description of every elements the user properties and associate values of every elements the stereotype of every elements the definition of the artifa
431. wing settings i Diagram Drawing Settings di sk use case object sequence collaboration stat show packages name in tab default d show packages contest default 1 automatic labels position default draw all relations default draw shadow default drawing language def instances drawing mode show operations full definition default write name type horlzontally default draw all relations default draw shadow default 31 of 357 use CHASE i Diagram Drawing Settings di ssk object sequence collaboration stat Laa write nametype horizontally default show packages name in tab default show packages context default 1 automatic labels position default draw all relations default draw shadow sat drawing language default show operations full definition default show hierarchical rank default write nametype horizontally default show packages nameintab default show packages context draw all relations default draw shadow default 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Diagram Drawing Settings di Ls 2 CASE object SeQUENCE collaboration state quence collaboration state activity color 1 show packages context default 1 default use case colar default or default automatic labels position default default package color
432. with two lobes UML 1 5 notation 185 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html component diagram e OF g gt 4 oD oe scale 100 4 fit f a Accaunt The default color of a component may be set through the drawing settings A right mouse click on a component in a diagram calls the following menu supposing the component editable upper lower edit drawing settings edit component select in browser select linked items set associated diagram remove from view delete from model tool Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a component in a diagram all the settings are set to default drawn as ican defaut lt LL Diagram Draw y show required and provided interfaces defaut diagram calan show realizations defaut 1 component color defaut 1 show allows to write or not the component s interfaces and realization into its drawing as a compartment Menu set associated diagram set associated diagram allows to automatically open the current diagram when a double mouse click is made on the component representation in a diagram or the browser After that the only way to
433. wser until you close the project obviously the deleted items are not saved Menu tool The menu entry tool is only present in case at least a plug out may be applied on a state The selected tool is called and applied on the current state Default stereotypes The dialog allowing to set the default stereotypes 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Default stereotypes dialog 55 mpre mle Package Class UseCase Artifact Views Diagrams others Drawing A state is drawn in a diagram as a rectangle with rounded corners Bouml home bruno uml EX state state prj 2 Project Windows Tools Miscellaneous Help ME J enteramount 0 Et c oe d es A right mouse click on a state in a diagram calls the following menu supposing the state editable enterAmount upper lower edit drawing settings edit State select in browser select linked items set associated diagram remove from view delete from model fno J 122 01 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html Menu edit drawing settings These drawing settings concerns only the picture for which the menu is called A settings valuing default indicates that the setting specified in the upper level here the diagram must be followed obviously this one may also be default up to the project level When you add a state in a diagram all the settings are set to
434. y also be done defining a region using the mouse left click out of any element and moving the mouse with the click and maintaining the click down The diagram s elements may be moved after a left mouse click on an element and maintaining the click down during mouse move The right mouse click is used to show context dependent menus control s is a shortcut to save the project control a is a shortcut to select all the diagram s elements control d is a shortcut to delete the selected element s the model is affected suppr is a shortcut to remove the selected element s from the diagram these elements are not deleted control c 1s a shortcut to copy the selected diagram s elements control x is a shortcut to cut remove from view the selected diagram s elements control v is a shortcut to paste the selected diagram s elements control z and control u are a shortcut of undo control r and control y are a shortcut of redo the keyboard arrows allow to move the selected items You can define your own shortcut using the shortcut editor through the Miscellaneous menu When several diagram s elements are selected the menu appearing on a left mouse click allows to align them If all the selected elements has the same kind for instance all are a class you edit their drawing settings globally Multiple selection menu select linked items IE align top copy selected Ctrit c lu align bottom cut selected Ctri x remove from vie
435. ymous classes You are not limited to the proposed list and any form even invalid for the target language s may be given The button type shows a menu proposing e if the current type of the attribute is a class to select this class in the browser e if the attribute is not read only and if a class is selected in the browser to set the type to be this class e if the view containing the class containing the attribute is not read only to create a new class and to set the attribute type to it Nevertheless I strongly recommend you to not add type modifier like amp etc with a class name in the UML tab because BOUML differentiate a reference to a class of the model and any other forms Supposing you also have the class attribute stops defined for C like this 82 of 357 07 10 2007 16 00 file C uml BOUML bouml 3 0 doc TOUT html i Attribute dialog 5 pomme Umil c Java idi Properties class Keyboard Organ name stops stereotype al aa 3 multiplicity FO Initial value edu C pubic protected C private C package I class attribute T volante T read only description Editar Defauit constraint Editor OK Cancel the C generated code will be the desired one but if you rename the class Stop the type of the attribute stops will not be updated Furthermore the C code generator will not see the usage of the type Stop and will not automatically generate
436. ype modifiers etc throw is replaced by the form throw when at least an exception is defined in the UML tab It is also possible to produce throw when there is no exception depending on the generation settings body is replaced by the body of the operation this macro may also be replaced by the body itself BOUML use this way for the get and set operations associated to a relation attribute The usage of body has a great advantage when you hit Default definition or From declaration the body is not cleared At least BOUML share the declaration and definition forms of the operations and other objects to minimize the needed memory size body help for this The indentation of the keyword body is added at the beginning of each line except the ones starting by a or when the previous one ends by V The forms property are replaced by the value of the corresponding user property if it is defined for the class or at an upper level else it is not substituted 100 of 357 07 10 2007 16 00 file C uml BOUML bouml_3 0 doc TOUT html A template operation is defined with an empty declaration allowing Bouml to detect this case and placing the actuals between class and in the definition part The edit body button is active when the definition contains body to edit it through the editor you want define the environment variable BOUML EDITOR furthermore when you set add operation profile on body edition throu

Bouml reference manual - Fedora Project Packages GIT repositories

Contents

Download Pdf Manuals

Related Search

Related Contents