home *** CD-ROM | disk | FTP | other *** search
/ C/C++ User's Journal & Wi…eveloper's Journal Tools / C-C__Users_Journal_and_Windows_Developers_Journal_Tools_1997.iso / withcls / readme.txt < prev    next >
Text File  |  1996-09-30  |  20KB  |  437 lines
  1.                            Welcome to With Class - Version 3.1  
  2.  
  3.                   MicroGold Software, Inc 76 Linda Lane Edison, NJ 08820
  4.           e-mail 71543.1172@compuserve.com
  5.           Telephone:     908.668.4779
  6.           Fax:         908.668.4386
  7.                   MicroGold Home Page http://www.microgold.com
  8.  
  9. With Class Version 3.1 New Features: This version supports the Unified 
  10. Method, relational database reverse engineering, reverse of  C++ 
  11. templates and nested classes and structs, Delphi Reverse, Java Reverse, 
  12. and Visual Basic class reverse into diagrams,  improved code generation 
  13. (Java, Delphi, Visual Basic 4, VHDL, and others), OLE cut/paste/in-
  14. place editing, many View improvements to hide/show diagram 
  15. information (visibility, attribute data types, operation parameters, etc), 
  16. diagram checking for errors, import/export of Delphi code, larger object 
  17. interaction diagrams, new arrow forms, and numerous script variable 
  18. improvements.   Most of all, there are several improvements of speed and 
  19. facility of the user interface.
  20.  
  21. Other new features:
  22.  
  23. 1.  Ability to copy and paste classes into other diagrams
  24. 2.  Ability to label classes as belonging to a certain package
  25. 3.  Zooming to a clip region on the diagram
  26. 4.  Editting attribute and operation names with right mouse menu
  27. 5.  alignment tools to line up your classes as well as a grid feature
  28. 6.  auto-scrolling when dragging objects
  29. 7.  More added fields to WC file
  30. 8.  Added support for the unified method
  31. 9.  A computer tutor to guide you through some of the tricks of using 
  32.     With Class.
  33.  
  34. Look for these new features in December when 4.0 Arrives!!!!
  35.  
  36. 1.  Class repository - store your classes or class packages and retrieve 
  37.     them from Microsoft Access Database.
  38. 2.  Tools Menu-  Add your favorite editors, compilers, and utilities to 
  39.     the With Class menu
  40. 3.  PVCS  support.  
  41. 4.  Crystal Reports-  Generate reports from class information in the 
  42.     repository.
  43. 5.  OLE Automation Utility for using VB scripts to generate code
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51. ***********************************************************
  52. **************************
  53.  Quick Start - Using With Class to Create the OMT Object Model (Class 
  54. Diagram), OMT Dynamic Model (State Diagram), OMT Dynamic Model 
  55. (Object Interaction Diagram), and OMT Functional Model (Operation 
  56. Specification) in With Class
  57.  
  58. by Richard Felsinger 960 Scottland Dr, Mt Pleasant, SC 29464 tele 803-
  59. 881-3648 e-mail 71162.755@compuserve.com. Note: if you don't have 
  60. the exact script listed, use any script with a similar name or download 
  61. latest script from http://www.microgold.com.
  62.  
  63. Creating the Object Model with the Class Diagram in With Class
  64.  
  65. - Start with a system requirements statement, drawing, and block 
  66. diagram.
  67.  
  68. - Create a class diagram, e.g. CARCLASS.OMT.
  69.  
  70. - Enter specification information into the system specification form 
  71. (Draw System) and create the system report, e.g. SYSRPT.TXT by 
  72. running the script RPTSYS.SCT.
  73.  
  74. - Enter specification information into the class specification form.  Create 
  75. the class table, e.g. CLASSTAB.TXT by running the script 
  76. TABCLASS.SCT and importing the table into Microsoft Word.  Create 
  77. the CLASSRPT.TXT by running the script RPTCLASS.SCT.
  78.  
  79. - Enter information into the attribute specification form.  Create the 
  80. attribute table, e.g. ATTRTAB.TXT by running the script 
  81. TABATTR.SCT and importing the table into Microsoft Word. Create the 
  82. ATTRRPT.TXT by running the script RPTATTR.SCT.
  83.  
  84. - Enter information into the operation specification form.  Create the 
  85. operation table, e.g. OPERTAB.TXT by running the script 
  86. TABOPER.SCT and importing the table into Microsoft Word.  Create 
  87. the OPERRPT.TXT by running the script RPTOPER.SCT.  Create the 
  88. detailed operation table, e.g. OPERTAB1.TXT by running the script 
  89. TABOPPRE.SCT and importing the table into Microsoft Word.
  90.  
  91. - Create the relationship table, e.g. RELATAB.TXT by running the script 
  92. TABRELAT.SCT and importing the table into Microsoft Word.
  93.  
  94. - Create the Object Model data dictionary based upon the class diagram, 
  95. e.g. DDCLASS.TXT by running the script DDCLASS.SCT and 
  96. importing the table into Microsoft Word.
  97.  
  98. - Create source code files, e.g. CAR.H and CAR.CPP by running code 
  99. generation scripts, e.g. CPPHEAD0.SCT and CPPFUNC0.SCT.
  100.  
  101. Creating the Dynamic Model with State Diagrams in With Class
  102.  
  103. - Create a state diagram, e.g. CARSTATE.OMT.
  104.  
  105. - Enter specification information into the state and transition 
  106. specification forms.  Create the state transition table, e.g. 
  107. STATETAB.TXT by running the script TABSTATE.SCT and importing 
  108. the table into Microsoft Word.  Create the STATERPT.TXT by running 
  109. the script RPTSTATE.SCT.
  110.  
  111. - Create the Dynamic Model data dictionary based upon the state 
  112. diagram, e.g. DDSTATE.TXT by running the script DDSTATE.SCT and 
  113. importing the table into Microsoft Word.
  114.  
  115. - Create source code files, e.g. CONTROL.H and CONTROL.CPP by 
  116. running code generation scripts, e.g. STAHEAD1.SCT and 
  117. STAFUNC1.SCT.
  118.  
  119. Creating the Dynamic Model with Object Interaction Diagrams in With 
  120. Class
  121.  
  122. - Create an object interaction diagram, e.g. CAROBJ.OMT.
  123.  
  124. - Enter specification information into the object and interaction 
  125. specification forms.  Create the object interaction table, e.g. 
  126. OBJTAB.TXT by running the script TABOBJ.SCT and importing the 
  127. table into Microsoft Word.  Create the OBJPT.TXT by running the script 
  128. RPTOBJ.SCT.
  129.  
  130. - Create the Dynamic Model data dictionary based upon the object 
  131. interaction diagram, e.g. DDOBJ.TXT by running the script 
  132. DDOBJ.SCT and importing the table into Microsoft Word.
  133.  
  134. - Create the Message Sequence Table, e.g. MSGTAB.TXT by running 
  135. the script TABOBMSG.SCT and importing the table into Microsoft 
  136. Word.  Update your source code files by cutting and pasting messages 
  137. into the function definitions.
  138.  
  139. Creating the Functional Object Model with Operation Specifications in 
  140. With Class
  141.  
  142. - Create or update a class diagram, e.g. CARCLASS.OMT.
  143.  
  144. - Update information into the operation specification form.  Create the 
  145. operation table, e.g. OPERTAB.TXT by running the script 
  146. TABOPER.SCT and importing the table into Microsoft Word.  Create 
  147. the OPERRPT.TXT by running the script RPTOPER.SCT.  
  148.  
  149. - Create the detailed operation table, e.g. OPERTAB1.TXT by running 
  150. the script TABOPPRE.SCT and importing the table into Microsoft Word.  
  151.  
  152. - Once all operation transformations, preconditions, postconditions, and 
  153. exceptions have been entered into the operation specification forms, 
  154. regenerate source code files or manually update operations in the source 
  155. code files.
  156.  
  157. Integrating the Models and Source Code
  158.  
  159. - Ensure consistency between the various diagrams and specifications, 
  160. e.g. same named classes and operations.
  161.  
  162. - To integrate source code, start with the generated source code from the 
  163. class diagram, add generated state code from the state transition 
  164. diagrams, add generated message code from the object interaction 
  165. diagrams, and update operation source code with the generated operation 
  166. information (preconditions, transformations, postconditions, and 
  167. exceptions). 
  168.  
  169. ** Report Scripts for Reports, Tables, and Data Dictionaries.
  170. With Class has many scripts to create reports and data dictionaries.  You 
  171. should run these and add/delete script 
  172. statements.  Also, if you want to collect information not in a With Class 
  173. specification, then use an unused field to 
  174. collect the information you desire.  The following are the report scripts 
  175. that may be used with class diagram, e.g. 
  176. cppcar.omt:
  177. RPTALL.SCT - Prints all specification information for the system and 
  178. classes
  179. RPTSYS.SCT - Prints specification information for the system
  180. RPTCLASS.SCT - Prints all specification information about classes
  181. RPTATTR.SCT -  Prints attribute specification information
  182. RPTOPER.SCT - Prints operation specification information
  183. TABCLASS.SCT - Class Table - a comma delineated ASCII file for 
  184. import
  185. TABATTR.SCT - Attribute Table -  a comma delineated ASCII file for 
  186. import
  187. TABOPER.SCT - Operation Table - a comma delineated ASCII file for 
  188. import