<!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>User class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.17 -->
<center>
<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>User Class Reference</h1><code>#include <<a class="el" href="user_8h-source.html">user.h</a>></code>
<p>
<a href="classUser-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classUser.html#a0">User</a> (unsigned int id)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classUser.html#a1">User</a> (const User &r_user)</td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classUser.html#a2">~User</a> ()</td></tr>
<tr><td nowrap align=right valign=top>User & </td><td valign=bottom><a class="el" href="classUser.html#a3">operator=</a> (const User &r_user)</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classUser.html#a4">operator==</a> (const User &r_user) const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classUser.html#a5">operator==</a> (unsigned int id) const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classUser.html#a6">operator!=</a> (unsigned int id) const</td></tr>
<tr><td nowrap align=right valign=top>unsigned int </td><td valign=bottom><a class="el" href="classUser.html#a7">Id</a> ()</td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>unsigned int </td><td valign=bottom><a class="el" href="classUser.html#o0">mClientId</a></td></tr>
<tr><td> </td><td><font size=-1><em>client id from server (socket)</em> <a href="#o0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classUser.html#o1">mState</a></td></tr>
<tr><td> </td><td><font size=-1><em>users state</em> <a href="#o1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>string </td><td valign=bottom><a class="el" href="classUser.html#o2">mName</a></td></tr>
<tr><td> </td><td><font size=-1><em>user's name</em> <a href="#o2"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The User class contains the minimum amount of attributes to reasonably maintain a socket user with a client.
<p>
<p>
Definition at line <a class="el" href="user_8h-source.html#l00015">15</a> of file <a class="el" href="user_8h-source.html">user.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="User::User"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> User::User </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>id</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor for User. There is no default constructor as all Users must be constructed with a socket id.
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00015">15</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>. </td>
</tr>
</table>
<a name="a1" doxytag="User::User"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> User::User </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const User & </td>
<td class="mdname1" valign="top" nowrap> <em>r_user</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy Constructor for User
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00028">28</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>. </td>
</tr>
</table>
<a name="a2" doxytag="User::~User"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> User::~User </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor for User
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00022">22</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a7" doxytag="User::Id"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int User::Id </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the ClientID
<p>
<dl compact><dt><b>Returns :</b></dt><dd>
the client ID or socket number </dl>
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00078">78</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>.
<p>
References <a class="el" href="user_8h-source.html#l00026">mClientId</a>.
<p>
Referenced by <a class="el" href="paradigm_8cpp-source.html#l00237">Chat</a>(). </td>
</tr>
</table>
<a name="a6" doxytag="User::operator!="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool User::operator!= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>id</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Inequality operator for User<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>id</em> </td><td>
The user id this user is being compared to </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00069">69</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>.
<p>
References <a class="el" href="user_8h-source.html#l00026">mClientId</a>. </td>
</tr>
</table>
<a name="a3" doxytag="User::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> User & User::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const User & </td>
<td class="mdname1" valign="top" nowrap> <em>r_user</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Assignment operator for User<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>r_user</em> </td><td>
The user this user is being assigned to </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00037">37</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>.
<p>
References <a class="el" href="user_8h-source.html#l00026">mClientId</a>, <a class="el" href="user_8h-source.html#l00028">mName</a>, and <a class="el" href="user_8h-source.html#l00027">mState</a>. </td>
</tr>
</table>
<a name="a5" doxytag="User::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool User::operator== </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>id</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Equality operator for User<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>id</em> </td><td>
The user id this user is being compared to </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00060">60</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>.
<p>
References <a class="el" href="user_8h-source.html#l00026">mClientId</a>. </td>
</tr>
</table>
<a name="a4" doxytag="User::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool User::operator== </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const User & </td>
<td class="mdname1" valign="top" nowrap> <em>r_user</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Equality operator for User<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>r_user</em> </td><td>
The user this user is being compared to </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="user_8cpp-source.html#l00051">51</a> of file <a class="el" href="user_8cpp-source.html">user.cpp</a>.
<p>
References <a class="el" href="user_8h-source.html#l00026">mClientId</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="o0" doxytag="User::mClientId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int User::mClientId<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
client id from server (socket)
<p>
<p>
Definition at line <a class="el" href="user_8h-source.html#l00026">26</a> of file <a class="el" href="user_8h-source.html">user.h</a>.
<p>
Referenced by <a class="el" href="user_8cpp-source.html#l00078">Id</a>(), <a class="el" href="user_8cpp-source.html#l00069">operator!=</a>(), <a class="el" href="user_8cpp-source.html#l00037">operator=</a>(), and <a class="el" href="user_8cpp-source.html#l00051">operator==</a>(). </td>
</tr>
</table>
<a name="o2" doxytag="User::mName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string User::mName<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
user's name
<p>
<p>
Definition at line <a class="el" href="user_8h-source.html#l00028">28</a> of file <a class="el" href="user_8h-source.html">user.h</a>.
<p>
Referenced by <a class="el" href="user_8cpp-source.html#l00037">operator=</a>(). </td>
</tr>
</table>
<a name="o1" doxytag="User::mState"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int User::mState<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
users state
<p>
<p>
Definition at line <a class="el" href="user_8h-source.html#l00027">27</a> of file <a class="el" href="user_8h-source.html">user.h</a>.
<p>
Referenced by <a class="el" href="user_8cpp-source.html#l00037">operator=</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="user_8h-source.html">user.h</a><li><a class="el" href="user_8cpp-source.html">user.cpp</a></ul>
<hr><address style="align: right;"><small>Generated on Mon Mar 29 23:12:58 2004 for Paradigm by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.17 </small></address>
</body>
</html>
