-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEnumeratedStringProperty.html
174 lines (131 loc) · 10.7 KB
/
EnumeratedStringProperty.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
<!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>What is EnumeratedStringProperty?</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=fadd4351" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=77160d70" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Event Workspace Development" href="EventWorkspaceDev.html" />
<link rel="prev" title="EnumeratedString" href="EnumeratedString.html" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59110517-1', 'auto');
ga('send', 'pageview');
</script>
</head><body>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://www.mantidproject.org">
</a>
<span class="navbar-text navbar-version pull-left"><b>main</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="index.html">Home</a></li>
<li><a href="https://download.mantidproject.org">Download</a></li>
<li><a href="https://docs.mantidproject.org">User Documentation</a></li>
<li><a href="http://www.mantidproject.org/contact">Contact Us</a></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html">Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">What is EnumeratedStringProperty?</a></li>
</ul>
</div> </p>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="what-is-enumeratedstringproperty">
<span id="enumeratedstringproperty"></span><h1>What is EnumeratedStringProperty?<a class="headerlink" href="#what-is-enumeratedstringproperty" title="Link to this heading">¶</a></h1>
<p><code class="docutils literal notranslate"><span class="pre">EnumeratedStringProperty</span></code> allows the use of <code class="docutils literal notranslate"><span class="pre">EnumeratedString</span></code> objects within the Property structure framework.</p>
</section>
<section id="how-to-use-the-enumeratedstringproperty">
<h1>How to use the EnumeratedStringProperty<a class="headerlink" href="#how-to-use-the-enumeratedstringproperty" title="Link to this heading">¶</a></h1>
<p>Include the <code class="docutils literal notranslate"><span class="pre">EnumeratedStringProperty.h</span></code> header file. Set up the <code class="docutils literal notranslate"><span class="pre">EnumeratedStringProperty</span></code> as follows:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="k">namespace</span><span class="w"> </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">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">binningModeNames</span><span class="p">{</span><span class="s">"Default"</span><span class="p">,</span><span class="w"> </span><span class="s">"Linear"</span><span class="p">,</span><span class="w"> </span><span class="s">"Logarithmic"</span><span class="p">,</span><span class="w"> </span><span class="s">"ReverseLogarithmic"</span><span class="p">,</span><span class="w"> </span><span class="s">"Power"</span><span class="p">};</span>
<span class="w"> </span><span class="k">enum</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">BinningMode</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">DEFAULT</span><span class="p">,</span><span class="w"> </span><span class="n">LINEAR</span><span class="p">,</span><span class="w"> </span><span class="n">LOGARITHMIC</span><span class="p">,</span><span class="w"> </span><span class="n">REVERSELOG</span><span class="p">,</span><span class="w"> </span><span class="n">POWER</span><span class="p">,</span><span class="w"> </span><span class="n">enum_count</span><span class="w"> </span><span class="p">};</span>
<span class="w"> </span><span class="k">typedef</span><span class="w"> </span><span class="n">Mantid</span><span class="o">::</span><span class="n">Kernel</span><span class="o">::</span><span class="n">EnumeratedString</span><span class="o"><</span><span class="n">BinningMode</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">binningModeNames</span><span class="o">></span><span class="w"> </span><span class="n">BINMODE</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="c1">// namespace</span>
</pre></div>
</div>
<p>Declare property:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">declareProperty</span><span class="p">(</span>
<span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">make_unique</span><span class="o"><</span><span class="n">EnumeratedStringProperty</span><span class="o"><</span><span class="n">BinningMode</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">binningModeNames</span><span class="o">>></span><span class="p">(</span><span class="s">"PropertyName"</span><span class="p">),</span>
<span class="w"> </span><span class="s">"Description"</span>
<span class="p">);</span>
</pre></div>
</div>
<p>Use declared property:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">BINMODE</span><span class="w"> </span><span class="n">binMode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">someName</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">binMode</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">BinningMode</span><span class="o">::</span><span class="n">LINEAR</span><span class="p">)</span>
<span class="w"> </span><span class="n">do_something</span><span class="p">();</span>
<span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">binMode</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="s">"Default"</span><span class="p">)</span>
<span class="w"> </span><span class="n">do_something_else</span><span class="p">();</span>
</pre></div>
</div>
<p>Determining and using pre-set mode, if present, or using the default setting:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">BINMODE</span><span class="w"> </span><span class="n">binMode</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">existsProperty</span><span class="p">(</span><span class="s">"PropertyName"</span><span class="p">))</span>
<span class="w"> </span><span class="n">Mode</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">"PropertyName"</span><span class="p">);</span>
<span class="k">else</span>
<span class="w"> </span><span class="n">Mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Default"</span><span class="p">;</span>
</pre></div>
</div>
</section>
<section id="example-use-of-enumeratedstring">
<h1>Example Use of EnumeratedString<a class="headerlink" href="#example-use-of-enumeratedstring" title="Link to this heading">¶</a></h1>
<p>Please see examples of usage in <code class="docutils literal notranslate"><span class="pre">Rebin.cpp</span></code>, <code class="docutils literal notranslate"><span class="pre">CalculateDIFC.cpp</span></code>, and <code class="docutils literal notranslate"><span class="pre">AddSampleLog.cpp</span></code>.</p>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="nav navbar-nav" style=" float: right;">
<li>
<a href="EnumeratedString.html" title="Previous Chapter: EnumeratedString"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« EnumeratedString</span>
</a>
</li>
<li>
<a href="EventWorkspaceDev.html" title="Next Chapter: Event Workspace Development"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Event Workspa... »</span>
</a>
</li>
<li><a href="#">Back to top</a></li>
</ul>
<p>
</p>
</div>
</footer>
</body>
</html>