/
builtins.html
517 lines (350 loc) · 27.5 KB
/
builtins.html
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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Enumeration — Revit Python Wrapper 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Revit Python Wrapper 1.0.0 documentation" href="index.html"/>
<link rel="next" title="Forms" href="forms.html"/>
<link rel="prev" title="Geometry" href="geometry.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Revit Python Wrapper
</a>
<div class="version">
1.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Revit Python Wrapper</a></li>
<li class="toctree-l1"><a class="reference internal" href="revit.html">Revit</a></li>
<li class="toctree-l1"><a class="reference internal" href="base.html">Base Wrapper</a></li>
<li class="toctree-l1"><a class="reference internal" href="element.html">Element Wrappers</a></li>
<li class="toctree-l1"><a class="reference internal" href="selection.html">Selection</a></li>
<li class="toctree-l1"><a class="reference internal" href="transaction.html">Transaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="collector.html">Collector</a></li>
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Geometry</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Enumeration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#implementation">Implementation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamo.html">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests.html">Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="known_issues.html">Known Issues</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Revit Python Wrapper</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Enumeration</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/builtins.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-rpw.db.builtins">
<span id="enumeration"></span><h1>Enumeration<a class="headerlink" href="#module-rpw.db.builtins" title="Permalink to this headline">¶</a></h1>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">BipEnum</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WALL_LOCATION_LINE'</span><span class="p">)</span>
<span class="go">Revit.DB.BuiltInParameter.WALL_LOCATION_LINE</span>
<span class="gp">>>> </span><span class="n">BipEnum</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="s1">'WALL_LOCATION_LINE'</span><span class="p">)</span>
<span class="go">Revit.DB.ElementId</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These classes were originally create to be used internally,
but are documented here as some it’s functionalities can be
helpful.</p>
</div>
<hr class="docutils" />
<dl class="class">
<dt id="rpw.db.builtins.BiCategory">
<em class="property">class </em><code class="descclassname">rpw.db.builtins.</code><code class="descname">BiCategory</code><a class="headerlink" href="#rpw.db.builtins.BiCategory" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="base.html#rpw.base.BaseObjectWrapper" title="rpw.base.BaseObjectWrapper"><code class="xref py py-class docutils literal"><span class="pre">rpw.base.BaseObjectWrapper</span></code></a></p>
<p>Enumeration Wrapper</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">BicEnum</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'OST_Rooms'</span><span class="p">)</span>
<span class="go">Revit.DB.BuiltInCategory.OST_Rooms</span>
<span class="gp">>>> </span><span class="n">BicEnum</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="s1">'OST_Rooms'</span><span class="p">)</span>
<span class="go">Revit.DB.ElementId</span>
<span class="gp">>>> </span><span class="n">BicEnum</span><span class="o">.</span><span class="n">from_category_id</span><span class="p">(</span><span class="n">furniture</span><span class="o">.</span><span class="n">Category</span><span class="o">.</span><span class="n">Id</span><span class="p">)</span>
<span class="go">DB.BuiltInCategory.OST_Furniture</span>
</pre></div>
</div>
<dl class="method">
<dt id="rpw.db.builtins.BiCategory.from_category_id">
<code class="descname">from_category_id</code><span class="sig-paren">(</span><em>category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.builtins.BiCategory.from_category_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Casts <code class="docutils literal"><span class="pre">DB.BuiltInCategory</span></code> Enumeration member from a Category ElementId</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>category_id</strong> (<code class="docutils literal"><span class="pre">DB.ElementId</span></code>) – ElementId reference of a category</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal"><span class="pre">DB.BuiltInCategory</span></code> member</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="rpw.db.builtins.BiCategory.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>category_name</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.builtins.BiCategory.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets Built In Category by Name</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> – Name of Category</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">BuiltInCategory Enumeration Member</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal"><span class="pre">DB.BuiltInCategory</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="rpw.db.builtins.BiCategory.get_id">
<code class="descname">get_id</code><span class="sig-paren">(</span><em>category_name</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.builtins.BiCategory.get_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets ElementId of Category by name</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> – Name of Category</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">BuiltInCategory Enumeration Member</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal"><span class="pre">DB.BuiltInCategory</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="rpw.db.builtins.BiParameter">
<em class="property">class </em><code class="descclassname">rpw.db.builtins.</code><code class="descname">BiParameter</code><a class="headerlink" href="#rpw.db.builtins.BiParameter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="base.html#rpw.base.BaseObjectWrapper" title="rpw.base.BaseObjectWrapper"><code class="xref py py-class docutils literal"><span class="pre">rpw.base.BaseObjectWrapper</span></code></a></p>
<p>BuiltInParameter Wrapper</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">BipEnum</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WALL_LOCATION_LINE'</span><span class="p">)</span>
<span class="go">Revit.DB.BuiltInParameter.WALL_LOCATION_LINE</span>
<span class="gp">>>> </span><span class="n">BipEnum</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="s1">'WALL_LOCATION_LINE'</span><span class="p">)</span>
<span class="go">Revit.DB.ElementId</span>
</pre></div>
</div>
<dl class="method">
<dt id="rpw.db.builtins.BiParameter.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>parameter_name</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.builtins.BiParameter.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets Built In Parameter by Name</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> – Name of Parameter</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">BuiltInParameter Enumeration Member</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal"><span class="pre">DB.BuiltInParameter</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="rpw.db.builtins.BiParameter.get_id">
<code class="descname">get_id</code><span class="sig-paren">(</span><em>parameter_name</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.builtins.BiParameter.get_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets ElementId of Category by name</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parameter_name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Name of Built In Parameter</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">BuiltInParameter Enumeration Member</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal"><span class="pre">DB.BuitInParameter</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<hr class="docutils" />
<div class="section" id="implementation">
<h2>Implementation<a class="headerlink" href="#implementation" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">rpw</span> <span class="k">import</span> <span class="n">revit</span><span class="p">,</span> <span class="n">DB</span>
<span class="kn">from</span> <span class="nn">rpw.base</span> <span class="k">import</span> <span class="n">BaseObject</span><span class="p">,</span> <span class="n">BaseObjectWrapper</span>
<span class="kn">from</span> <span class="nn">rpw.utils.dotnet</span> <span class="k">import</span> <span class="n">Enum</span>
<span class="kn">from</span> <span class="nn">rpw.exceptions</span> <span class="k">import</span> <span class="n">RpwCoerceError</span>
<span class="k">class</span> <span class="nc">BiParameter</span><span class="p">(</span><span class="n">BaseObjectWrapper</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> BuiltInParameter Wrapper</span>
<span class="sd"> >>> BipEnum.get('WALL_LOCATION_LINE')</span>
<span class="sd"> Revit.DB.BuiltInParameter.WALL_LOCATION_LINE</span>
<span class="sd"> >>> BipEnum.get_id('WALL_LOCATION_LINE')</span>
<span class="sd"> Revit.DB.ElementId</span>
<span class="sd"> """</span>
<span class="n">_revit_object_class</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="n">BuiltInParameter</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BiParameter</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">DB</span><span class="o">.</span><span class="n">BuiltInParameter</span><span class="p">,</span>
<span class="n">enforce_type</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameter_name</span><span class="p">):</span>
<span class="sd">""" Gets Built In Parameter by Name</span>
<span class="sd"> Args:</span>
<span class="sd"> ``str``: Name of Parameter</span>
<span class="sd"> Returns:</span>
<span class="sd"> ``DB.BuiltInParameter``: BuiltInParameter Enumeration Member</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">enum</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">DB</span><span class="o">.</span><span class="n">BuiltInParameter</span><span class="p">,</span> <span class="n">parameter_name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RpwCoerceError</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">,</span> <span class="n">DB</span><span class="o">.</span><span class="n">BuiltInParameter</span><span class="p">)</span>
<span class="k">return</span> <span class="n">enum</span>
<span class="k">def</span> <span class="nf">get_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameter_name</span><span class="p">):</span>
<span class="sd">""" Gets ElementId of Category by name</span>
<span class="sd"> Args:</span>
<span class="sd"> parameter_name(``str``): Name of Built In Parameter</span>
<span class="sd"> Returns:</span>
<span class="sd"> ``DB.BuitInParameter``: BuiltInParameter Enumeration Member</span>
<span class="sd"> """</span>
<span class="n">enum</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DB</span><span class="o">.</span><span class="n">ElementId</span><span class="p">(</span><span class="n">enum</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">BiCategory</span><span class="p">(</span><span class="n">BaseObjectWrapper</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Enumeration Wrapper</span>
<span class="sd"> >>> BicEnum.get('OST_Rooms')</span>
<span class="sd"> Revit.DB.BuiltInCategory.OST_Rooms</span>
<span class="sd"> >>> BicEnum.get_id('OST_Rooms')</span>
<span class="sd"> Revit.DB.ElementId</span>
<span class="sd"> >>> BicEnum.from_category_id(furniture.Category.Id)</span>
<span class="sd"> DB.BuiltInCategory.OST_Furniture</span>
<span class="sd"> """</span>
<span class="n">_revit_object_class</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="n">BuiltInCategory</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BiCategory</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">DB</span><span class="o">.</span><span class="n">BuiltInCategory</span><span class="p">,</span>
<span class="n">enforce_type</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">category_name</span><span class="p">):</span>
<span class="sd">""" Gets Built In Category by Name</span>
<span class="sd"> Args:</span>
<span class="sd"> ``str``: Name of Category</span>
<span class="sd"> Returns:</span>
<span class="sd"> ``DB.BuiltInCategory``: BuiltInCategory Enumeration Member</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">enum</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">DB</span><span class="o">.</span><span class="n">BuiltInCategory</span><span class="p">,</span> <span class="n">category_name</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RpwCoerceError</span><span class="p">(</span><span class="n">category_name</span><span class="p">,</span> <span class="n">DB</span><span class="o">.</span><span class="n">BuiltInCategory</span><span class="p">)</span>
<span class="k">return</span> <span class="n">enum</span>
<span class="k">def</span> <span class="nf">fuzzy_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">loose_category_name</span><span class="p">):</span>
<span class="n">loose_category_name</span> <span class="o">=</span> <span class="n">loose_category_name</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">loose_category_name</span> <span class="o">=</span> <span class="n">loose_category_name</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'ost_'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
<span class="k">for</span> <span class="n">category_name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">DB</span><span class="o">.</span><span class="n">BuiltInCategory</span><span class="p">):</span>
<span class="n">exp</span> <span class="o">=</span> <span class="s1">'(OST_)(</span><span class="si">{}</span><span class="s1">)$'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">loose_category_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">exp</span><span class="p">,</span> <span class="n">category_name</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">category_name</span><span class="p">)</span>
<span class="c1"># If not Found Try regular method, handle error</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">loose_category_name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">category_name</span><span class="p">):</span>
<span class="sd">""" Gets ElementId of Category by name</span>
<span class="sd"> Args:</span>
<span class="sd"> ``str``: Name of Category</span>
<span class="sd"> Returns:</span>
<span class="sd"> ``DB.BuiltInCategory``: BuiltInCategory Enumeration Member</span>
<span class="sd"> """</span>
<span class="n">enum</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">category_name</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DB</span><span class="o">.</span><span class="n">ElementId</span><span class="p">(</span><span class="n">enum</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">from_category_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">category_id</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Casts ``DB.BuiltInCategory`` Enumeration member from a Category ElementId</span>
<span class="sd"> Args:</span>
<span class="sd"> category_id (``DB.ElementId``): ElementId reference of a category</span>
<span class="sd"> Returns:</span>
<span class="sd"> ``DB.BuiltInCategory`` member</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">Enum</span><span class="o">.</span><span class="n">ToObject</span><span class="p">(</span><span class="n">DB</span><span class="o">.</span><span class="n">BuiltInCategory</span><span class="p">,</span> <span class="n">category_id</span><span class="o">.</span><span class="n">IntegerValue</span><span class="p">)</span>
<span class="c1"># Similar to: Category.GetCategory(doc, category.Id).Name</span>
<span class="c1"># For Test Compatibility</span>
<span class="c1"># TODO: Replace on Tests and Code!</span>
<span class="n">BipEnum</span> <span class="o">=</span> <span class="n">BiParameter</span><span class="p">()</span>
<span class="n">BicEnum</span> <span class="o">=</span> <span class="n">BiCategory</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="forms.html" class="btn btn-neutral float-right" title="Forms" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="geometry.html" class="btn btn-neutral" title="Geometry" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Gui Talarico.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>