home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Developer / resources / classes / CompSim.README < prev    next >
Encoding:
Text File  |  1992-01-08  |  3.1 KB  |  89 lines
  1.                 CompSim
  2.                 
  3.             by Gregor N. Purdy, 1991
  4.             
  5.      A set of classes for simulating Digital Logic (especially
  6.                  for computers)
  7.                  
  8.         Copyright 1991, 1992 by Contemporary Design Studios.
  9.  
  10.  
  11. 0.0    Warning!
  12.  
  13.     This software is not even Alpha software, since I had to write it
  14.     so quickly. You may be sure that there will be bugs, but I hope
  15.     you find it useful. In fact, I'd like to hear about bugs so that
  16.     I can fix them and make this package more useful.
  17.     
  18.     I will not be held responsible for any damages, whether direct or
  19.     indirect as a result of your using this software.
  20.  
  21.  
  22. 1.0    General Info
  23.  
  24.     CompSim is a set of classes I wrote for simulating a
  25.     computer for a class (EECS 370 at The University of Michigan).
  26.     I cannot guarantee they function correctly, but most of them
  27.     seemed to work.
  28.     
  29.     
  30.     However, you are hereby granted permission to use and abuse this
  31.     code, whether for commercial or non-commercial use, provided you
  32.     credit me in your documentation and info panel, and you must also
  33.     put in my copyright line above. Note, however, that future, more
  34.     useful, versions *may* not be so relaxed in distribution rules,
  35.     depending on how much more time I put into it.
  36.  
  37.  
  38. 2.0    Purpose In Life
  39.  
  40.     CompSim exists to make life easier (hopefully) for people who wish
  41.     to simulate digital logic systems. I wrote it because I had to do just
  42.     that for a class I was taking (see 1.0, General Info, above). It is my
  43.     hope that someone else out there who does such things will find this
  44.     software useful.
  45.     
  46.     CompSim simulates things at a fairly low level. For instance, some of
  47.     the classes here use instances of the other classes to accomplish
  48.     their tasks, even though it would have been more efficient to do
  49.     otherwise. The reason for this (See Timer, for an example) is that I
  50.     wanted the higher-level functions to be fairly true to an actual
  51.     circuit.
  52.     
  53.     Some high-level classes, like Memory, simulate the subsystem instead of
  54.     the circuitry because it would be altogether too slow otherwise.
  55.     
  56.     
  57. 3.0    Using CompSim
  58.  
  59.     Read the descriptions in the header files!
  60.  
  61.     To use CompSim in a program, you should create a class which will model
  62.     your device. Have it instantiate whatever Nodes are needed to connect
  63.     the devices it contains, then instantiate the devices, connecting them
  64.     to the nodes. The cycle method of your new object should send cycle
  65.     messages to all the devices necessary to accomplish the circuits function,
  66.     in an appropriate order, considering signal propagation.
  67.     
  68.     Now, in your main program, simply instantiate one of your circuit objects,
  69.     and send it cycle messages. Provide yourself methods and such for whatever
  70.     sorts of intermediate output you'll need, and away you go!
  71.     
  72.     Be sure to free everything when you're done, like a good programmer :-).
  73.     
  74.     That's it! Good luck, and let me know if you find this useful, or
  75.     whatever.
  76.  
  77.  
  78. 4.0    Other Information Available
  79.  
  80.     When I developed CompSim, I drew diagrams on my Macintosh (yech!) of the
  81.     higher  level devices (like Timer and IndexRegister). These will be
  82.     available later, when I have time to get them into a NeXT-friendly
  83.     format. Let me know if you want them...
  84.  
  85.  
  86. --Gregor N. Purdy
  87. gregor@oit.itd.umich.edu
  88.  
  89.