netlinx-workspace 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. checksums.yaml +7 -0
  2. data/README.html +0 -0
  3. data/doc/NetLinx/Compile/Extension/APW.html +136 -0
  4. data/doc/NetLinx/Compile/Extension.html +127 -0
  5. data/doc/NetLinx/Compile.html +127 -0
  6. data/doc/NetLinx/Project.html +464 -0
  7. data/doc/NetLinx/System.html +588 -0
  8. data/doc/NetLinx/SystemFile.html +302 -0
  9. data/doc/NetLinx/Workspace.html +445 -0
  10. data/doc/NetLinx.html +131 -0
  11. data/doc/created.rid +7 -0
  12. data/doc/images/add.png +0 -0
  13. data/doc/images/arrow_up.png +0 -0
  14. data/doc/images/brick.png +0 -0
  15. data/doc/images/brick_link.png +0 -0
  16. data/doc/images/bug.png +0 -0
  17. data/doc/images/bullet_black.png +0 -0
  18. data/doc/images/bullet_toggle_minus.png +0 -0
  19. data/doc/images/bullet_toggle_plus.png +0 -0
  20. data/doc/images/date.png +0 -0
  21. data/doc/images/delete.png +0 -0
  22. data/doc/images/find.png +0 -0
  23. data/doc/images/loadingAnimation.gif +0 -0
  24. data/doc/images/macFFBgHack.png +0 -0
  25. data/doc/images/package.png +0 -0
  26. data/doc/images/page_green.png +0 -0
  27. data/doc/images/page_white_text.png +0 -0
  28. data/doc/images/page_white_width.png +0 -0
  29. data/doc/images/plugin.png +0 -0
  30. data/doc/images/ruby.png +0 -0
  31. data/doc/images/tag_blue.png +0 -0
  32. data/doc/images/tag_green.png +0 -0
  33. data/doc/images/transparent.png +0 -0
  34. data/doc/images/wrench.png +0 -0
  35. data/doc/images/wrench_orange.png +0 -0
  36. data/doc/images/zoom.png +0 -0
  37. data/doc/index.html +85 -0
  38. data/doc/js/darkfish.js +155 -0
  39. data/doc/js/jquery.js +18 -0
  40. data/doc/js/navigation.js +142 -0
  41. data/doc/js/search.js +94 -0
  42. data/doc/js/search_index.js +1 -0
  43. data/doc/js/searcher.js +228 -0
  44. data/doc/rdoc.css +595 -0
  45. data/doc/table_of_contents.html +111 -0
  46. data/lib/netlinx/compile/extension/apw.rb +19 -0
  47. data/lib/netlinx/project.rb +83 -0
  48. data/lib/netlinx/system.rb +122 -0
  49. data/lib/netlinx/system_file.rb +36 -0
  50. data/lib/netlinx/workspace.rb +89 -0
  51. data/lib/netlinx-workspace.rb +1 -0
  52. data/license.txt +13 -0
  53. metadata +152 -0
@@ -0,0 +1,464 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class NetLinx::Project - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+
48
+ <div id="file-metadata">
49
+ <nav id="file-list-section" class="section">
50
+ <h3 class="section-header">Defined In</h3>
51
+ <ul>
52
+ <li>lib/netlinx/project.rb
53
+ </ul>
54
+ </nav>
55
+
56
+
57
+ </div>
58
+
59
+ <div id="class-metadata">
60
+
61
+ <nav id="parent-class-section" class="section">
62
+ <h3 class="section-header">Parent</h3>
63
+
64
+ <p class="link">Object
65
+
66
+ </nav>
67
+
68
+
69
+
70
+ <!-- Method Quickref -->
71
+ <nav id="method-list-section" class="section">
72
+ <h3 class="section-header">Methods</h3>
73
+
74
+ <ul class="link-list">
75
+
76
+ <li ><a href="#method-c-new">::new</a>
77
+
78
+ <li ><a href="#method-i-3C-3C">#&lt;&lt;</a>
79
+
80
+ <li ><a href="#method-i-compile">#compile</a>
81
+
82
+ <li ><a href="#method-i-include-3F">#include?</a>
83
+
84
+ <li ><a href="#method-i-to_s">#to_s</a>
85
+
86
+ </ul>
87
+ </nav>
88
+
89
+ </div>
90
+
91
+ <div id="project-metadata">
92
+
93
+ <nav id="classindex-section" class="section project-section">
94
+ <h3 class="section-header">Class and Module Index</h3>
95
+
96
+ <ul class="link-list">
97
+
98
+ <li><a href="../NetLinx.html">NetLinx</a>
99
+
100
+ <li><a href="../NetLinx/Compile.html">NetLinx::Compile</a>
101
+
102
+ <li><a href="../NetLinx/Compile/Extension.html">NetLinx::Compile::Extension</a>
103
+
104
+ <li><a href="../NetLinx/Compile/Extension/APW.html">NetLinx::Compile::Extension::APW</a>
105
+
106
+ <li><a href="../NetLinx/Project.html">NetLinx::Project</a>
107
+
108
+ <li><a href="../NetLinx/System.html">NetLinx::System</a>
109
+
110
+ <li><a href="../NetLinx/SystemFile.html">NetLinx::SystemFile</a>
111
+
112
+ <li><a href="../NetLinx/Workspace.html">NetLinx::Workspace</a>
113
+
114
+ </ul>
115
+ </nav>
116
+
117
+ </div>
118
+ </nav>
119
+
120
+ <div id="documentation">
121
+ <h1 class="class">class NetLinx::Project</h1>
122
+
123
+ <div id="description" class="description">
124
+
125
+ <p>A collection of NeTLinx systems. <a href="Workspace.html">Workspace</a>
126
+ -&gt; <a href="Project.html">Project</a> -&gt; <a
127
+ href="System.html">System</a></p>
128
+
129
+ </div><!-- description -->
130
+
131
+
132
+
133
+
134
+ <section id="5Buntitled-5D" class="documentation-section">
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <!-- Attributes -->
143
+ <section id="attribute-method-details" class="method-section section">
144
+ <h3 class="section-header">Attributes</h3>
145
+
146
+
147
+ <div id="attribute-i-dealer" class="method-detail">
148
+ <div class="method-heading attribute-method-heading">
149
+ <span class="method-name">dealer</span><span
150
+ class="attribute-access-type">[RW]</span>
151
+ </div>
152
+
153
+ <div class="method-description">
154
+
155
+
156
+
157
+ </div>
158
+ </div>
159
+
160
+ <div id="attribute-i-description" class="method-detail">
161
+ <div class="method-heading attribute-method-heading">
162
+ <span class="method-name">description</span><span
163
+ class="attribute-access-type">[RW]</span>
164
+ </div>
165
+
166
+ <div class="method-description">
167
+
168
+
169
+
170
+ </div>
171
+ </div>
172
+
173
+ <div id="attribute-i-designer" class="method-detail">
174
+ <div class="method-heading attribute-method-heading">
175
+ <span class="method-name">designer</span><span
176
+ class="attribute-access-type">[RW]</span>
177
+ </div>
178
+
179
+ <div class="method-description">
180
+
181
+
182
+
183
+ </div>
184
+ </div>
185
+
186
+ <div id="attribute-i-name" class="method-detail">
187
+ <div class="method-heading attribute-method-heading">
188
+ <span class="method-name">name</span><span
189
+ class="attribute-access-type">[RW]</span>
190
+ </div>
191
+
192
+ <div class="method-description">
193
+
194
+
195
+
196
+ </div>
197
+ </div>
198
+
199
+ <div id="attribute-i-purchase_order" class="method-detail">
200
+ <div class="method-heading attribute-method-heading">
201
+ <span class="method-name">purchase_order</span><span
202
+ class="attribute-access-type">[RW]</span>
203
+ </div>
204
+
205
+ <div class="method-description">
206
+
207
+
208
+
209
+ </div>
210
+ </div>
211
+
212
+ <div id="attribute-i-sales_order" class="method-detail">
213
+ <div class="method-heading attribute-method-heading">
214
+ <span class="method-name">sales_order</span><span
215
+ class="attribute-access-type">[RW]</span>
216
+ </div>
217
+
218
+ <div class="method-description">
219
+
220
+
221
+
222
+ </div>
223
+ </div>
224
+
225
+ <div id="attribute-i-systems" class="method-detail">
226
+ <div class="method-heading attribute-method-heading">
227
+ <span class="method-name">systems</span><span
228
+ class="attribute-access-type">[RW]</span>
229
+ </div>
230
+
231
+ <div class="method-description">
232
+
233
+
234
+
235
+ </div>
236
+ </div>
237
+
238
+ <div id="attribute-i-workspace" class="method-detail">
239
+ <div class="method-heading attribute-method-heading">
240
+ <span class="method-name">workspace</span><span
241
+ class="attribute-access-type">[RW]</span>
242
+ </div>
243
+
244
+ <div class="method-description">
245
+
246
+
247
+
248
+ </div>
249
+ </div>
250
+
251
+ </section><!-- attribute-method-details -->
252
+
253
+
254
+ <!-- Methods -->
255
+
256
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
257
+ <h3 class="section-header">Public Class Methods</h3>
258
+
259
+
260
+ <div id="method-c-new" class="method-detail ">
261
+
262
+ <div class="method-heading">
263
+ <span class="method-name">new</span><span
264
+ class="method-args">(**kvargs)</span>
265
+
266
+ <span class="method-click-advice">click to toggle source</span>
267
+
268
+ </div>
269
+
270
+
271
+ <div class="method-description">
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <div class="method-source-code" id="new-source">
279
+ <pre><span class="ruby-comment"># File lib/netlinx/project.rb, line 16</span>
280
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
281
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:name</span>, <span class="ruby-string">&#39;&#39;</span>
282
+ <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:description</span>, <span class="ruby-string">&#39;&#39;</span>
283
+ <span class="ruby-ivar">@dealer</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:dealer</span>, <span class="ruby-string">&#39;&#39;</span>
284
+ <span class="ruby-ivar">@designer</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:designer</span>, <span class="ruby-string">&#39;&#39;</span>
285
+ <span class="ruby-ivar">@sales_order</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:sales_order</span>, <span class="ruby-string">&#39;&#39;</span>
286
+ <span class="ruby-ivar">@purchase_order</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:purchase_order</span>, <span class="ruby-string">&#39;&#39;</span>
287
+ <span class="ruby-ivar">@workspace</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:workspace</span>, <span class="ruby-keyword">nil</span>
288
+
289
+ <span class="ruby-ivar">@systems</span> = []
290
+
291
+ <span class="ruby-identifier">project_element</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:element</span>, <span class="ruby-keyword">nil</span>
292
+ <span class="ruby-identifier">parse_xml_element</span> <span class="ruby-identifier">project_element</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project_element</span>
293
+ <span class="ruby-keyword">end</span></pre>
294
+ </div><!-- new-source -->
295
+
296
+ </div>
297
+
298
+
299
+
300
+
301
+ </div><!-- new-method -->
302
+
303
+
304
+ </section><!-- public-class-method-details -->
305
+
306
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
307
+ <h3 class="section-header">Public Instance Methods</h3>
308
+
309
+
310
+ <div id="method-i-3C-3C" class="method-detail ">
311
+
312
+ <div class="method-heading">
313
+ <span class="method-name">&lt;&lt;</span><span
314
+ class="method-args">(system)</span>
315
+
316
+ <span class="method-click-advice">click to toggle source</span>
317
+
318
+ </div>
319
+
320
+
321
+ <div class="method-description">
322
+
323
+ <p>Alias to add a system.</p>
324
+
325
+
326
+
327
+
328
+ <div class="method-source-code" id="3C-3C-source">
329
+ <pre><span class="ruby-comment"># File lib/netlinx/project.rb, line 32</span>
330
+ <span class="ruby-keyword">def</span> <span class="ruby-operator">&lt;&lt;</span>(<span class="ruby-identifier">system</span>)
331
+ <span class="ruby-ivar">@systems</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">system</span>
332
+ <span class="ruby-identifier">system</span>.<span class="ruby-identifier">project</span> = <span class="ruby-keyword">self</span>
333
+ <span class="ruby-keyword">end</span></pre>
334
+ </div><!-- 3C-3C-source -->
335
+
336
+ </div>
337
+
338
+
339
+
340
+
341
+ </div><!-- 3C-3C-method -->
342
+
343
+
344
+ <div id="method-i-compile" class="method-detail ">
345
+
346
+ <div class="method-heading">
347
+ <span class="method-name">compile</span><span
348
+ class="method-args">()</span>
349
+
350
+ <span class="method-click-advice">click to toggle source</span>
351
+
352
+ </div>
353
+
354
+
355
+ <div class="method-description">
356
+
357
+ <p><a href="Compile.html">Compile</a> all systems in this project.</p>
358
+
359
+
360
+
361
+
362
+ <div class="method-source-code" id="compile-source">
363
+ <pre><span class="ruby-comment"># File lib/netlinx/project.rb, line 55</span>
364
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">compile</span>
365
+ <span class="ruby-identifier">compiler_results</span> = []
366
+ <span class="ruby-ivar">@systems</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">system</span><span class="ruby-operator">|</span> <span class="ruby-identifier">compiler_results</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">system</span>.<span class="ruby-identifier">compile</span>).<span class="ruby-identifier">first</span>}
367
+ <span class="ruby-identifier">compiler_results</span>
368
+ <span class="ruby-keyword">end</span></pre>
369
+ </div><!-- compile-source -->
370
+
371
+ </div>
372
+
373
+
374
+
375
+
376
+ </div><!-- compile-method -->
377
+
378
+
379
+ <div id="method-i-include-3F" class="method-detail ">
380
+
381
+ <div class="method-heading">
382
+ <span class="method-name">include?</span><span
383
+ class="method-args">(file)</span>
384
+
385
+ <span class="method-click-advice">click to toggle source</span>
386
+
387
+ </div>
388
+
389
+
390
+ <div class="method-description">
391
+
392
+ <p>Returns true if the project contains the specified file.</p>
393
+
394
+
395
+
396
+
397
+ <div class="method-source-code" id="include-3F-source">
398
+ <pre><span class="ruby-comment"># File lib/netlinx/project.rb, line 43</span>
399
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">file</span>)
400
+ <span class="ruby-identifier">included</span> = <span class="ruby-keyword">false</span>
401
+
402
+ <span class="ruby-identifier">systems</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">system</span><span class="ruby-operator">|</span>
403
+ <span class="ruby-identifier">included</span> = <span class="ruby-identifier">system</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">file</span>
404
+ <span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">included</span>
405
+ <span class="ruby-keyword">end</span>
406
+
407
+ <span class="ruby-identifier">included</span>
408
+ <span class="ruby-keyword">end</span></pre>
409
+ </div><!-- include-3F-source -->
410
+
411
+ </div>
412
+
413
+
414
+
415
+
416
+ </div><!-- include-3F-method -->
417
+
418
+
419
+ <div id="method-i-to_s" class="method-detail ">
420
+
421
+ <div class="method-heading">
422
+ <span class="method-name">to_s</span><span
423
+ class="method-args">()</span>
424
+
425
+ <span class="method-click-advice">click to toggle source</span>
426
+
427
+ </div>
428
+
429
+
430
+ <div class="method-description">
431
+
432
+ <p>Returns the project name.</p>
433
+
434
+
435
+
436
+
437
+ <div class="method-source-code" id="to_s-source">
438
+ <pre><span class="ruby-comment"># File lib/netlinx/project.rb, line 38</span>
439
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
440
+ <span class="ruby-ivar">@name</span>
441
+ <span class="ruby-keyword">end</span></pre>
442
+ </div><!-- to_s-source -->
443
+
444
+ </div>
445
+
446
+
447
+
448
+
449
+ </div><!-- to_s-method -->
450
+
451
+
452
+ </section><!-- public-instance-method-details -->
453
+
454
+ </section><!-- 5Buntitled-5D -->
455
+
456
+ </div><!-- documentation -->
457
+
458
+
459
+ <footer id="validator-badges">
460
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
461
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
462
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
463
+ </footer>
464
+