xc
DatastoreRecorder.h
1 // -*-c++-*-
2 //----------------------------------------------------------------------------
3 // XC program; finite element analysis code
4 // for structural analysis and design.
5 //
6 // Copyright (C) Luis C. Pérez Tato
7 //
8 // This program derives from OpenSees <http://opensees.berkeley.edu>
9 // developed by the «Pacific earthquake engineering research center».
10 //
11 // Except for the restrictions that may arise from the copyright
12 // of the original program (see copyright_opensees.txt)
13 // XC is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU General Public License as published by
15 // the Free Software Foundation, either version 3 of the License, or
16 // (at your option) any later version.
17 //
18 // This software is distributed in the hope that it will be useful, but
19 // WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU General Public License for more details.
22 //
23 //
24 // You should have received a copy of the GNU General Public License
25 // along with this program.
26 // If not, see <http://www.gnu.org/licenses/>.
27 //----------------------------------------------------------------------------
28 /* ****************************************************************** **
29 ** OpenSees - Open System for Earthquake Engineering Simulation **
30 ** Pacific Earthquake Engineering Research Center **
31 ** **
32 ** **
33 ** (C) Copyright 1999, The Regents of the University of California **
34 ** All Rights Reserved. **
35 ** **
36 ** Commercial use of this program without express permission of the **
37 ** University of California, Berkeley, is strictly prohibited. See **
38 ** file 'COPYRIGHT' in main directory for information on usage and **
39 ** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
40 ** **
41 ** Developed by: **
42 ** Frank McKenna (fmckenna@ce.berkeley.edu) **
43 ** Gregory L. Fenves (fenves@ce.berkeley.edu) **
44 ** Filip C. Filippou (filippou@ce.berkeley.edu) **
45 ** **
46 ** ****************************************************************** */
47 
48 // $Revision: 1.4 $
49 // $Date: 2004/11/24 22:45:28 $
50 // $Source: /usr/local/cvs/OpenSees/SRC/recorder/DatastoreRecorder.h,v $
51 
52 
53 // File: ~/DatastoreRecorder/DatastoreRecorder.h
54 //
55 // Written: fmk
56 // Created: 11/98
57 // Revision: A
58 //
59 // Description: This file contains the class definition for DatastoreRecorder.
60 // A DatastoreRecorder object is used in the program to invoke commitState()/
61 // on an FE\_datastore object when commit() is invoked on a Domain. This means
62 // we do not have to add additional methods in the Domain for FE_datastore objects.
63 //
64 // What: "@(#) DatastoreRecorder.h, revA"
65 
66 #ifndef DatastoreRecorder_h
67 #define DatastoreRecorder_h
68 
69 #include <utility/recorder/Recorder.h>
70 
71 namespace XC {
72 class Domain;
73 class FE_Datastore;
74 
81  {
82  private:
83  FE_Datastore *theDatastore;
84  public:
85  DatastoreRecorder(void);
86  DatastoreRecorder(FE_Datastore &theDatastore);
87 
88  int record(int commitTag, double timeStamp);
89  int playback(int commitTag);
90  int restart(void);
91  };
92 } // end of XC namespace
93 
94 
95 #endif
96 
Base class for objects that store/restore model information.
Definition: FE_Datastore.h:84
An Recorder object is used in the program to store/restore information at each commit().
Definition: Recorder.h:87
int restart(void)
Do nothing.
Definition: DatastoreRecorder.cpp:91
int playback(int commitTag)
brief Return the result of invoking {restoreState(commitTag)} on {theDatastore} object.
Definition: DatastoreRecorder.cpp:87
A DatastoreRecorder object is used in the program to invoke commitState() on an FE_datastore object w...
Definition: DatastoreRecorder.h:80
int record(int commitTag, double timeStamp)
Return the result of invoking {commitState(commitTag)} on {theDatastore} object.
Definition: DatastoreRecorder.cpp:81
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:35
DatastoreRecorder(void)
Default constructor.
Definition: DatastoreRecorder.cpp:69