root/doc/html/classitpp_1_1Name.html @ 354

Revision 353, 6.5 kB (checked in by smidl, 15 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::Name Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1Name.html">Name</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Name Class Reference<br>
72<small>
73[<a class="el" href="group__itfile.html">IT++ File Format</a>]</small>
74</h1><!-- doxytag: class="itpp::Name" -->Automatic naming when saving<p>
75An easy way to give a variable a name and optionally description when saving. Usage:. 
76<a href="#_details">More...</a>
77<p>
78<code>#include &lt;<a class="el" href="itfile_8h-source.html">itfile.h</a>&gt;</code>
79<p>
80
81<p>
82<a href="classitpp_1_1Name-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
83<tr><td></td></tr>
84<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc622c1a33a650b5fc8480796a12e2db"></a><!-- doxytag: member="itpp::Name::Name" ref="cc622c1a33a650b5fc8480796a12e2db" args="(const std::string &amp;n, const std::string &amp;d=&quot;&quot;)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Name.html#cc622c1a33a650b5fc8480796a12e2db">Name</a> (const std::string &amp;n, const std::string &amp;d=&quot;&quot;)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fcb38034f33dc5b6a75af9f376c20653"></a><!-- doxytag: member="itpp::Name::operator=" ref="fcb38034f33dc5b6a75af9f376c20653" args="(const Name &amp;)" -->
90<a class="el" href="classitpp_1_1Name.html">Name</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Name.html#fcb38034f33dc5b6a75af9f376c20653">operator=</a> (const <a class="el" href="classitpp_1_1Name.html">Name</a> &amp;)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dummy assignment operator - MSVC++ warning C4512. <br></td></tr>
93<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7853f7cf263d31a22e65ded108c62cc"></a><!-- doxytag: member="itpp::Name::name" ref="b7853f7cf263d31a22e65ded108c62cc" args="" -->
95const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Name.html#b7853f7cf263d31a22e65ded108c62cc">name</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name string. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e99acea7fe52c157084cdca8c2f87752"></a><!-- doxytag: member="itpp::Name::desc" ref="e99acea7fe52c157084cdca8c2f87752" args="" -->
99const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Name.html#e99acea7fe52c157084cdca8c2f87752">desc</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The description. <br></td></tr>
102</table>
103<hr><a name="_details"></a><h2>Detailed Description</h2>
104Automatic naming when saving<p>
105An easy way to give a variable a name and optionally description when saving. Usage:.
106<p>
107<div class="fragment"><pre class="fragment">  vec v1(<span class="stringliteral">"1 2 3"</span>), v2;
108  it_file f(<span class="stringliteral">"file.it"</span>);
109  f &lt;&lt; <a class="code" href="classitpp_1_1Name.html#cc622c1a33a650b5fc8480796a12e2db" title="Constructor.">Name</a>(<span class="stringliteral">"v"</span>, <span class="stringliteral">"A vector of consecutive double values"</span>) &lt;&lt; v1;
110  f &gt;&gt; <a class="code" href="classitpp_1_1Name.html#cc622c1a33a650b5fc8480796a12e2db" title="Constructor.">Name</a>(<span class="stringliteral">"v"</span>) &gt;&gt; v2;
111</pre></div> <hr>The documentation for this class was generated from the following file:<ul>
112<li><a class="el" href="itfile_8h-source.html">itfile.h</a></ul>
113</div>
114<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
115<a href="http://www.doxygen.org/index.html">
116<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
117</body>
118</html>
Note: See TracBrowser for help on using the browser.