root/doc/html/classitpp_1_1bofstream.html @ 353

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