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
|
<HTML>
<HEAD>
<TITLE>VersionInfo Class Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1VersionInfo.html">VersionInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classOpenMS_1_1VersionInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">VersionInfo Class Reference<div class="ingroups"><a class="el" href="group__Concept.html">Concept</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Version information class.
<a href="classOpenMS_1_1VersionInfo.html#details">More...</a></p>
<p><code>#include <<a class="el" href="VersionInfo_8h_source.html">OpenMS/CONCEPT/VersionInfo.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1VersionInfo_1_1VersionDetails.html">VersionDetails</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a68c68c34ab16d124992034edd410dcf9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1VersionInfo.html#a68c68c34ab16d124992034edd410dcf9">getTime</a> ()</td></tr>
<tr class="memdesc:a68c68c34ab16d124992034edd410dcf9"><td class="mdescLeft"> </td><td class="mdescRight">Return the build time of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>. <a href="#a68c68c34ab16d124992034edd410dcf9">More...</a><br/></td></tr>
<tr class="separator:a68c68c34ab16d124992034edd410dcf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad463592f1516b9e0fbf5431e324cdf1b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1VersionInfo.html#ad463592f1516b9e0fbf5431e324cdf1b">getVersion</a> ()</td></tr>
<tr class="memdesc:ad463592f1516b9e0fbf5431e324cdf1b"><td class="mdescLeft"> </td><td class="mdescRight">Return the version number of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>. <a href="#ad463592f1516b9e0fbf5431e324cdf1b">More...</a><br/></td></tr>
<tr class="separator:ad463592f1516b9e0fbf5431e324cdf1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c681a6bb0d7e8d926e818ed20b0b708"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structOpenMS_1_1VersionInfo_1_1VersionDetails.html">VersionDetails</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1VersionInfo.html#a0c681a6bb0d7e8d926e818ed20b0b708">getVersionStruct</a> ()</td></tr>
<tr class="memdesc:a0c681a6bb0d7e8d926e818ed20b0b708"><td class="mdescLeft"> </td><td class="mdescRight">Return the version number of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>. <a href="#a0c681a6bb0d7e8d926e818ed20b0b708">More...</a><br/></td></tr>
<tr class="separator:a0c681a6bb0d7e8d926e818ed20b0b708"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f814d63012f2f61844c23cccbb37eb9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1VersionInfo.html#a8f814d63012f2f61844c23cccbb37eb9">getRevision</a> ()</td></tr>
<tr class="memdesc:a8f814d63012f2f61844c23cccbb37eb9"><td class="mdescLeft"> </td><td class="mdescRight">Return the revision number from revision control system, e.g. Subversion. <a href="#a8f814d63012f2f61844c23cccbb37eb9">More...</a><br/></td></tr>
<tr class="separator:a8f814d63012f2f61844c23cccbb37eb9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Version information class. </p>
<p>The <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> release version and revision data can be retrieved as a string or as integers.</p>
<p>Note that the term <em>"version"</em> refers to releases (such as 1.0, 1.1, 1.1.1, 1.2, ...), whereas the term <em>"revision"</em> refers to a revision control system such as subversion and is mainly of interest for developers.</p>
<p>The <a class="el" href="classOpenMS_1_1VersionInfo.html" title="Version information class. ">VersionInfo</a> class contains only static methods. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8f814d63012f2f61844c23cccbb37eb9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenMS_1_1String.html">String</a> getRevision </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the revision number from revision control system, e.g. Subversion. </p>
<p>On released versions of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> (not from SVN), the result is "exported". The result can be possibly be "" on some platforms, which means that revision info is unavailable. You should check for both cases in your code.</p>
<p>The current svn version is queried by the build system regularly and the result is written as a header file which is included by VersionInfo.C. </p>
</div>
</div>
<a class="anchor" id="a68c68c34ab16d124992034edd410dcf9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenMS_1_1String.html">String</a> getTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the build time of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>. </p>
</div>
</div>
<a class="anchor" id="ad463592f1516b9e0fbf5431e324cdf1b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenMS_1_1String.html">String</a> getVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the version number of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>. </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#aaac8f1a76ed8daa37ed605f1dd60d22a">SpectrumCanvas::addDataProcessing_()</a>, <a class="el" href="classOpenMS_1_1TOPPASBase.html#a4eecbb3c7b39a36a9f365e4dc2a89387">TOPPASBase::loadPreferences()</a>, <a class="el" href="classOpenMS_1_1TOPPViewBase.html#a4eecbb3c7b39a36a9f365e4dc2a89387">TOPPViewBase::loadPreferences()</a>, <a class="el" href="classOpenMS_1_1TOPPASBase.html#a23668b43705781c1cd284bda6ab40abc">TOPPASBase::savePreferences()</a>, <a class="el" href="classOpenMS_1_1TOPPViewBase.html#a23668b43705781c1cd284bda6ab40abc">TOPPViewBase::savePreferences()</a>, <a class="el" href="classOpenMS_1_1IDEvaluationBase.html#ac63a90a3b880d5e9cfd47b54b336be8b">IDEvaluationBase::showAboutDialog()</a>, <a class="el" href="classOpenMS_1_1TOPPASBase.html#ac63a90a3b880d5e9cfd47b54b336be8b">TOPPASBase::showAboutDialog()</a>, and <a class="el" href="classOpenMS_1_1TOPPViewBase.html#ac63a90a3b880d5e9cfd47b54b336be8b">TOPPViewBase::showAboutDialog()</a>.</p>
</div>
</div>
<a class="anchor" id="a0c681a6bb0d7e8d926e818ed20b0b708"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structOpenMS_1_1VersionInfo_1_1VersionDetails.html">VersionDetails</a> getVersionStruct </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the version number of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a>. </p>
</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
