initial commit, lordsawar source, slightly modified
[lordsawar] / src / network-history.h
1 // Copyright (C) 2008, 2009 Ben Asselstine
2 //
3 //  This program is free software; you can redistribute it and/or modify
4 //  it under the terms of the GNU General Public License as published by
5 //  the Free Software Foundation; either version 3 of the License, or
6 //  (at your option) any later version.
7 //
8 //  This program is distributed in the hope that it will be useful,
9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 //  GNU Library General Public License for more details.
12 //
13 //  You should have received a copy of the GNU General Public License
14 //  along with this program; if not, write to the Free Software
15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 
16 //  02110-1301, USA.
17
18 #ifndef NETWORK_HISTORY_H
19 #define NETWORK_HISTORY_H
20
21 #include "history.h"
22 #include "OwnerId.h"
23
24 //! A history object that's owned by a player, to be sent to another player.
25 class NetworkHistory: public OwnerId
26 {
27 public:
28     //! The xml tag of this object in a network stream.
29     static std::string d_tag; 
30
31      //! Default constructor.
32      NetworkHistory(History *history, guint32 owner);
33
34      //! Loading constructor.
35      NetworkHistory(XML_Helper* helper);
36
37      //! Destructor.
38      ~NetworkHistory();
39
40      //! Returns debug information.
41      std::string toString() const;
42
43      //! copying the deep contents of the history
44      static NetworkHistory* copy(History *history, Player *owner);
45
46      //!Saving the network history to an xml stream.
47      bool save(XML_Helper* helper) const;
48
49      History * getHistory() const {return d_history;};
50      void setHistory (History *history) {d_history = history;};
51
52  private:
53      History *d_history;
54 };
55 #endif