-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEnumeratedString.html
More file actions
638 lines (472 loc) · 46.1 KB
/
Copy pathEnumeratedString.html
File metadata and controls
638 lines (472 loc) · 46.1 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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>EnumeratedString — MantidProject main documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=0790524f97105ba85085" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=0790524f97105ba85085" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/style.css?v=562d7d41" />
<!-- So that users can add custom icons -->
<script defer src="_static/scripts/fontawesome.js?digest=0790524f97105ba85085"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=0790524f97105ba85085" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=0790524f97105ba85085" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'EnumeratedString';</script>
<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="What is EnumeratedStringProperty?" href="EnumeratedStringProperty.html" />
<link rel="prev" title="Cell Based View Properties" href="BatchWidget/Internals/CellBasedViewProperties.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<link rel="icon" sizes="32x32" href="_static/images/favicon.ico">
</head>
<body data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/images/mantid_logo_light.png" class="logo__image only-light" alt="Logo image">
<img src="_static/images/mantid_logo_dark.png" class="logo__image only-dark" alt="Logo image">
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item pst-sidebar-collapse"><button id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar"><svg class="pst-icon svg-inline--fa" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
<path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/>
</svg>
<span class="pst-collapse-sidebar-label">Collapse Sidebar</span>
<span class="pst-expand-sidebar-label">Expand Sidebar</span>
</button></div>
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">EnumeratedString</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="enumeratedstring">
<span id="id1"></span><h1>EnumeratedString<a class="headerlink" href="#enumeratedstring" title="Link to this heading">#</a></h1>
<section id="why-enumeratedstring">
<h2>Why EnumeratedString?<a class="headerlink" href="#why-enumeratedstring" title="Link to this heading">#</a></h2>
<p>It is common for a property to be a string, the value of which must be one of several enumerated values. Programmatically,
this is representing an <code class="docutils literal notranslate"><span class="pre">enum</span></code> object in C++, but based on a set of strings instead of integer-types. What would be ideal
would be something like the following:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">StringPropertyOptions</span><span class="o">:</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="p">{</span><span class="n">option1</span><span class="o">=</span><span class="s">"OptionOne"</span><span class="p">,</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">};</span>
</pre></div>
</div>
<p>However, this is not allowed under C++.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">EnumeratedString</span></code> objects allow for binding an <code class="docutils literal notranslate"><span class="pre">enum</span></code> or <code class="docutils literal notranslate"><span class="pre">enum</span> <span class="pre">class</span></code> to a vector of strings, allowing for much
of the same behavior. This allows for easy-to-read <code class="docutils literal notranslate"><span class="pre">if</span></code> and <code class="docutils literal notranslate"><span class="pre">switch</span></code> statements, as well as easy conversions and assignments
with strings from the allowed set. This further adds an additional layer of validation for string properties, in addition to the
<code class="docutils literal notranslate"><span class="pre">StringListValidator</span></code> used in the property declaration.</p>
</section>
<section id="how-to-use-the-enumeratedstring">
<h2>How to use the EnumeratedString<a class="headerlink" href="#how-to-use-the-enumeratedstring" title="Link to this heading">#</a></h2>
<p>First include the <code class="docutils literal notranslate"><span class="pre">EnumeratedString.h</span></code> header file.</p>
<p>This is a template class, and its three template parameters are the name of an <code class="docutils literal notranslate"><span class="pre">enum</span></code> type, a <em>pointer</em> to static vector of
<code class="docutils literal notranslate"><span class="pre">std::string</span></code> objects, and an optional <em>pointer</em> to a statically defined <code class="docutils literal notranslate"><span class="pre">std::function</span></code> for comparing <code class="docutils literal notranslate"><span class="pre">std::string</span></code> objects. The last
template parameter is defaulted to <code class="docutils literal notranslate"><span class="pre">compareStrings</span></code> which implements a case-sensitive string comparison. A predefined function for case-insensitive
string comparison, <code class="docutils literal notranslate"><span class="pre">compareStringsCaseInsensitive</span></code>, is also provided as an option.</p>
<p>Below is an example. Consider the mantid algorithm <code class="code docutils literal notranslate"><span class="pre">BakeCake</span></code>, which has a string property,
<code class="docutils literal notranslate"><span class="pre">CakeType</span></code>. This algorithm only knows how to bake a few types of cakes. The allowed types of cake the user can set for
this property are limited to “Lemon”, “Bundt”, and “Pound”.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">EnumeratedString</span></code> should be setup as follows:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"MantidKernel/EnumeratedString.h"</span>
<span class="k">namespace</span><span class="w"> </span><span class="nn">Mantid</span><span class="w"> </span><span class="p">{</span>
<span class="k">namespace</span><span class="w"> </span><span class="p">{</span>
<span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">CakeTypeEnum</span><span class="w"> </span><span class="p">{</span><span class="n">LEMON</span><span class="p">,</span><span class="w"> </span><span class="n">BUNDT</span><span class="p">,</span><span class="w"> </span><span class="n">POUND</span><span class="p">,</span><span class="w"> </span><span class="n">enum_count</span><span class="p">};</span>
<span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">></span><span class="w"> </span><span class="n">cakeTypeNames</span><span class="w"> </span><span class="p">{</span><span class="s">"Lemon"</span><span class="p">,</span><span class="w"> </span><span class="s">"Bundt"</span><span class="p">,</span><span class="w"> </span><span class="s">"Pound"</span><span class="p">};</span>
<span class="c1">// optional typedef</span>
<span class="k">typedef</span><span class="w"> </span><span class="n">EnumeratedString</span><span class="o"><</span><span class="n">CakeEnumType</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">cakeTypeNames</span><span class="o">></span><span class="w"> </span><span class="n">CAKETYPE</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="c1">// namespace</span>
<span class="c1">// ...</span>
<span class="c1">// initialize an object</span>
<span class="n">EnumeratedString</span><span class="o"><</span><span class="n">CakeTypeEnum</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">cakeTypeNames</span><span class="o">></span><span class="w"> </span><span class="n">cake1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">CakeTypeEnum</span><span class="o">::</span><span class="n">LEMON</span><span class="p">;</span>
<span class="n">EnumeratedString</span><span class="o"><</span><span class="n">CakeTypeEnum</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">cakeTypeNames</span><span class="o">></span><span class="w"> </span><span class="n">cake2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Lemon"</span><span class="p">;</span>
<span class="c1">//init from the typedef</span>
<span class="n">CAKETYPE</span><span class="w"> </span><span class="n">cake3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Pound"</span><span class="p">;</span>
<span class="kt">bool</span><span class="w"> </span><span class="n">sameCake</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">cake1</span><span class="o">==</span><span class="n">cake2</span><span class="p">);</span><span class="w"> </span><span class="c1">//sameCake = true, a Lemon cake is a Lemon cake</span>
<span class="kt">bool</span><span class="w"> </span><span class="n">notSameCake</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">cake1</span><span class="o">!=</span><span class="n">cake3</span><span class="p">);</span><span class="w"> </span><span class="c1">//notSameCake = true, a Lemon cake is not a Pound cake</span>
</pre></div>
</div>
<p>Notice that the final element of the <code class="docutils literal notranslate"><span class="pre">enum</span></code> is called <code class="code docutils literal notranslate"><span class="pre">enum_count</span></code>. This is mandatory. This element indicates the
number of elements inside the <code class="docutils literal notranslate"><span class="pre">enum</span></code>, and used for verifying compatibility with the vector of strings. A compiler error
will be triggered if this is not included.</p>
<p>Further, the <code class="docutils literal notranslate"><span class="pre">enum</span></code> <em>must</em> have elements in order from 0 to <code class="code docutils literal notranslate"><span class="pre">enum_count</span></code>. That is, you <em>CANNOT</em> set them like so:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">CakeTypeEnum</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="p">{</span><span class="n">LEMON</span><span class="o">=</span><span class="sc">'l'</span><span class="p">,</span><span class="w"> </span><span class="n">BUNDT</span><span class="o">=</span><span class="sc">'b'</span><span class="p">,</span><span class="w"> </span><span class="n">POUND</span><span class="o">=</span><span class="sc">'p'</span><span class="p">,</span><span class="w"> </span><span class="n">enum_count</span><span class="o">=</span><span class="mi">3</span><span class="p">};</span><span class="w"> </span><span class="c1">// NOT ALLOWED</span>
</pre></div>
</div>
<p>as this will break validation features inside the class.</p>
<p>Notice the use of the reference operator, <code class="code docutils literal notranslate"><span class="pre">&cakeTypeNames</span></code>, and <em>not</em> <code class="code docutils literal notranslate"><span class="pre">cakeTypeNames</span></code>.</p>
<p>In the above code, a <code class="code docutils literal notranslate"><span class="pre">CAKETYPE</span></code> object can be created either from a <code class="code docutils literal notranslate"><span class="pre">CakeTypeEnum</span></code>, or from one of the strings
in the <code class="code docutils literal notranslate"><span class="pre">cakeTypeNames</span></code> array (either by the literal, or by accessig it in the array), or from another <code class="code docutils literal notranslate"><span class="pre">CAKETYPE</span></code>
object. The only assignment/comparison not directly possible is from <code class="code docutils literal notranslate"><span class="pre">CakeTypeEnum</span></code> to one of the strings. Otherwise
free conversion and comparison from <code class="code docutils literal notranslate"><span class="pre">CAKETYPE</span></code>, <code class="code docutils literal notranslate"><span class="pre">CakeTypeEnum</span></code>, and strings from <code class="code docutils literal notranslate"><span class="pre">cakeTypeNames</span></code> is possible.</p>
</section>
<section id="example-use-of-enumeratedstring">
<h2>Example Use of EnumeratedString<a class="headerlink" href="#example-use-of-enumeratedstring" title="Link to this heading">#</a></h2>
<p>An example of where this might be used inside an algorithm is shown below:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"MantidAlgorithms/BakeCake.h"</span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf">"MantidKernel/EnumeratedString.h"</span>
<span class="k">namespace</span><span class="w"> </span><span class="nn">Mantid</span><span class="w"> </span><span class="p">{</span>
<span class="k">namespace</span><span class="w"> </span><span class="p">{</span>
<span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">CakeTypeEnum</span><span class="w"> </span><span class="p">{</span><span class="n">LEMON</span><span class="p">,</span><span class="w"> </span><span class="n">BUNDT</span><span class="p">,</span><span class="w"> </span><span class="n">POUND</span><span class="p">,</span><span class="w"> </span><span class="n">enum_count</span><span class="p">};</span>
<span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">></span><span class="w"> </span><span class="n">cakeTypeNames</span><span class="w"> </span><span class="p">{</span><span class="s">"Lemon"</span><span class="p">,</span><span class="w"> </span><span class="s">"Bundt"</span><span class="p">,</span><span class="w"> </span><span class="s">"Pound"</span><span class="p">};</span>
<span class="k">typedef</span><span class="w"> </span><span class="n">EnumeratedString</span><span class="o"><</span><span class="n">CakeEnumType</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">cakeTypeNames</span><span class="o">></span><span class="w"> </span><span class="n">CAKETYPE</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="c1">// namespace</span>
<span class="k">namespace</span><span class="w"> </span><span class="nn">Algorithms</span><span class="w"> </span><span class="p">{</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">BakeCake::init</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// the StringListValidator is optional, but fails faster; the CAKETYPE cannot be set with string not in list</span>
<span class="w"> </span><span class="n">declareProperty</span><span class="p">(</span><span class="s">"CakeType"</span><span class="p">,</span><span class="w"> </span><span class="s">"Bundt"</span><span class="p">,</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">make_shared</span><span class="o"><</span><span class="n">Mantid</span><span class="o">::</span><span class="n">Kernel</span><span class="o">::</span><span class="n">StringListValidator</span><span class="o">></span><span class="p">(</span><span class="n">cakeTypeNames</span><span class="p">),</span>
<span class="w"> </span><span class="s">"Mandatory. The kind of cake for algorithm to bake."</span><span class="p">);</span>
<span class="p">}</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">BakeCake::exec</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// this will assign cakeType from the string property</span>
<span class="w"> </span><span class="n">CAKETYPE</span><span class="w"> </span><span class="n">cakeType</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">getPropertyValue</span><span class="p">(</span><span class="s">"CakeType"</span><span class="p">);</span>
<span class="w"> </span><span class="c1">// logic can branch on cakeType comparing to the enum</span>
<span class="w"> </span><span class="k">switch</span><span class="p">(</span><span class="n">cakeType</span><span class="p">){</span>
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="no">CakeTypeEnum</span><span class="o">::</span><span class="no">LEMON</span><span class="p">:</span>
<span class="w"> </span><span class="n">bakeLemonCake</span><span class="p">();</span>
<span class="w"> </span><span class="k">break</span><span class="p">;</span>
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="no">CakeTypeEnum</span><span class="o">::</span><span class="no">BUNDT</span><span class="p">:</span>
<span class="w"> </span><span class="n">bakeBundtCake</span><span class="p">();</span>
<span class="w"> </span><span class="k">break</span><span class="p">;</span>
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="no">CakeTypeEnum</span><span class="o">::</span><span class="no">POUND</span><span class="p">:</span>
<span class="w"> </span><span class="n">bakePoundCake</span><span class="p">();</span>
<span class="w"> </span><span class="k">break</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="n">getLemonsForCake</span><span class="p">(</span><span class="s">"Bundt"</span><span class="p">);</span>
<span class="w"> </span><span class="n">getIngredientsForCake</span><span class="p">(</span><span class="n">cakeType</span><span class="p">);</span>
<span class="w"> </span><span class="c1">// other ways to compare</span>
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="n">cakeType</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">"Lemon"</span><span class="p">){</span>
<span class="w"> </span><span class="n">g_log</span><span class="p">.</span><span class="n">information</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"Baking a lemon cake</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="n">cakeType</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">CakeTypeEnum</span><span class="o">::</span><span class="n">BUNDT</span><span class="p">){</span>
<span class="w"> </span><span class="n">g_log</span><span class="p">.</span><span class="n">information</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"Baking a bundt cake</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="n">CAKETYPE</span><span class="w"> </span><span class="n">poundCake</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">CakeTypeEnum</span><span class="o">::</span><span class="n">POUND</span><span class="p">;</span>
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="n">cakeType</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">poundCake</span><span class="p">){</span>
<span class="w"> </span><span class="n">g_log</span><span class="p">.</span><span class="n">information</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"Baking a pound cake</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">BakeCake::getLemonsForCake</span><span class="p">(</span><span class="n">CAKETYPE</span><span class="w"> </span><span class="n">cakeType</span><span class="p">){</span>
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="n">cakeType</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">CakeTypeEnum</span><span class="o">::</span><span class="n">LEMON</span><span class="p">){</span>
<span class="w"> </span><span class="n">g_log</span><span class="p">.</span><span class="n">information</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"Getting some lemons!</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">g_log</span><span class="p">.</span><span class="n">information</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"I have no need for lemons.</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">BakeCake::getIngredientsForCake</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="n">cakeType</span><span class="p">){</span>
<span class="w"> </span><span class="n">g_log</span><span class="p">.</span><span class="n">information</span><span class="p">()</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">"Retrieving ingredients for a "</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">cakeType</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="s">" cake!</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span><span class="c1">// namespace Algorithms</span>
<span class="p">}</span><span class="c1">// namespace Mantid</span>
</pre></div>
</div>
<p>This will easily handle branching logic on the basis of a set number of possible string values, using an <code class="docutils literal notranslate"><span class="pre">enum</span></code> to base the set of strings.</p>
<p>In the code examples above, if you don’t want to distinguish between names like “Lemon” and “LEMON”, you can define your <code class="docutils literal notranslate"><span class="pre">CAKETYPE</span></code> as case-insensitive:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"MantidKernel/EnumeratedString.h"</span>
<span class="k">namespace</span><span class="w"> </span><span class="nn">Mantid</span><span class="w"> </span><span class="p">{</span>
<span class="k">namespace</span><span class="w"> </span><span class="p">{</span>
<span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">CakeTypeEnum</span><span class="w"> </span><span class="p">{</span><span class="n">LEMON</span><span class="p">,</span><span class="w"> </span><span class="n">BUNDT</span><span class="p">,</span><span class="w"> </span><span class="n">POUND</span><span class="p">,</span><span class="w"> </span><span class="n">enum_count</span><span class="p">};</span>
<span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">></span><span class="w"> </span><span class="n">cakeTypeNames</span><span class="w"> </span><span class="p">{</span><span class="s">"Lemon"</span><span class="p">,</span><span class="w"> </span><span class="s">"Bundt"</span><span class="p">,</span><span class="w"> </span><span class="s">"Pound"</span><span class="p">};</span>
<span class="c1">// optional typedef</span>
<span class="k">typedef</span><span class="w"> </span><span class="n">EnumeratedString</span><span class="o"><</span><span class="n">CakeEnumType</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">cakeTypeNames</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">compareStringsCaseInsensitive</span><span class="o">></span><span class="w"> </span><span class="n">CAKETYPE</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="c1">// namespace</span>
</pre></div>
</div>
<p>You can also provide your own string comparator like <code class="docutils literal notranslate"><span class="pre">firstLetterComparator</span></code> shown below:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">"MantidKernel/EnumeratedString.h"</span>
<span class="k">namespace</span><span class="w"> </span><span class="nn">Mantid</span><span class="w"> </span><span class="p">{</span>
<span class="k">namespace</span><span class="w"> </span><span class="p">{</span>
<span class="n">std</span><span class="o">::</span><span class="n">function</span><span class="o"><</span><span class="kt">bool</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="o">&</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="o">&</span><span class="p">)</span><span class="o">></span><span class="w"> </span><span class="n">firstLetterComparator</span><span class="w"> </span><span class="o">=</span>
<span class="w"> </span><span class="p">[](</span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="o">&</span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="o">&</span><span class="n">y</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">y</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span><span class="w"> </span><span class="p">};</span>
<span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">CakeTypeEnum</span><span class="w"> </span><span class="p">{</span><span class="n">L</span><span class="p">,</span><span class="w"> </span><span class="n">B</span><span class="p">,</span><span class="w"> </span><span class="n">P</span><span class="p">,</span><span class="w"> </span><span class="n">enum_count</span><span class="p">};</span>
<span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">></span><span class="w"> </span><span class="n">cakeTypeFirstLetters</span><span class="w"> </span><span class="p">{</span><span class="s">"L"</span><span class="p">,</span><span class="w"> </span><span class="s">"B"</span><span class="p">,</span><span class="w"> </span><span class="s">"P"</span><span class="p">};</span>
<span class="c1">// optional typedef</span>
<span class="k">typedef</span><span class="w"> </span><span class="n">EnumeratedString</span><span class="o"><</span><span class="n">CakeEnumType</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">cakeTypeFirstLetters</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">firstLetterComparator</span><span class="o">></span><span class="w"> </span><span class="n">CAKETYPE</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="c1">// namespace</span>
</pre></div>
</div>
<p>in which case a “Lemon” cake will get the same <code class="docutils literal notranslate"><span class="pre">enum</span></code> value as a “Lime” cake.</p>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="BatchWidget/Internals/CellBasedViewProperties.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Cell Based View Properties</p>
</div>
</a>
<a class="right-next"
href="EnumeratedStringProperty.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">What is EnumeratedStringProperty?</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="pst-show_toc_level nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-enumeratedstring">Why EnumeratedString?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-use-the-enumeratedstring">How to use the EnumeratedString</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#example-use-of-enumeratedstring">Example Use of EnumeratedString</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/EnumeratedString.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=0790524f97105ba85085"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=0790524f97105ba85085"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2007-2026, Mantid.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.18.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>