root/doc/html/classitpp_1_1bifstream.html @ 354

Revision 353, 23.0 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::bifstream 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_1bifstream.html">bifstream</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::bifstream Class Reference<br>
72<small>
73[<a class="el" href="group__itfile.html">IT++ File Format</a>]</small>
74</h1><!-- doxytag: class="itpp::bifstream" --><!-- doxytag: inherits="itpp::bfstream_base" -->Binary Infile 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_1bifstream-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_1bifstream.html#00bd7fdbf78949b4e1a60ab07750c56f">bifstream</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="#00bd7fdbf78949b4e1a60ab07750c56f"></a><br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c09837036492ba45604a23af368a743"></a><!-- doxytag: member="itpp::bifstream::bifstream" ref="0c09837036492ba45604a23af368a743" args="()" -->
94&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#0c09837036492ba45604a23af368a743">bifstream</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="317e44a39b180301e49fa8e364b82d98"></a><!-- doxytag: member="itpp::bifstream::~bifstream" ref="317e44a39b180301e49fa8e364b82d98" args="()" -->
98&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#317e44a39b180301e49fa8e364b82d98">~bifstream</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_1bifstream.html#0a2c57753b100c06f74aa6d95f63c31b">open</a> (const std::string &amp;name, <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 set the endianity.  <a href="#0a2c57753b100c06f74aa6d95f63c31b"></a><br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e476f1e088d028123f9d9b17387c10ec"></a><!-- doxytag: member="itpp::bifstream::length" ref="e476f1e088d028123f9d9b17387c10ec" args="()" -->
105int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#e476f1e088d028123f9d9b17387c10ec">length</a> ()</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the length in bytes of the file. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f898e150dbc64285dc7a132c18f81e57"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="f898e150dbc64285dc7a132c18f81e57" args="(char &amp;a)" -->
109<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#f898e150dbc64285dc7a132c18f81e57">operator&gt;&gt;</a> (char &amp;a)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a signed char variable from the binary output file. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23f58c411eb8d1160d75581fef461497"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="23f58c411eb8d1160d75581fef461497" args="(unsigned char &amp;a)" -->
113<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#23f58c411eb8d1160d75581fef461497">operator&gt;&gt;</a> (unsigned char &amp;a)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads an unsigned char variable from the binary output file. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ed3547031c3491a0fa1f9a35b785191"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="5ed3547031c3491a0fa1f9a35b785191" args="(int16_t &amp;a)" -->
117<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#5ed3547031c3491a0fa1f9a35b785191">operator&gt;&gt;</a> (int16_t &amp;a)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 16-bit signed integer variable from the binary output file. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f134d0c3b5b1cc0c25b8edbf233b7cd9"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="f134d0c3b5b1cc0c25b8edbf233b7cd9" args="(uint16_t &amp;a)" -->
121<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#f134d0c3b5b1cc0c25b8edbf233b7cd9">operator&gt;&gt;</a> (uint16_t &amp;a)</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 16-bit unsigned integer variable from the binary output file. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f833a6014e088b980a7505c174423440"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="f833a6014e088b980a7505c174423440" args="(int32_t &amp;a)" -->
125<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#f833a6014e088b980a7505c174423440">operator&gt;&gt;</a> (int32_t &amp;a)</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 32-bit signed integer variable from the binary output file. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c178dd71941d245d50c8293000ff911"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="4c178dd71941d245d50c8293000ff911" args="(uint32_t &amp;a)" -->
129<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#4c178dd71941d245d50c8293000ff911">operator&gt;&gt;</a> (uint32_t &amp;a)</td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 32-bit unsigned integer variable from the binary output file. <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4014c5650ba01126742953dd21485240"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="4014c5650ba01126742953dd21485240" args="(int64_t &amp;a)" -->
133<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#4014c5650ba01126742953dd21485240">operator&gt;&gt;</a> (int64_t &amp;a)</td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 64-bit signed integer variable from the binary output file. <br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a4c31dc5ce3157a9585651f241a708d"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="7a4c31dc5ce3157a9585651f241a708d" args="(uint64_t &amp;a)" -->
137<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#7a4c31dc5ce3157a9585651f241a708d">operator&gt;&gt;</a> (uint64_t &amp;a)</td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a 64-bit unsigned ingeger variable from the binary output file. <br></td></tr>
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="676d4a6a69c21d22e4b09dc193a5bb4c"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="676d4a6a69c21d22e4b09dc193a5bb4c" args="(float &amp;a)" -->
141<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#676d4a6a69c21d22e4b09dc193a5bb4c">operator&gt;&gt;</a> (float &amp;a)</td></tr>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a float variable from the binary output file. <br></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd7e8338508e733c8600b3d0c6a5e414"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="bd7e8338508e733c8600b3d0c6a5e414" args="(double &amp;a)" -->
145<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#bd7e8338508e733c8600b3d0c6a5e414">operator&gt;&gt;</a> (double &amp;a)</td></tr>
146
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a double variable from the binary output file. <br></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fac8884674c1da82eef470e485236830"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="fac8884674c1da82eef470e485236830" args="(char *a)" -->
149<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#fac8884674c1da82eef470e485236830">operator&gt;&gt;</a> (char *a)</td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a char* string from the binary output file. <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3284b3f32babe757f3e8185d505461c"></a><!-- doxytag: member="itpp::bifstream::operator&gt;&gt;" ref="d3284b3f32babe757f3e8185d505461c" args="(std::string &amp;a)" -->
153<a class="el" href="classitpp_1_1bifstream.html">bifstream</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bifstream.html#d3284b3f32babe757f3e8185d505461c">operator&gt;&gt;</a> (std::string &amp;a)</td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads a string variable from the binary output file. <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="401a56688588d60dc975bd1799d31af1"></a><!-- doxytag: member="itpp::bifstream::get_endianity" ref="401a56688588d60dc975bd1799d31af1" args="() const " -->
157<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>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the endianity of the class. <br></td></tr>
160<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>
161
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the native endianity for this computer architecture.  <a href="#16cb86d0d72bfea9eeece1eb359bb2dc"></a><br></td></tr>
163<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1cbb249d9551f7f211127267f0659070"></a><!-- doxytag: member="itpp::bifstream::set_endianity" ref="1cbb249d9551f7f211127267f0659070" args="(endian e)" -->
164void&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>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the endianity for this class. <br></td></tr>
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fb631f9306a3979b2de2cbba3e7a6e8"></a><!-- doxytag: member="itpp::bifstream::set_native_endianity" ref="3fb631f9306a3979b2de2cbba3e7a6e8" args="()" -->
168void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#3fb631f9306a3979b2de2cbba3e7a6e8">set_native_endianity</a> ()</td></tr>
169
170<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>
171<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbaef6aee59846dba986f483e9cbfa05"></a><!-- doxytag: member="itpp::bifstream::switch_endianity" ref="cbaef6aee59846dba986f483e9cbfa05" args="" -->
173bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#cbaef6aee59846dba986f483e9cbfa05">switch_endianity</a></td></tr>
174
175<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicates if the endianity of the processed data needs to be changed. <br></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9a02be8ad908bc3782f9e7dc7f5f9a0"></a><!-- doxytag: member="itpp::bifstream::native_endianity" ref="d9a02be8ad908bc3782f9e7dc7f5f9a0" args="" -->
177<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>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The native endianity for this computer architecture. <br></td></tr>
180</table>
181<hr><a name="_details"></a><h2>Detailed Description</h2>
182Binary Infile Class. <hr><h2>Member Enumeration Documentation</h2>
183<a class="anchor" name="6f166d41c87aba471de03e9429f6546b"></a><!-- doxytag: member="itpp::bifstream::endian" ref="6f166d41c87aba471de03e9429f6546b" args="" -->
184<div class="memitem">
185<div class="memproto">
186      <table class="memname">
187        <tr>
188          <td class="memname">enum <a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">itpp::bfstream_base::endian</a><code> [inherited]</code>          </td>
189        </tr>
190      </table>
191</div>
192<div class="memdoc">
193
194<p>
195Definition of the endian data type.
196<p>
197The 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>
198"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)
199</div>
200</div><p>
201<hr><h2>Constructor &amp; Destructor Documentation</h2>
202<a class="anchor" name="00bd7fdbf78949b4e1a60ab07750c56f"></a><!-- doxytag: member="itpp::bifstream::bifstream" ref="00bd7fdbf78949b4e1a60ab07750c56f" args="(const std::string &amp;name, endian e=b_endian)" -->
203<div class="memitem">
204<div class="memproto">
205      <table class="memname">
206        <tr>
207          <td class="memname">itpp::bifstream::bifstream           </td>
208          <td>(</td>
209          <td class="paramtype">const std::string &amp;&nbsp;</td>
210          <td class="paramname"> <em>name</em>, </td>
211        </tr>
212        <tr>
213          <td class="paramkey"></td>
214          <td></td>
215          <td class="paramtype"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td>
216          <td class="paramname"> <em>e</em> = <code>b_endian</code></td><td>&nbsp;</td>
217        </tr>
218        <tr>
219          <td></td>
220          <td>)</td>
221          <td></td><td></td><td></td>
222        </tr>
223      </table>
224</div>
225<div class="memdoc">
226
227<p>
228Class constructor that opens a file and sets the endianity.
229<p>
230<dl compact><dt><b>Parameters:</b></dt><dd>
231  <table border="0" cellspacing="2" cellpadding="0">
232    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the file to open </td></tr>
233    <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>
234  </table>
235</dl>
236
237</div>
238</div><p>
239<hr><h2>Member Function Documentation</h2>
240<a class="anchor" name="16cb86d0d72bfea9eeece1eb359bb2dc"></a><!-- doxytag: member="itpp::bifstream::get_native_endianity" ref="16cb86d0d72bfea9eeece1eb359bb2dc" args="() const " -->
241<div class="memitem">
242<div class="memproto">
243      <table class="memname">
244        <tr>
245          <td class="memname"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> itpp::bfstream_base::get_native_endianity           </td>
246          <td>(</td>
247          <td class="paramname">          </td>
248          <td>&nbsp;)&nbsp;</td>
249          <td> const<code> [inline, inherited]</code></td>
250        </tr>
251      </table>
252</div>
253<div class="memdoc">
254
255<p>
256Returns the native endianity for this computer architecture.
257<p>
258Intel processors use "Little Endian" byte ordering while e.g. Motorola processors use "Big Endian" byte ordering.
259<p>References <a class="el" href="binfile_8h-source.html#l00121">itpp::bfstream_base::native_endianity</a>.</p>
260
261<p>Referenced by <a class="el" href="itfile_8cpp-source.html#l02373">itpp::it_file_old::write_data_header()</a>.</p>
262
263</div>
264</div><p>
265<a class="anchor" name="0a2c57753b100c06f74aa6d95f63c31b"></a><!-- doxytag: member="itpp::bifstream::open" ref="0a2c57753b100c06f74aa6d95f63c31b" args="(const std::string &amp;name, endian e=b_endian)" -->
266<div class="memitem">
267<div class="memproto">
268      <table class="memname">
269        <tr>
270          <td class="memname">void itpp::bifstream::open           </td>
271          <td>(</td>
272          <td class="paramtype">const std::string &amp;&nbsp;</td>
273          <td class="paramname"> <em>name</em>, </td>
274        </tr>
275        <tr>
276          <td class="paramkey"></td>
277          <td></td>
278          <td class="paramtype"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td>
279          <td class="paramname"> <em>e</em> = <code>b_endian</code></td><td>&nbsp;</td>
280        </tr>
281        <tr>
282          <td></td>
283          <td>)</td>
284          <td></td><td></td><td></td>
285        </tr>
286      </table>
287</div>
288<div class="memdoc">
289
290<p>
291Open a file for reading and set the endianity.
292<p>
293<dl compact><dt><b>Parameters:</b></dt><dd>
294  <table border="0" cellspacing="2" cellpadding="0">
295    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name of the file to open </td></tr>
296    <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>
297  </table>
298</dl>
299
300<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>
301
302</div>
303</div><p>
304<hr>The documentation for this class was generated from the following files:<ul>
305<li><a class="el" href="binfile_8h-source.html">binfile.h</a><li><a class="el" href="binfile_8cpp.html">binfile.cpp</a></ul>
306</div>
307<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
308<a href="http://www.doxygen.org/index.html">
309<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
310</body>
311</html>
Note: See TracBrowser for help on using the browser.