FileDatastore.h

// -*-c++-*-
//----------------------------------------------------------------------------
//  XC program; finite element analysis code
//  for structural analysis and design.
//
//  Copyright (C)  Luis C. Pérez Tato
//
//  This program derives from OpenSees <http://opensees.berkeley.edu>
//  developed by the  «Pacific earthquake engineering research center».
//
//  Except for the restrictions that may arise from the copyright
//  of the original program (see copyright_opensees.txt)
//  XC is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or 
//  (at your option) any later version.
//
//  This software is distributed in the hope that it will be useful, but 
//  WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details. 
//
//
// You should have received a copy of the GNU General Public License 
// along with this program.
// If not, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------------
/* ****************************************************************** **
**    OpenSees - Open System for Earthquake Engineering Simulation    **
**          Pacific Earthquake Engineering Research Center            **
**                                                                    **
**                                                                    **
** (C) Copyright 1999, The Regents of the University of California    **
** All Rights Reserved.                                               **
**                                                                    **
** Commercial use of this program without express permission of the   **
** University of California, Berkeley, is strictly prohibited.  See   **
** file 'COPYRIGHT'  in main directory for information on usage and   **
** redistribution,  and for a DISCLAIMER OF ALL WARRANTIES.           **
**                                                                    **
** Developed by:                                                      **
**   Frank McKenna (fmckenna@ce.berkeley.edu)                         **
**   Gregory L. Fenves (fenves@ce.berkeley.edu)                       **
**   Filip C. Filippou (filippou@ce.berkeley.edu)                     **
**                                                                    **
** ****************************************************************** */
                                                                        
// $Revision: 1.14 $
// $Date: 2006/01/03 20:49:21 $
// $Source: /usr/local/cvs/OpenSees/SRC/utility/database/FileDatastore.h,v $
                                                                        
                                                                        
#ifndef FileDatastore_h
#define FileDatastore_h

// Written: fmk 
// Created: 10/98
//
// Description: This file contains the class definition for FileDatastore.
// FileDatastore is a concrete subclas of FE_Datastore. A FileDatastore 
// object is used in the program to store/restore the geometry and state 
// information in a modeler at a particular instance in the analysis. The
// information is stored in text files.
//
// What: "@(#) FileDatastore.h, revA"

#include <utility/database/FE_Datastore.h>

#include <fstream>
#include <map>
#include <memory>

using std::fstream;
using std::map;


#define STREAM_POSITION_TYPE int

namespace XC {
class FEM_ObjectBroker;
  
struct IntData
  {
    int *dbTag;
    int *values;     
  };


struct DoubleData
  {
    int *dbTag;
    double *values;     
  };

struct FileDatastoreOutputFile
  {
    std::shared_ptr<fstream> theFile;
    STREAM_POSITION_TYPE fileEnd;
    int      maxDbTag;
    FileDatastoreOutputFile(void)
      : theFile(nullptr), fileEnd(0), maxDbTag(0) {}
    FileDatastoreOutputFile(const std::shared_ptr<fstream> &fs, const STREAM_POSITION_TYPE &fEnd, const int &mx)
      : theFile(fs), fileEnd(fEnd), maxDbTag(mx) {}
    fstream *getFStream(void)
      { return theFile.get(); }
    int openFile(const std::string &, int , IntData &, std::vector<char> &);
    void resetFilePointers(IntData &, const std::vector<char> &);
  };

typedef map<int, FileDatastoreOutputFile> FilesMap;
typedef FilesMap::value_type FilesMap_type;
typedef FilesMap::iterator FilesMap_iterator;



//
//
class FileDatastore: public FE_Datastore
  {
  private:
    // Private methods
    int resizeInt(int newSize);
    int resizeDouble(int newSize);
    void resetFilePointers(void);

    // private attributes
    FilesMap theIDFiles;
    FilesMap theVectFiles;
    FilesMap theMatFiles;
    FilesMap_iterator theIDFilesIter;
    FilesMap_iterator theVectFilesIter;
    FilesMap_iterator theMatFilesIter;

    int lastDomainChangeStamp;
    int currentCommitTag;
    std::vector<char> charPtrData;
    
    IntData    theIntData;
    DoubleData theDoubleData;

    int currentMaxInt;
    int currentMaxDouble;

    void alloc(const size_t &sz);
    std::string getFileName(const std::string &, int idSize,int commitTag) const;
    FileDatastoreOutputFile *getFileStruct(FilesMap &, const std::string &, int objSize, int stepSize, int commitTag);
  public:
    FileDatastore(const std::string &dataBase,Preprocessor &preprocessor, FEM_ObjectBroker &theBroker);    
    
    ~FileDatastore(void);

     std::string getTypeId(void) const
      { return "File"; }
   
    // methods for sending and receiving the data
    int sendMsg(int dbTag, int commitTag, const Message &, ChannelAddress *theAddress =0);    
    int recvMsg(int dbTag, int commitTag, Message &, ChannelAddress *theAddress =0);        

    int sendMatrix(int dbTag, int commitTag, const Matrix &, ChannelAddress *theAddress= nullptr);
    int recvMatrix(int dbTag, int commitTag, Matrix &, ChannelAddress *theAddress= nullptr);
    
    int sendVector(int dbTag, int commitTag, const Vector &, ChannelAddress *theAddress= nullptr);
    int recvVector(int dbTag, int commitTag, Vector &, ChannelAddress *theAddress= nullptr);
    
    int sendID(int dbTag, int commitTag,const ID &, ChannelAddress *theAddress= nullptr);
    int recvID(int dbTag, int commitTag,ID &, ChannelAddress *theAddress= nullptr);

    int createTable(const std::string &tableName,const std::vector<std::string> &columns);
    int insertData(const std::string &tableName,const std::vector<std::string> &columns, int commitTag, const Vector &);
    int getData(const std::string &tableName,const std::vector<std::string> &columns, int commitTag, Vector &);

    // the commitState method
    int commitState(int commitTag);        
  };
} // end of XC namespace

#endif