-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcomponent.html
More file actions
502 lines (458 loc) · 24.2 KB
/
Copy pathcomponent.html
File metadata and controls
502 lines (458 loc) · 24.2 KB
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Component — roco 1.0 documentation</title>
<link rel="stylesheet" href="_staticclassic.css" type="text/css" />
<link rel="stylesheet" href="_staticpygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_staticjquery.js"></script>
<script type="text/javascript" src="_staticunderscore.js"></script>
<script type="text/javascript" src="_staticdoctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Composable" href="composable.html" />
<link rel="prev" title="Parameterized" href="parameterized.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="composable.html" title="Composable"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="parameterized.html" title="Parameterized"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">roco 1.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="code.html" accesskey="U">roco.api</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="component">
<h1>Component<a class="headerlink" href="#component" title="Permalink to this headline">¶</a></h1>
<span class="target" id="module-api.component"></span><p>Component class and helper function.</p>
<p>This module contains the Component class, as well as a helper function to load
components.</p>
<dl class="class">
<dt id="api.component.Component">
<em class="property">class </em><code class="descclassname">api.component.</code><code class="descname">Component</code><span class="sig-paren">(</span><em>yaml_file=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component" title="Permalink to this definition">¶</a></dt>
<dd><p>The base class that all components derive from.</p>
<p>A component is an abstract representation of an element of a device.</p>
<dl class="docutils">
<dt>Attributes:</dt>
<dd><dl class="first docutils">
<dt>subcomponents (dict): dictionary of component objects that make up the</dt>
<dd>overall component where the key is the name.</dd>
<dt>connections (list): list of connection definitions from an interface</dt>
<dd>to another interface with arguments associated.</dd>
</dl>
<p>interfaces (dict): dictionary of interfaces where the key is the name
composables (OrderedDict): an ordered dictionary of composables that</p>
<blockquote class="last">
<div>define the output of the component.</div></blockquote>
</dd>
</dl>
<dl class="method">
<dt id="api.component.Component.add_connection">
<code class="descname">add_connection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.add_connection" title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies interfaces on subcomponents to be connected</p>
<dl class="docutils">
<dt>Args:</dt>
<dd><dl class="first last docutils">
<dt>(from_name, from_interface) (tuple(str, str)): a tuple containing the name of the subcomponent, and the</dt>
<dd>name of the interface the connection comes from</dd>
<dt>(to_name, to_interface) (tuple(str, str)): a tuple containing the name of the subcomponent, and the</dt>
<dd>name of the interface the connection goes to</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.add_interface">
<code class="descname">add_interface</code><span class="sig-paren">(</span><em>name</em>, <em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.add_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds an interface to this component.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): unique identifier for interface that will be added to the component.
val (Port): the value that the new interface takes on.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.add_parameter_constraint">
<code class="descname">add_parameter_constraint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.add_parameter_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>Constraints subcomponent parameter.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd><dl class="first docutils">
<dt>(subcomponent, parameter_name) (tuple(str,str)): a tuple representing a subcomponent a related parameter</dt>
<dd>to constrain.</dd>
</dl>
<p class="last">constraint (Number or sympy expression): the constraint to impose on the subcomponent parameter.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.add_subcomponent">
<code class="descname">add_subcomponent</code><span class="sig-paren">(</span><em>name</em>, <em>object_type</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.add_subcomponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a subcomponent to this Component.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): unique identifier to refer to this subcomponent by
object_type (str or type): code name of the subcomponent should be python file/class or yaml name</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>name</em>, <em>prefix</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.append" title="Permalink to this definition">¶</a></dt>
<dd><p>Appends composables on each of the subcomponents to composable on current component</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): name of subcomponent
prefix (str):</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.assemble">
<code class="descname">assemble</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.assemble" title="Permalink to this definition">¶</a></dt>
<dd><p>Assembles the component</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.attach">
<code class="descname">attach</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.attach" title="Permalink to this definition">¶</a></dt>
<dd><p>Attaches the specified ports on the subcomponents</p>
<dl class="docutils">
<dt>Args:</dt>
<dd><dl class="first last docutils">
<dt>(from_name, from_port) (tuple(str, str)): a tuple containing the name of the subcomponent, and the interface</dt>
<dd>on the component to attach from</dd>
<dt>(to_name, to_port) (tuple(str, str)): a tuple containing the name of the subcomponent, and the interface</dt>
<dd>on the component to attach to</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.define">
<code class="descname">define</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.define" title="Permalink to this definition">¶</a></dt>
<dd><p>Function for overriding interfaces.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd><a href="#id1"><span class="problematic" id="id2">**</span></a>kwargs: Arbitrary keyword arguments</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.del_interface">
<code class="descname">del_interface</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.del_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an interface from this component.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): unique identifier for interface that will be deleted from the component.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.del_subcomponent">
<code class="descname">del_subcomponent</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.del_subcomponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a subcomponent to this Component and performs any cleanup necessary</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): unique identifier of subcomponent to delete</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.eval_connections">
<code class="descname">eval_connections</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.eval_connections" title="Permalink to this definition">¶</a></dt>
<dd><p>Attaches each of the ports between which a connection was made</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.eval_constraints">
<code class="descname">eval_constraints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.eval_constraints" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates all the constraints imposed on subcomponents</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>None</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.eval_interfaces">
<code class="descname">eval_interfaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.eval_interfaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds interfaces to composables</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.eval_subcomponents">
<code class="descname">eval_subcomponents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.eval_subcomponents" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates composables in current component based on composables in each of the subcomponents, then
appends composables in subcomponents to corresponding composable in component</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.get_all_defaults">
<code class="descname">get_all_defaults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.get_all_defaults" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a dictionary of default values for the parameters including the ones from the subcomponents</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>None</dd>
<dt>Returns:</dt>
<dd>A dictionary relating parameter names to parameter values.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.get_defaults">
<code class="descname">get_defaults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.get_defaults" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a dictionary of default values for the parameters</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>None</dd>
<dt>Returns:</dt>
<dd>A dictionary relating parameter names to parameter values.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.get_interface">
<code class="descname">get_interface</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.get_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a interface of this component</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): name of the interface to return</dd>
<dt>Returns:</dt>
<dd>the interface with name ‘name’</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.get_subcomponent">
<code class="descname">get_subcomponent</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.get_subcomponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns specified subcomponent of the component</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): name of the subcomponent to return</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.get_subcomponent_interface">
<code class="descname">get_subcomponent_interface</code><span class="sig-paren">(</span><em>component</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.get_subcomponent_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a subcomponent interface</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>component (str): name of the subcomponent
name (str): name of the interface in that subcomponent</dd>
<dt>Returns:</dt>
<dd>the interface belonging to ‘component’ with name ‘name’</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.inherit_all_interfaces">
<code class="descname">inherit_all_interfaces</code><span class="sig-paren">(</span><em>subcomponent</em>, <em>prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.inherit_all_interfaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds all interfaces from subcomponent to current component</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>subcomponent (Component): Component object from which all the interfaces will be inherited.
prefix (str): name of component, will automatically work if ignored or left as “” (an empty string).</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.inherit_constraints">
<code class="descname">inherit_constraints</code><span class="sig-paren">(</span><em>subcomponent</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.inherit_constraints" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits the constraints from a subcomponent</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>subcomponent (str): name of subcomponent to inherit from</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.inherit_interface">
<code class="descname">inherit_interface</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.inherit_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds specified interface from subcomponent to current component</p>
<dl class="docutils">
<dt>Args:</dt>
<dd><p class="first">name (str): New unique identifier for the interface that will be inherited.
(subcomponent, subname) (tuple(Component, str)): Component object from which the specified interface</p>
<blockquote class="last">
<div>will be inherited, and the name of the interface that is to be inherited from the subcomponent</div></blockquote>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.make">
<code class="descname">make</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.make" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates subcomponents, connections, and constraints, then assembles the component</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.make_component_hierarchy">
<code class="descname">make_component_hierarchy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.make_component_hierarchy" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates and returns a hierarchical representation of the component.</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.make_component_tree">
<code class="descname">make_component_tree</code><span class="sig-paren">(</span><em>file_name</em>, <em>tree_name='Root'</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.make_component_tree" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a image depicting the component tree</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>file_name (str): filename to write image to
tree_name (str): name of the tree</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.make_output">
<code class="descname">make_output</code><span class="sig-paren">(</span><em>file_dir='.'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.make_output" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates output based on the kwargs</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>file_dir (str): directory to store output
kwargs (dict): arguments dictating which output to make</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.recurse_component_tree">
<code class="descname">recurse_component_tree</code><span class="sig-paren">(</span><em>graph</em>, <em>my_node</em>, <em>my_name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.recurse_component_tree" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function to recurse down component tree to create it</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>graph (pydot.Dot): graph to add all the nodes to.
my_node (pydot.Node): current node that is being added and will be recursed upon.
my_name (str): name of the tree.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Resets component to a state before make is called.</p>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.resolve_subcomponent">
<code class="descname">resolve_subcomponent</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.resolve_subcomponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates subcomponent object and adds it to the current component</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name: name of subcomponent to be created</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.resolve_subcomponents">
<code class="descname">resolve_subcomponents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.resolve_subcomponents" title="Permalink to this definition">¶</a></dt>
<dd><p>Calls resolve_subcomponent on all subcomponents</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>None</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.set_interface">
<code class="descname">set_interface</code><span class="sig-paren">(</span><em>name</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.set_interface" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets a interface as passed in</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>name (str): name of the interface to set
value: the value to set the interface to</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.set_subcomponent_parameter">
<code class="descname">set_subcomponent_parameter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.set_subcomponent_parameter" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets parameter of subcomponent to the specified value</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>(subcomponent, parameter) (tuple (str, str)): name of subcomponent, and name of parameter to modify
value: Value of the parameter</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="api.component.Component.to_yaml">
<code class="descname">to_yaml</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.Component.to_yaml" title="Permalink to this definition">¶</a></dt>
<dd><p>Generates YAML file containing component information</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>filename (str): name of the yaml file to be generated</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="api.component.get_subcomponent_object">
<code class="descclassname">api.component.</code><code class="descname">get_subcomponent_object</code><span class="sig-paren">(</span><em>component</em>, <em>name=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#api.component.get_subcomponent_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to generate an instantiated component from the class name.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>component (str): The name of the component class to instantiate.
name (<code class="xref py py-obj docutils literal"><span class="pre">str</span></code>, optional): The name to set for the component.
<a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs: Arbitrary keyword arguments to pass into the constructor.</dd>
<dt>Returns:</dt>
<dd>The instantiated component.</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="parameterized.html"
title="previous chapter">Parameterized</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="composable.html"
title="next chapter">Composable</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/component.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="composable.html" title="Composable"
>next</a> |</li>
<li class="right" >
<a href="parameterized.html" title="Parameterized"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">roco 1.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="code.html" >roco.api</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Gopi Suresh, Ahmed Allibhoy, Christian Warloe, Prathyush Katukojwala.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
</div>
</body>
</html>