root/doc/html/classitpp_1_1bfstream.html @ 354

Revision 353, 33.4 kB (checked in by smidl, 16 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::bfstream 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_1bfstream.html">bfstream</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::bfstream Class Reference<br>
72<small>
73[<a class="el" href="group__itfile.html">IT++ File Format</a>]</small>
74</h1><!-- doxytag: class="itpp::bfstream" --><!-- doxytag: inherits="itpp::bfstream_base" -->Binary in/out-file Class. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="binfile_8h-source.html">binfile.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1bfstream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
82<tr><td></td></tr>
83<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> { <b>l_endian</b>,
85<b>b_endian</b>
86 }</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Definition of the endian data type.  <a href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">More...</a><br></td></tr>
89<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#e50bab14bf5c670458c96cf98e7434ea">bfstream</a> (const std::string &amp;name, <a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> e=b_endian)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor that opens a file and sets the endianity.  <a href="#e50bab14bf5c670458c96cf98e7434ea"></a><br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="586ba43e3cfb000a94d7305654e1e691"></a><!-- doxytag: member="itpp::bfstream::bfstream" ref="586ba43e3cfb000a94d7305654e1e691" args="()" -->
94&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#586ba43e3cfb000a94d7305654e1e691">bfstream</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class Constructor. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9e0ce4943bc5ad96d55bd1003e59568"></a><!-- doxytag: member="itpp::bfstream::~bfstream" ref="a9e0ce4943bc5ad96d55bd1003e59568" args="()" -->
98&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#a9e0ce4943bc5ad96d55bd1003e59568">~bfstream</a> ()</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class Destructor. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#b01e4cb01b12871b921745dbc3b562aa">open</a> (const std::string &amp;name, bool trunc=false, <a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> e=b_endian)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open a file for reading and writing and set the endianity.  <a href="#b01e4cb01b12871b921745dbc3b562aa"></a><br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#03b441c734c105ea33bedc7332d2f533">open_readonly</a> (const std::string &amp;name, <a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> e=b_endian)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open a file for reading only and set the endianity.  <a href="#03b441c734c105ea33bedc7332d2f533"></a><br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="537de5b466518a31f550502855eddfff"></a><!-- doxytag: member="itpp::bfstream::length" ref="537de5b466518a31f550502855eddfff" args="()" -->
108int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#537de5b466518a31f550502855eddfff">length</a> ()</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the length in bytes of the file. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36cf08ed61772e96279efb0c676bd597"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="36cf08ed61772e96279efb0c676bd597" args="(char a)" -->
112<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#36cf08ed61772e96279efb0c676bd597">operator&lt;&lt;</a> (char a)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes an signed char variable to the binary output file. <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc1eb4d0147c5eff2147981b72a9820c"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="dc1eb4d0147c5eff2147981b72a9820c" args="(unsigned char a)" -->
116<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#dc1eb4d0147c5eff2147981b72a9820c">operator&lt;&lt;</a> (unsigned char a)</td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes an unsigned char variable to the binary output file. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2023a0cff4cc5569b4de84439dd45d58"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="2023a0cff4cc5569b4de84439dd45d58" args="(int16_t a)" -->
120<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#2023a0cff4cc5569b4de84439dd45d58">operator&lt;&lt;</a> (int16_t a)</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a 16-bit signed integer variable to the binary output file. <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e73fb3b7f8284a63174c2543ccd8cb9a"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="e73fb3b7f8284a63174c2543ccd8cb9a" args="(uint16_t a)" -->
124<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#e73fb3b7f8284a63174c2543ccd8cb9a">operator&lt;&lt;</a> (uint16_t a)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a 16-bit unsigned integer variable to the binary output file. <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fcc4f588a13b3769a40fb2410199852f"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="fcc4f588a13b3769a40fb2410199852f" args="(int32_t a)" -->
128<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#fcc4f588a13b3769a40fb2410199852f">operator&lt;&lt;</a> (int32_t a)</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a 32-bit signed integer variable to the binary output file. <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e73de91de760c71794b81eb08e03833b"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="e73de91de760c71794b81eb08e03833b" args="(uint32_t a)" -->
132<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#e73de91de760c71794b81eb08e03833b">operator&lt;&lt;</a> (uint32_t a)</td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a 32-bit unsigned integer variable to the binary output file. <br></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a6255506240bb7f76bc37ecf9ff01e8"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="0a6255506240bb7f76bc37ecf9ff01e8" args="(int64_t a)" -->
136<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#0a6255506240bb7f76bc37ecf9ff01e8">operator&lt;&lt;</a> (int64_t a)</td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a 64-bit signed integer variable to the binary output file. <br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5fe66f371057541ce6f1939a7d8f009"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="e5fe66f371057541ce6f1939a7d8f009" args="(uint64_t a)" -->
140<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#e5fe66f371057541ce6f1939a7d8f009">operator&lt;&lt;</a> (uint64_t a)</td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a 64-bit unsigned ingeger variable to the binary output file. <br></td></tr>
143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e012f5c2e431878bdc25e426ea793df1"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="e012f5c2e431878bdc25e426ea793df1" args="(float a)" -->
144<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#e012f5c2e431878bdc25e426ea793df1">operator&lt;&lt;</a> (float a)</td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a float variable to the binary output file. <br></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0761d4766c734b6382c7f8e2eadee2ab"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="0761d4766c734b6382c7f8e2eadee2ab" args="(double a)" -->
148<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#0761d4766c734b6382c7f8e2eadee2ab">operator&lt;&lt;</a> (double a)</td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a double variable to the binary output file. <br></td></tr>
151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4c3ddf6e7fefda01329ed7068149b57"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="d4c3ddf6e7fefda01329ed7068149b57" args="(const char *a)" -->
152<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#d4c3ddf6e7fefda01329ed7068149b57">operator&lt;&lt;</a> (const char *a)</td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a char* string to the binary output file. <br></td></tr>
155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f52315400751ce970f2e326394465f04"></a><!-- doxytag: member="itpp::bfstream::operator&lt;&lt;" ref="f52315400751ce970f2e326394465f04" args="(const std::string &amp;a)" -->
156<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#f52315400751ce970f2e326394465f04">operator&lt;&lt;</a> (const std::string &amp;a)</td></tr>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a string variable to the binary output file. <br></td></tr>
159<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05546ff740dad0288366591457ca7171"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="05546ff740dad0288366591457ca7171" args="(char &amp;a)" -->
160<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#05546ff740dad0288366591457ca7171">operator&gt;&gt;</a> (char &amp;a)</td></tr>
161
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a char variable from the binary output file. <br></td></tr>
163<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="220001631bad30a9a50ffafb98058f20"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="220001631bad30a9a50ffafb98058f20" args="(unsigned char &amp;a)" -->
164<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#220001631bad30a9a50ffafb98058f20">operator&gt;&gt;</a> (unsigned char &amp;a)</td></tr>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads an unsigned char variable from the binary output file. <br></td></tr>
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c82b92512a5e990e98f5877db9f1ac4"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="7c82b92512a5e990e98f5877db9f1ac4" args="(int16_t &amp;a)" -->
168<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#7c82b92512a5e990e98f5877db9f1ac4">operator&gt;&gt;</a> (int16_t &amp;a)</td></tr>
169
170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 16-bit signed integer variable from the binary output file. <br></td></tr>
171<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b94f7a4e00af5ed0335ece69cc433fdf"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="b94f7a4e00af5ed0335ece69cc433fdf" args="(uint16_t &amp;a)" -->
172<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#b94f7a4e00af5ed0335ece69cc433fdf">operator&gt;&gt;</a> (uint16_t &amp;a)</td></tr>
173
174<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 16-bit unsigned integer variable from the binary output file. <br></td></tr>
175<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a38b038052129c7b8f2cfccd85e7c29"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="9a38b038052129c7b8f2cfccd85e7c29" args="(int32_t &amp;a)" -->
176<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#9a38b038052129c7b8f2cfccd85e7c29">operator&gt;&gt;</a> (int32_t &amp;a)</td></tr>
177
178<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 32-bit signed integer variable from the binary output file. <br></td></tr>
179<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="838fd02208385e5dfece9286745fb23f"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="838fd02208385e5dfece9286745fb23f" args="(uint32_t &amp;a)" -->
180<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#838fd02208385e5dfece9286745fb23f">operator&gt;&gt;</a> (uint32_t &amp;a)</td></tr>
181
182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 32-bit unsigned integer variable from the binary output file. <br></td></tr>
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="097c0b01f6cc86f7fb2ddd7338e5864b"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="097c0b01f6cc86f7fb2ddd7338e5864b" args="(int64_t &amp;a)" -->
184<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#097c0b01f6cc86f7fb2ddd7338e5864b">operator&gt;&gt;</a> (int64_t &amp;a)</td></tr>
185
186<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 64-bit signed integer variable from the binary output file. <br></td></tr>
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d4b341a8fe1563488126230de0d3cc4"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="5d4b341a8fe1563488126230de0d3cc4" args="(uint64_t &amp;a)" -->
188<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#5d4b341a8fe1563488126230de0d3cc4">operator&gt;&gt;</a> (uint64_t &amp;a)</td></tr>
189
190<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 64-bit unsigned ingeger variable from the binary output file. <br></td></tr>
191<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46c7f34264d807a2b7e27f1d0a06ecca"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="46c7f34264d807a2b7e27f1d0a06ecca" args="(float &amp;a)" -->
192<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#46c7f34264d807a2b7e27f1d0a06ecca">operator&gt;&gt;</a> (float &amp;a)</td></tr>
193
194<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a float variable from the binary output file. <br></td></tr>
195<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36372150f6b0978316fecca3f9cb0002"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="36372150f6b0978316fecca3f9cb0002" args="(double &amp;a)" -->
196<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#36372150f6b0978316fecca3f9cb0002">operator&gt;&gt;</a> (double &amp;a)</td></tr>
197
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a double variable from the binary output file. <br></td></tr>
199<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b79529a337d264c1ce514b8cfe2642e"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="8b79529a337d264c1ce514b8cfe2642e" args="(char *a)" -->
200<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#8b79529a337d264c1ce514b8cfe2642e">operator&gt;&gt;</a> (char *a)</td></tr>
201
202<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a char* string from the binary output file. <br></td></tr>
203<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01cc6a61f8a3df69b0a597cddd53c678"></a><!-- doxytag: member="itpp::bfstream::operator&gt;&gt;" ref="01cc6a61f8a3df69b0a597cddd53c678" args="(std::string &amp;a)" -->
204<a class="el" href="classitpp_1_1bfstream.html">bfstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream.html#01cc6a61f8a3df69b0a597cddd53c678">operator&gt;&gt;</a> (std::string &amp;a)</td></tr>
205
206<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a string variable from the binary output file. <br></td></tr>
207<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="401a56688588d60dc975bd1799d31af1"></a><!-- doxytag: member="itpp::bfstream::get_endianity" ref="401a56688588d60dc975bd1799d31af1" args="() const " -->
208<a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#401a56688588d60dc975bd1799d31af1">get_endianity</a> () const </td></tr>
209
210<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the endianity of the class. <br></td></tr>
211<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#16cb86d0d72bfea9eeece1eb359bb2dc">get_native_endianity</a> () const </td></tr>
212
213<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the native endianity for this computer architecture.  <a href="#16cb86d0d72bfea9eeece1eb359bb2dc"></a><br></td></tr>
214<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1cbb249d9551f7f211127267f0659070"></a><!-- doxytag: member="itpp::bfstream::set_endianity" ref="1cbb249d9551f7f211127267f0659070" args="(endian e)" -->
215void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#1cbb249d9551f7f211127267f0659070">set_endianity</a> (<a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> e)</td></tr>
216
217<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the endianity for this class. <br></td></tr>
218<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fb631f9306a3979b2de2cbba3e7a6e8"></a><!-- doxytag: member="itpp::bfstream::set_native_endianity" ref="3fb631f9306a3979b2de2cbba3e7a6e8" args="()" -->
219void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#3fb631f9306a3979b2de2cbba3e7a6e8">set_native_endianity</a> ()</td></tr>
220
221<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the endianity of this class to the native endianity for this computer architecture. <br></td></tr>
222<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
223<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbaef6aee59846dba986f483e9cbfa05"></a><!-- doxytag: member="itpp::bfstream::switch_endianity" ref="cbaef6aee59846dba986f483e9cbfa05" args="" -->
224bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#cbaef6aee59846dba986f483e9cbfa05">switch_endianity</a></td></tr>
225
226<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicates if the endianity of the processed data needs to be changed. <br></td></tr>
227<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9a02be8ad908bc3782f9e7dc7f5f9a0"></a><!-- doxytag: member="itpp::bfstream::native_endianity" ref="d9a02be8ad908bc3782f9e7dc7f5f9a0" args="" -->
228<a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#d9a02be8ad908bc3782f9e7dc7f5f9a0">native_endianity</a></td></tr>
229
230<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The native endianity for this computer architecture. <br></td></tr>
231</table>
232<hr><a name="_details"></a><h2>Detailed Description</h2>
233Binary in/out-file Class. <hr><h2>Member Enumeration Documentation</h2>
234<a class="anchor" name="6f166d41c87aba471de03e9429f6546b"></a><!-- doxytag: member="itpp::bfstream::endian" ref="6f166d41c87aba471de03e9429f6546b" args="" -->
235<div class="memitem">
236<div class="memproto">
237      <table class="memname">
238        <tr>
239          <td class="memname">enum <a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">itpp::bfstream_base::endian</a><code> [inherited]</code>          </td>
240        </tr>
241      </table>
242</div>
243<div class="memdoc">
244
245<p>
246Definition of the endian data type.
247<p>
248The Endianness defines the order in which multibyte numbers are stored in the file. The two orders are called "Little Endian" (<code>l_endian</code> ) and "Big Endian" (<code>b_endian</code> ).<p>
249"Little Endian" means that the low-order byte of the number is stored at the lowest address (i.e. the little end comes first). "Big Endian" means that the high-order byte of the number is stored in memory at the lowest address (i.e. the big end comes first)
250</div>
251</div><p>
252<hr><h2>Constructor &amp; Destructor Documentation</h2>
253<a class="anchor" name="e50bab14bf5c670458c96cf98e7434ea"></a><!-- doxytag: member="itpp::bfstream::bfstream" ref="e50bab14bf5c670458c96cf98e7434ea" args="(const std::string &amp;name, endian e=b_endian)" -->
254<div class="memitem">
255<div class="memproto">
256      <table class="memname">
257        <tr>
258          <td class="memname">itpp::bfstream::bfstream           </td>
259          <td>(</td>
260          <td class="paramtype">const std::string &amp;&nbsp;</td>
261          <td class="paramname"> <em>name</em>, </td>
262        </tr>
263        <tr>
264          <td class="paramkey"></td>
265          <td></td>
266          <td class="paramtype"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td>
267          <td class="paramname"> <em>e</em> = <code>b_endian</code></td><td>&nbsp;</td>
268        </tr>
269        <tr>
270          <td></td>
271          <td>)</td>
272          <td></td><td></td><td></td>
273        </tr>
274      </table>
275</div>
276<div class="memdoc">
277
278<p>
279Class constructor that opens a file and sets the endianity.
280<p>
281<dl compact><dt><b>Parameters:</b></dt><dd>
282  <table border="0" cellspacing="2" cellpadding="0">
283    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the file to open </td></tr>
284    <tr><td valign="top"></td><td valign="top"><em>e</em>&nbsp;</td><td>Defines the endianity of the class. Possible values are <code>l_endian</code> for "Little Endian" or <code>b_endian</code> for "Big Endian". The default value is <code>b_endian</code>. </td></tr>
285  </table>
286</dl>
287
288</div>
289</div><p>
290<hr><h2>Member Function Documentation</h2>
291<a class="anchor" name="16cb86d0d72bfea9eeece1eb359bb2dc"></a><!-- doxytag: member="itpp::bfstream::get_native_endianity" ref="16cb86d0d72bfea9eeece1eb359bb2dc" args="() const " -->
292<div class="memitem">
293<div class="memproto">
294      <table class="memname">
295        <tr>
296          <td class="memname"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> itpp::bfstream_base::get_native_endianity           </td>
297          <td>(</td>
298          <td class="paramname">          </td>
299          <td>&nbsp;)&nbsp;</td>
300          <td> const<code> [inline, inherited]</code></td>
301        </tr>
302      </table>
303</div>
304<div class="memdoc">
305
306<p>
307Returns the native endianity for this computer architecture.
308<p>
309Intel processors use "Little Endian" byte ordering while e.g. Motorola processors use "Big Endian" byte ordering.
310<p>References <a class="el" href="binfile_8h-source.html#l00121">itpp::bfstream_base::native_endianity</a>.</p>
311
312<p>Referenced by <a class="el" href="itfile_8cpp-source.html#l02373">itpp::it_file_old::write_data_header()</a>.</p>
313
314</div>
315</div><p>
316<a class="anchor" name="b01e4cb01b12871b921745dbc3b562aa"></a><!-- doxytag: member="itpp::bfstream::open" ref="b01e4cb01b12871b921745dbc3b562aa" args="(const std::string &amp;name, bool trunc=false, endian e=b_endian)" -->
317<div class="memitem">
318<div class="memproto">
319      <table class="memname">
320        <tr>
321          <td class="memname">void itpp::bfstream::open           </td>
322          <td>(</td>
323          <td class="paramtype">const std::string &amp;&nbsp;</td>
324          <td class="paramname"> <em>name</em>, </td>
325        </tr>
326        <tr>
327          <td class="paramkey"></td>
328          <td></td>
329          <td class="paramtype">bool&nbsp;</td>
330          <td class="paramname"> <em>trunc</em> = <code>false</code>, </td>
331        </tr>
332        <tr>
333          <td class="paramkey"></td>
334          <td></td>
335          <td class="paramtype"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td>
336          <td class="paramname"> <em>e</em> = <code>b_endian</code></td><td>&nbsp;</td>
337        </tr>
338        <tr>
339          <td></td>
340          <td>)</td>
341          <td></td><td></td><td></td>
342        </tr>
343      </table>
344</div>
345<div class="memdoc">
346
347<p>
348Open a file for reading and writing and set the endianity.
349<p>
350<dl compact><dt><b>Parameters:</b></dt><dd>
351  <table border="0" cellspacing="2" cellpadding="0">
352    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the file to open </td></tr>
353    <tr><td valign="top"></td><td valign="top"><em>trunc</em>&nbsp;</td><td>Rewrite the file if it exists (default value is <code>false</code>) </td></tr>
354    <tr><td valign="top"></td><td valign="top"><em>e</em>&nbsp;</td><td>Defines the endianity of the class (default value is <code>b_endian</code> ) </td></tr>
355  </table>
356</dl>
357
358<p>References <a class="el" href="binfile_8h-source.html#l00121">itpp::bfstream_base::native_endianity</a>, and <a class="el" href="binfile_8h-source.html#l00119">itpp::bfstream_base::switch_endianity</a>.</p>
359
360<p>Referenced by <a class="el" href="itfile_8cpp-source.html#l02334">itpp::it_file_old::open()</a>, <a class="el" href="itfile_8cpp-source.html#l00514">itpp::it_file::open()</a>, <a class="el" href="binfile_8cpp-source.html#l00310">open_readonly()</a>, and <a class="el" href="itfile_8cpp-source.html#l00651">itpp::it_file::pack()</a>.</p>
361
362</div>
363</div><p>
364<a class="anchor" name="03b441c734c105ea33bedc7332d2f533"></a><!-- doxytag: member="itpp::bfstream::open_readonly" ref="03b441c734c105ea33bedc7332d2f533" args="(const std::string &amp;name, endian e=b_endian)" -->
365<div class="memitem">
366<div class="memproto">
367      <table class="memname">
368        <tr>
369          <td class="memname">void itpp::bfstream::open_readonly           </td>
370          <td>(</td>
371          <td class="paramtype">const std::string &amp;&nbsp;</td>
372          <td class="paramname"> <em>name</em>, </td>
373        </tr>
374        <tr>
375          <td class="paramkey"></td>
376          <td></td>
377          <td class="paramtype"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td>
378          <td class="paramname"> <em>e</em> = <code>b_endian</code></td><td>&nbsp;</td>
379        </tr>
380        <tr>
381          <td></td>
382          <td>)</td>
383          <td></td><td></td><td></td>
384        </tr>
385      </table>
386</div>
387<div class="memdoc">
388
389<p>
390Open a file for reading only and set the endianity.
391<p>
392<dl compact><dt><b>Parameters:</b></dt><dd>
393  <table border="0" cellspacing="2" cellpadding="0">
394    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the file to open </td></tr>
395    <tr><td valign="top"></td><td valign="top"><em>e</em>&nbsp;</td><td>Defines the endianity of the class (default value is <code>b_endian</code> ) </td></tr>
396  </table>
397</dl>
398
399<p>References <a class="el" href="binfile_8h-source.html#l00121">itpp::bfstream_base::native_endianity</a>, <a class="el" href="binfile_8cpp-source.html#l00296">open()</a>, and <a class="el" href="binfile_8h-source.html#l00119">itpp::bfstream_base::switch_endianity</a>.</p>
400
401<p>Referenced by <a class="el" href="itfile_8cpp-source.html#l01890">itpp::it_ifile_old::open()</a>, and <a class="el" href="itfile_8cpp-source.html#l00050">itpp::it_ifile::open()</a>.</p>
402
403</div>
404</div><p>
405<hr>The documentation for this class was generated from the following files:<ul>
406<li><a class="el" href="binfile_8h-source.html">binfile.h</a><li><a class="el" href="binfile_8cpp.html">binfile.cpp</a></ul>
407</div>
408<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
409<a href="http://www.doxygen.org/index.html">
410<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
411</body>
412</html>
Note: See TracBrowser for help on using the browser.