MPQC  2.3.1
state.h
1 //
2 // state.h
3 //
4 // Copyright (C) 1996 Limit Point Systems, Inc.
5 //
6 // Author: Curtis Janssen <cljanss@limitpt.com>
7 // Maintainer: LPS
8 //
9 // This file is part of the SC Toolkit.
10 //
11 // The SC Toolkit is free software; you can redistribute it and/or modify
12 // it under the terms of the GNU Library General Public License as published by
13 // the Free Software Foundation; either version 2, or (at your option)
14 // any later version.
15 //
16 // The SC Toolkit is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU Library General Public License for more details.
20 //
21 // You should have received a copy of the GNU Library General Public License
22 // along with the SC Toolkit; see the file COPYING.LIB. If not, write to
23 // the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 //
25 // The U.S. Government is granted a limited license as per AL 91-7.
26 //
27 
28 #ifndef _util_state_state_h
29 #define _util_state_state_h
30 
31 #ifdef __GNUC__
32 #pragma interface
33 #endif
34 
35 #include <util/class/class.h>
36 
37 namespace sc {
38 
39 class StateIn;
40 class StateOut;
41 class TranslateDataIn;
42 class TranslateDataOut;
43 
47  protected:
48  SavableState();
49  SavableState(const SavableState&);
50 #ifndef __GNUC__
51  public:
52 #endif
53  SavableState& operator=(const SavableState&);
54  public:
55  virtual ~SavableState();
56 
57  // save functions
58 
64  void save_state(StateOut&);
65 
66  // Like save_state(StateOut&), but will handle null pointers correctly.
67  static void save_state(SavableState*s, StateOut&);
68 
74 
82  virtual void save_vbase_state(StateOut&);
83 
87  virtual void save_data_state(StateOut&);
88 
89  // restore functions
90 
98  static SavableState* restore_state(StateIn& si);
102  const char *keyword);
103  static SavableState* dir_restore_state(StateIn& si,
104  const char *objectname,
105  const char *keyword = 0);
106 
107  protected:
108 
114  };
115 
116 }
117 
118 #endif
119 
120 // Local Variables:
121 // mode: c++
122 // c-file-style: "CLJ"
123 // End:
sc::SavableState::save_data_state
virtual void save_data_state(StateOut &)
Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR ...
sc::StateIn
Restores objects that derive from SavableState.
Definition: statein.h:70
sc::SavableState::save_object_state
void save_object_state(StateOut &)
This can be used for saving state when the exact type of the object is known for both the save and th...
sc::SavableState::restore_state
static SavableState * restore_state(StateIn &si)
Restores objects saved with save_state.
sc::SavableState::save_vbase_state
virtual void save_vbase_state(StateOut &)
Save the virtual bases for the object.
sc::SavableState::key_restore_state
static SavableState * key_restore_state(StateIn &si, const char *keyword)
Like restore_state, but keyword is used to override values while restoring.
sc::StateOut
Serializes objects that derive from SavableState.
Definition: stateout.h:61
sc::SavableState::save_state
void save_state(StateOut &)
Save the state of the object as specified by the StateOut object.
sc::DescribedClass
Classes which need runtime information about themselves and their relationship to other classes can v...
Definition: class.h:244
sc::SavableState
Base class for objects that can save/restore state.
Definition: state.h:46

Generated at Sun Jan 26 2020 23:33:04 for MPQC 2.3.1 using the documentation package Doxygen 1.8.16.