forked from akeshet/Cicero-Word-Generator
/
Code Overview.htm
267 lines (252 loc) · 11.7 KB
/
Code Overview.htm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns:st1="urn:schemas-microsoft-com:office:smarttags"
xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv=Content-Type content="text/html; charset=us-ascii">
<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 10">
<meta name=Originator content="Microsoft Word 10">
<link rel=File-List href="Code%20Overview_files/filelist.xml">
<title>Untitled Page</title>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="City"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="place"/>
<!--[if gte mso 9]><xml>
<o:DocumentProperties>
<o:Author> Aviv Keshet</o:Author>
<o:LastAuthor> Aviv Keshet</o:LastAuthor>
<o:Revision>2</o:Revision>
<o:TotalTime>4</o:TotalTime>
<o:Created>2009-02-25T18:52:00Z</o:Created>
<o:LastSaved>2009-02-25T18:56:00Z</o:LastSaved>
<o:Pages>1</o:Pages>
<o:Words>450</o:Words>
<o:Characters>2568</o:Characters>
<o:Company>MIT</o:Company>
<o:Lines>21</o:Lines>
<o:Paragraphs>6</o:Paragraphs>
<o:CharactersWithSpaces>3012</o:CharactersWithSpaces>
<o:Version>10.2625</o:Version>
</o:DocumentProperties>
</xml><![endif]--><!--[if gte mso 9]><xml>
<w:WordDocument>
<w:SpellingState>Clean</w:SpellingState>
<w:GrammarState>Clean</w:GrammarState>
<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>
</w:WordDocument>
</xml><![endif]--><!--[if !mso]><object
classid="clsid:38481807-CA0E-42D2-BF39-B33AF135CC4D" id=ieooui></object>
<style>
st1\:*{behavior:url(#ieooui) }
</style>
<![endif]-->
<style>
<!--
/* Font Definitions */
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;
mso-font-charset:2;
mso-generic-font-family:auto;
mso-font-pitch:variable;
mso-font-signature:0 268435456 0 0 -2147483648 0;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{mso-style-parent:"";
margin:0in;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:12.0pt;
font-family:"Times New Roman";
mso-fareast-font-family:"Times New Roman";}
p
{font-size:12.0pt;
font-family:"Times New Roman";
mso-fareast-font-family:"Times New Roman";}
span.SpellE
{mso-style-name:"";
mso-spl-e:yes;}
span.GramE
{mso-style-name:"";
mso-gram-e:yes;}
@page Section1
{size:8.5in 11.0in;
margin:1.0in 1.25in 1.0in 1.25in;
mso-header-margin:.5in;
mso-footer-margin:.5in;
mso-paper-source:0;}
div.Section1
{page:Section1;}
/* List Definitions */
@list l0
{mso-list-id:767581221;
mso-list-template-ids:-1675704038;}
@list l0:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l1
{mso-list-id:1540822552;
mso-list-type:hybrid;
mso-list-template-ids:1965852976 -1403352194 67698691 67698693 67698689 67698691 67698693 67698689 67698691 67698693;}
@list l1:level1
{mso-level-number-format:bullet;
mso-level-text:\F0A8;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
font-family:Wingdings;}
@list l2
{mso-list-id:2144156883;
mso-list-template-ids:1438040878;}
@list l2:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
-->
</style>
<!--[if gte mso 10]>
<style>
/* Style Definitions */
table.MsoNormalTable
{mso-style-name:"Table Normal";
mso-tstyle-rowband-size:0;
mso-tstyle-colband-size:0;
mso-style-noshow:yes;
mso-style-parent:"";
mso-padding-alt:0in 5.4pt 0in 5.4pt;
mso-para-margin:0in;
mso-para-margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:10.0pt;
font-family:"Times New Roman";}
</style>
<![endif]--><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="2050"/>
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1"/>
</o:shapelayout></xml><![endif]-->
</head>
<body lang=EN-US style='tab-interval:.5in'>
<div class=Section1>
<p class=MsoNormal style='margin-bottom:12.0pt'>This "solution"
contains several main "projects": </p>
<ul type=disc>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l2 level1 lfo1;tab-stops:list .5in'><span class=SpellE>Atticus</span>:
<span class=SpellE>Atticus</span> is the hardware server program. This
project contains all of the UI code for the server, and all of the
hardware side code.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l2 level1 lfo1;tab-stops:list .5in'><st1:City><st1:place>Cicero</st1:place></st1:City>:
<st1:City><st1:place>Cicero</st1:place></st1:City> is the client-side
program. This project contains all of the UI code for designing sequences,
as well as some code for sending those sequences to the server.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l2 level1 lfo1;tab-stops:list .5in'><span class=SpellE>DataStructures</span>:
This project does not contain any <span class=SpellE>executible</span>.
Instead, it contains class definitions for all of the classes use to
describe and store sequences.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l2 level1 lfo1;tab-stops:list .5in'><st1:City><st1:place>Elgin</st1:place></st1:City>:
This is a simple <span class=SpellE>RunLog</span> viewing program, to view
the <span class=SpellE>RunLogs</span> produced by <st1:City><st1:place>Cicero</st1:place></st1:City>.
It may eventually be extended to do things like batch processing.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l2 level1 lfo1;tab-stops:list .5in'><span class=SpellE><span
class=GramE>dotMath</span></span>: Written by Stephen <span class=SpellE>Herbet</span>,
this project provides the libraries used to parse equations.</li>
</ul>
<p> </p>
<p>Some of the key important files, perhaps worth looking at first in getting
acquainted with the code:</p>
<ul type=disc>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'><span class=SpellE>Atticus/ServerRuntime/AtticusServerCommunicator.cs</span>:
This file is the main server object. It receives requests over .NET <span
class=SpellE>remoting</span> (interface defined by <span class=SpellE>ServerCommunicator</span>),
detects hardware channels, creates buffers and triggers.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'><span class=SpellE>Atticus/AtticusServer.cs</span>:
Entry point for the <span class=SpellE><span class=GramE>atticus</span></span>
<span class=SpellE>executible</span>.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>Atticus/Form1.cs: Top level
user interface for <st1:City><st1:place>Cicero</st1:place></st1:City>.
Best viewed with <span class=SpellE>VisualStudio</span> designer.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>Cicero/Controls/<span
class=SpellE>MainClientForm.cs</span>: The top-level user interface for <st1:City><st1:place>Cicero</st1:place></st1:City>.
Most of the guts of the user interface <span class=GramE>resides</span> in
sub-controls of this. The easiest way to understand this code is by
viewing it with <span class=SpellE>VisualStudio's</span> designer.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>Cicero/<span class=SpellE>Program.cs</span>:
entry point for <st1:City><st1:place>Cicero</st1:place></st1:City>.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>Cicero/Controls/<span
class=SpellE>RunForm.cs</span>: A user interface object which displays a
progress bar during a run. <span class=SpellE>RunForm</span> also has
makes all of the appropriate calls to <span class=SpellE>servermanager</span>
to send sequence <span class=SpellE>objeects</span>, settings objects, and
start runs.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>Cicero/<span class=SpellE>Storage.cs</span>:
Contains static references to the <span class=SpellE>settingsdata</span>
and <span class=SpellE>sequencedata</span> objects being edited, as well
as methods for loading and saving.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'><span class=SpellE>DataStructures/SequenceData/SequenceData.cs</span>:
The class which stores a sequence. This class is effectively
"edited" by <st1:City><st1:place>Cicero</st1:place></st1:City>,
and then sent (along with <span class=SpellE>SettingsData</span>) to the
servers, which turn the <span class=SpellE>SequenceData</span> object into
output buffers.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'><span class=SpellE>DataStructures/SettingsData/SettingsData.cs</span>:
The class which stores "settings". This includes mapping from
channel ID integers to Hardware channels (thorough <span class=SpellE>LogicalChannelManager</span>),
<span class=SpellE>addressess</span> of servers</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'><span class=SpellE>DataStructures/Communication/ServerManager/ServerManager.cs</span>:
Contains a lot of client-server communication code.</li>
</ul>
<p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><o:p> </o:p></p>
<p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'>In
addition, there are two directories containing software and code related to
FPGA support:</p>
<ul type=disc>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>AvivFPGA2: This contains the <span
class=SpellE>verilog</span> code which is used to generate the .bit files
for programming <span class=SpellE>Xilinx</span> FPGA boards for the
Variable <span class=SpellE>Timebase</span> synthesis feature. This code
is developed in the <span class=SpellE>Xilinx</span> ISE Design Suite
10.1, which is available for free download from <span class=SpellE>Xilinx</span>.</li>
<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l0 level1 lfo2;tab-stops:list .5in'>Opal Kelly: This directory
contains a driver installer for Opal Kelly USB-based FPGA prototype
modules. It also contains the compiled .bit files used for programming the
FPGA. </li>
</ul>
<p> </p>
</div>
</body>
</html>