<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csEventFlattener Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csEventFlattener Class Reference</h1><!-- doxytag: class="csEventFlattener" -->Standard event flattener(also known as serializer).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cseventflattener_8h-source.html">csutil/cseventflattener.h</a>></code>
<p>
<p>
<a href="classcsEventFlattener-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
<a class="el" href="cseventflattener_8h.html#85bab57d6277aecb4be9b35ff34e0e86">csEventFlattenerError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventFlattener.html#3178d00f31fe2188b9bc6ee344924b63">Flatten</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *, <a class="el" href="structiEvent.html">iEvent</a> *event, char *buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flatten am event. <a href="#3178d00f31fe2188b9bc6ee344924b63"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
<a class="el" href="cseventflattener_8h.html#85bab57d6277aecb4be9b35ff34e0e86">csEventFlattenerError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventFlattener.html#e4c2b946103c6dc552062f7bebc25069">FlattenSize</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *, <a class="el" href="structiEvent.html">iEvent</a> *event, size_t &size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the size consumed by the flattened event. <a href="#e4c2b946103c6dc552062f7bebc25069"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
<a class="el" href="cseventflattener_8h.html#85bab57d6277aecb4be9b35ff34e0e86">csEventFlattenerError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventFlattener.html#c2b96be431663a279ce63eeb41d190ae">Unflatten</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *, <a class="el" href="structiEvent.html">iEvent</a> *event, const char *buffer, size_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unflatten an event. <a href="#c2b96be431663a279ce63eeb41d190ae"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Standard event flattener(also known as serializer).
<p>
Converts events from/to a binary representation. Can be used for e.g. disk storage or network transfer.
<p>Definition at line <a class="el" href="cseventflattener_8h-source.html#l00054">54</a> of file <a class="el" href="cseventflattener_8h-source.html">cseventflattener.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3178d00f31fe2188b9bc6ee344924b63"></a><!-- doxytag: member="csEventFlattener::Flatten" ref="3178d00f31fe2188b9bc6ee344924b63" args="(iObjectRegistry *, iEvent *event, char *buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="cseventflattener_8h.html#85bab57d6277aecb4be9b35ff34e0e86">csEventFlattenerError</a> csEventFlattener::Flatten </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flatten am event.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The user is responsible for allocating and deallocating the buffer memory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e4c2b946103c6dc552062f7bebc25069"></a><!-- doxytag: member="csEventFlattener::FlattenSize" ref="e4c2b946103c6dc552062f7bebc25069" args="(iObjectRegistry *, iEvent *event, size_t &size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="cseventflattener_8h.html#85bab57d6277aecb4be9b35ff34e0e86">csEventFlattenerError</a> csEventFlattener::FlattenSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the size consumed by the flattened event.
<p>
</div>
</div><p>
<a class="anchor" name="c2b96be431663a279ce63eeb41d190ae"></a><!-- doxytag: member="csEventFlattener::Unflatten" ref="c2b96be431663a279ce63eeb41d190ae" args="(iObjectRegistry *, iEvent *event, const char *buffer, size_t length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="cseventflattener_8h.html#85bab57d6277aecb4be9b35ff34e0e86">csEventFlattenerError</a> csEventFlattener::Unflatten </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unflatten an event.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="cseventflattener_8h-source.html">cseventflattener.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
462
