root/doc/html/classitpp_1_1bfstream__base.html @ 354

Revision 353, 12.5 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_base 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__base.html">bfstream_base</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::bfstream_base Class Reference<br>
72<small>
73[<a class="el" href="group__itfile.html">IT++ File Format</a>]</small>
74</h1><!-- doxytag: class="itpp::bfstream_base" -->Base class for binary file classes<p>
75This class serves as a base class for the classes <code><a class="el" href="classitpp_1_1bofstream.html" title="Binary Outfile Class.">bofstream</a></code>, <code><a class="el" href="classitpp_1_1bifstream.html" title="Binary Infile Class.">bifstream</a></code>, and <code><a class="el" href="classitpp_1_1bfstream.html" title="Binary in/out-file Class.">bfstream</a></code>. It controls the endianity (i.e. the byte order of multibyte numbers on the disk) of the inhereted classes. 
76<a href="#_details">More...</a>
77<p>
78<code>#include &lt;<a class="el" href="binfile_8h-source.html">binfile.h</a>&gt;</code>
79<p>
80
81<p>
82<a href="classitpp_1_1bfstream__base-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 Types</h2></td></tr>
85<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>,
86<b>b_endian</b>
87 }</td></tr>
88
89<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>
90<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#8679cc312df085314a028d8584ce9164">bfstream_base</a> (<a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> e=b_endian)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class Constructor.  <a href="#8679cc312df085314a028d8584ce9164"></a><br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="401a56688588d60dc975bd1799d31af1"></a><!-- doxytag: member="itpp::bfstream_base::get_endianity" ref="401a56688588d60dc975bd1799d31af1" args="() const " -->
95<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>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the endianity of the class. <br></td></tr>
98<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>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the native endianity for this computer architecture.  <a href="#16cb86d0d72bfea9eeece1eb359bb2dc"></a><br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1cbb249d9551f7f211127267f0659070"></a><!-- doxytag: member="itpp::bfstream_base::set_endianity" ref="1cbb249d9551f7f211127267f0659070" args="(endian e)" -->
102void&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>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the endianity for this class. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fb631f9306a3979b2de2cbba3e7a6e8"></a><!-- doxytag: member="itpp::bfstream_base::set_native_endianity" ref="3fb631f9306a3979b2de2cbba3e7a6e8" args="()" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#3fb631f9306a3979b2de2cbba3e7a6e8">set_native_endianity</a> ()</td></tr>
107
108<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>
109<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbaef6aee59846dba986f483e9cbfa05"></a><!-- doxytag: member="itpp::bfstream_base::switch_endianity" ref="cbaef6aee59846dba986f483e9cbfa05" args="" -->
111bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1bfstream__base.html#cbaef6aee59846dba986f483e9cbfa05">switch_endianity</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicates if the endianity of the processed data needs to be changed. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9a02be8ad908bc3782f9e7dc7f5f9a0"></a><!-- doxytag: member="itpp::bfstream_base::native_endianity" ref="d9a02be8ad908bc3782f9e7dc7f5f9a0" args="" -->
115<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>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The native endianity for this computer architecture. <br></td></tr>
118</table>
119<hr><a name="_details"></a><h2>Detailed Description</h2>
120Base class for binary file classes<p>
121This class serves as a base class for the classes <code><a class="el" href="classitpp_1_1bofstream.html" title="Binary Outfile Class.">bofstream</a></code>, <code><a class="el" href="classitpp_1_1bifstream.html" title="Binary Infile Class.">bifstream</a></code>, and <code><a class="el" href="classitpp_1_1bfstream.html" title="Binary in/out-file Class.">bfstream</a></code>. It controls the endianity (i.e. the byte order of multibyte numbers on the disk) of the inhereted classes. <hr><h2>Member Enumeration Documentation</h2>
122<a class="anchor" name="6f166d41c87aba471de03e9429f6546b"></a><!-- doxytag: member="itpp::bfstream_base::endian" ref="6f166d41c87aba471de03e9429f6546b" args="" -->
123<div class="memitem">
124<div class="memproto">
125      <table class="memname">
126        <tr>
127          <td class="memname">enum <a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">itpp::bfstream_base::endian</a>          </td>
128        </tr>
129      </table>
130</div>
131<div class="memdoc">
132
133<p>
134Definition of the endian data type.
135<p>
136The 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>
137"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)
138</div>
139</div><p>
140<hr><h2>Constructor &amp; Destructor Documentation</h2>
141<a class="anchor" name="8679cc312df085314a028d8584ce9164"></a><!-- doxytag: member="itpp::bfstream_base::bfstream_base" ref="8679cc312df085314a028d8584ce9164" args="(endian e=b_endian)" -->
142<div class="memitem">
143<div class="memproto">
144      <table class="memname">
145        <tr>
146          <td class="memname">itpp::bfstream_base::bfstream_base           </td>
147          <td>(</td>
148          <td class="paramtype"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a>&nbsp;</td>
149          <td class="paramname"> <em>e</em> = <code>b_endian</code>          </td>
150          <td>&nbsp;)&nbsp;</td>
151          <td></td>
152        </tr>
153      </table>
154</div>
155<div class="memdoc">
156
157<p>
158Class Constructor.
159<p>
160<dl compact><dt><b>Parameters:</b></dt><dd>
161  <table border="0" cellspacing="2" cellpadding="0">
162    <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>
163  </table>
164</dl>
165
166<p>References <a class="el" href="binfile_8h-source.html#l00121">native_endianity</a>, and <a class="el" href="binfile_8h-source.html#l00119">switch_endianity</a>.</p>
167
168</div>
169</div><p>
170<hr><h2>Member Function Documentation</h2>
171<a class="anchor" name="16cb86d0d72bfea9eeece1eb359bb2dc"></a><!-- doxytag: member="itpp::bfstream_base::get_native_endianity" ref="16cb86d0d72bfea9eeece1eb359bb2dc" args="() const " -->
172<div class="memitem">
173<div class="memproto">
174      <table class="memname">
175        <tr>
176          <td class="memname"><a class="el" href="classitpp_1_1bfstream__base.html#6f166d41c87aba471de03e9429f6546b">endian</a> itpp::bfstream_base::get_native_endianity           </td>
177          <td>(</td>
178          <td class="paramname">          </td>
179          <td>&nbsp;)&nbsp;</td>
180          <td> const<code> [inline]</code></td>
181        </tr>
182      </table>
183</div>
184<div class="memdoc">
185
186<p>
187Returns the native endianity for this computer architecture.
188<p>
189Intel processors use "Little Endian" byte ordering while e.g. Motorola processors use "Big Endian" byte ordering.
190<p>References <a class="el" href="binfile_8h-source.html#l00121">native_endianity</a>.</p>
191
192<p>Referenced by <a class="el" href="itfile_8cpp-source.html#l02373">itpp::it_file_old::write_data_header()</a>.</p>
193
194</div>
195</div><p>
196<hr>The documentation for this class was generated from the following files:<ul>
197<li><a class="el" href="binfile_8h-source.html">binfile.h</a><li><a class="el" href="binfile_8cpp.html">binfile.cpp</a></ul>
198</div>
199<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
200<a href="http://www.doxygen.org/index.html">
201<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
202</body>
203</html>
Note: See TracBrowser for help on using the browser.