ClientState.ClientState Class Reference
Detailed Description
ClientState is a base class for context which is to be distributed across a network for any type of collaborative interaction.
Sub-classes may encapsulate any state information they wish as long as it can be serialized for transmission.
#include
<class_client_state_1_1_client_state.h>
Public Member Functions |
|
| __init__ () | |
| getID () | |
| Returns the client's id as an int. |
|
| setID () | |
| __eq__ () | |
| Returns True if the given client has the
same state as this client; False otherwise. |
|
| __ne__ () | |
| Returns True if the given client does not
have the same state as this client; False otherwise. |
|
| set () | |
| Set this state object to be equal to the
given state object. |
|
| dump () | |
Member Function Documentation
| ClientState.ClientState.__init__ | ( | ) |
Reimplemented in DisplayState.DisplayState, and NavigatorState.NavigatorState.
| ClientState.ClientState.getID | ( | ) |
Returns the client's id as an int.
| ClientState.ClientState.setID | ( | ) |
| ClientState.ClientState.__eq__ | ( | ) |
Returns True if the given client has the same state as this client; False otherwise.
Reimplemented in DisplayState.DisplayState, and NavigatorState.NavigatorState.
| ClientState.ClientState.__ne__ | ( | ) |
Returns True if the given client does not have the same state as this client; False otherwise.
Reimplemented in DisplayState.DisplayState, and NavigatorState.NavigatorState.
| ClientState.ClientState.set | ( | ) |
Set this state object to be equal to the given state object.
Should be defined in any sub-classes.
Reimplemented in DisplayState.DisplayState, and NavigatorState.NavigatorState.
| ClientState.ClientState.dump | ( | ) |
Reimplemented in DisplayState.DisplayState, and NavigatorState.NavigatorState.
