<html> <head><title>ClanLib Reference: CL_NetVariables</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_NetVariables</h1><p> <b> Easy serialization of a data structure.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Network (NetObjects) <p> #include <ClanLib/network.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_NetVariables.html#1401"><tt><font color=blue><b>CL_NetVariables</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_NetVariables.html#1402"><tt><font color=blue><b>~CL_NetVariables</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1403"><tt><font color=blue><b>is_different</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1404"><tt><font color=blue><b>add_bool</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1405"><tt><font color=blue><b>add_int</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1406"><tt><font color=blue><b>add_short</b></font></tt></a></td><td><tt>(<tt><font color=navy>short</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1407"><tt><font color=blue><b>add_float</b></font></tt></a></td><td><tt>(<tt><font color=purple>float</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1408"><tt><font color=blue><b>add_double</b></font></tt></a></td><td><tt>(<tt><font color=purple>double</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1409"><tt><font color=blue><b>add_vars</b></font></tt></a></td><td><tt>(<a href="CL_NetVariables.html#1401"><tt><font color=blue><b>CL_NetVariables</b></font></tt></a>* <tt><font color=blue>variables</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1410"><tt><font color=blue><b>save_all</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_OutputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1411"><tt><font color=blue><b>load_all</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_InputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1412"><tt><font color=blue><b>save_diff</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_OutputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_NetVariables.html#1413"><tt><font color=blue><b>load_diff</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_InputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> The netvariables class is used to read a set of variables from an object, and write them structured, in network byte order, to an output source.<br><br> The Netvariables interface can also read the data again, and produce 'diff' packages where it only write variables that have changed since last write.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1401"><font size=+1><b>CL_NetVariables::CL_NetVariables</b></font></a> - Construct a netvariables object.<br><tt></tt> <a href="CL_NetVariables.html#1401"><tt><font color=blue><b>CL_NetVariables</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1404"><font size=+1><b>CL_NetVariables::add_bool</b></font></a> - Add booleans to the data structure.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1404"><tt><font color=blue><b>add_bool</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1408"><font size=+1><b>CL_NetVariables::add_double</b></font></a> - Add doubles to the data structure.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1408"><tt><font color=blue><b>add_double</b></font></tt></a><tt>(<tt><font color=purple>double</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1407"><font size=+1><b>CL_NetVariables::add_float</b></font></a> - Add floats to the data structure.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1407"><tt><font color=blue><b>add_float</b></font></tt></a><tt>(<tt><font color=purple>float</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1405"><font size=+1><b>CL_NetVariables::add_int</b></font></a> - Add integers to the data structure.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1405"><tt><font color=blue><b>add_int</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1406"><font size=+1><b>CL_NetVariables::add_short</b></font></a> - Add shorts to the data structure.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1406"><tt><font color=blue><b>add_short</b></font></tt></a><tt>(<tt><font color=navy>short</font></tt>* <tt><font color=blue>var</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1409"><font size=+1><b>CL_NetVariables::add_vars</b></font></a> - Add structures to the data structure.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1409"><tt><font color=blue><b>add_vars</b></font></tt></a><tt>(<a href="CL_NetVariables.html#1401"><tt><font color=blue><b>CL_NetVariables</b></font></tt></a>* <tt><font color=blue>variables</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>array</font></tt> = 1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1403"><font size=+1><b>CL_NetVariables::is_different</b></font></a> - Returns true if the variables have changed since last save.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_NetVariables.html#1403"><tt><font color=blue><b>is_different</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1411"><font size=+1><b>CL_NetVariables::load_all</b></font></a> - Read all variables in the data structure from the input source.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1411"><tt><font color=blue><b>load_all</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_InputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1413"><font size=+1><b>CL_NetVariables::load_diff</b></font></a> - Read a diff produced with save_diff from the input source.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1413"><tt><font color=blue><b>load_diff</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_InputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1410"><font size=+1><b>CL_NetVariables::save_all</b></font></a> - Write all variables in the data structure to the output source.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1410"><tt><font color=blue><b>save_all</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_OutputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1412"><font size=+1><b>CL_NetVariables::save_diff</b></font></a> - Write all variables that have changed since last save.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_NetVariables.html#1412"><tt><font color=blue><b>save_diff</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_OutputSource</font></tt>* <tt><font color=blue>msg</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1402"><font size=+1><b>CL_NetVariables::~CL_NetVariables</b></font></a> - Net Variables Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_NetVariables.html#1402"><tt><font color=blue><b>~CL_NetVariables</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
