xc
Recorder.h
1 //----------------------------------------------------------------------------
2 // XC program; finite element analysis code
3 // for structural analysis and design.
4 //
5 // Copyright (C) Luis Claudio Pérez Tato
6 //
7 // This program derives from OpenSees <http://opensees.berkeley.edu>
8 // developed by the «Pacific earthquake engineering research center».
9 //
10 // Except for the restrictions that may arise from the copyright
11 // of the original program (see copyright_opensees.txt)
12 // XC is free software: you can redistribute it and/or modify
13 // it under the terms of the GNU General Public License as published by
14 // the Free Software Foundation, either version 3 of the License, or
15 // (at your option) any later version.
16 //
17 // This software is distributed in the hope that it will be useful, but
18 // WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 // GNU General Public License for more details.
21 //
22 //
23 // You should have received a copy of the GNU General Public License
24 // along with this program.
25 // If not, see <http://www.gnu.org/licenses/>.
26 //----------------------------------------------------------------------------
27 /* ****************************************************************** **
28 ** OpenSees - Open System for Earthquake Engineering Simulation **
29 ** Pacific Earthquake Engineering Research Center **
30 ** **
31 ** **
32 ** (C) Copyright 1999, The Regents of the University of California **
33 ** All Rights Reserved. **
34 ** **
35 ** Commercial use of this program without express permission of the **
36 ** University of California, Berkeley, is strictly prohibited. See **
37 ** file 'COPYRIGHT' in main directory for information on usage and **
38 ** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
39 ** **
40 ** Developed by: **
41 ** Frank McKenna (fmckenna@ce.berkeley.edu) **
42 ** Gregory L. Fenves (fenves@ce.berkeley.edu) **
43 ** Filip C. Filippou (filippou@ce.berkeley.edu) **
44 ** **
45 ** ****************************************************************** */
46 
47 // $Revision: 1.5 $
48 // $Date: 2004/11/24 22:41:22 $
49 // $Source: /usr/local/cvs/OpenSees/SRC/recorder/Recorder.h,v $
50 
51 
52 #ifndef Recorder_h
53 #define Recorder_h
54 
55 // Written: fmk
56 // Created: 11/98
57 // Revision: A
58 //
59 // Description: This file contains the class definition for Recorder.
60 // Recorder is an abstract base class. An Recorder object is used
61 // in the program to store/restore information at each commit().
62 //
63 // What: "@(#) Recorder.h, revA"
64 
65 #include <utility/actor/actor/MovableObject.h>
66 #include "xc_utils/src/kernel/CommandEntity.h"
67 
68 namespace XC {
69 class Domain;
70 
74 //
76 //
86 class Recorder: public MovableObject, public CommandEntity
87  {
88  public:
89  Recorder(int classTag);
90  virtual ~Recorder(void) {}
91 
95  virtual int record(int commitTag, double timeStamp) =0;
96  virtual int playback(int commitTag);
97  virtual int restart(void);
98  virtual int setDomain(Domain &theDomain);
99  virtual int sendSelf(CommParameters &);
100  virtual int recvSelf(const CommParameters &);
101  };
102 } // end of XC namespace
103 
104 
105 #endif
106 
Object that can move between processes.
Definition: MovableObject.h:99
virtual int recvSelf(const CommParameters &)
Receive the object.
Definition: Recorder.cpp:89
An Recorder object is used in the program to store/restore information at each commit().
Definition: Recorder.h:86
virtual int sendSelf(CommParameters &)
Send the object.
Definition: Recorder.cpp:82
virtual int playback(int commitTag)
//! Invoked by the analyst after the analysis has been performed.
Definition: Recorder.cpp:67
virtual int restart(void)
Invoked by the Domain object when revertToStart() is invoked on the Domain object.
Definition: Recorder.cpp:76
virtual int record(int commitTag, double timeStamp)=0
Invoked by the Domain object after commit() has been invoked on all the domain component objects...
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:34
Communication parameters between processes.
Definition: CommParameters.h:65
Domain (mesh and boundary conditions) of the finite element model.
Definition: Domain.h:116