HistoryIO.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2019 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2019 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2019 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All right reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_HISTORY_IO_HPP_
#define GEOSX_HISTORY_IO_HPP_

#include "dataRepository/Group.hpp"

namespace geosx
{
class DataSpec;

class BufferedHistoryIO
{
public:

  BufferedHistoryIO():
    m_bufferedCount( 0 ),
    m_bufferHead( nullptr ),
    m_dataBuffer( 0 )
  {}

  virtual ~BufferedHistoryIO() {}

  buffer_unit_type * getBufferHead( )
  {
    resizeBuffer();
    m_bufferedCount++;
    return m_bufferHead;
  }

  virtual void init( bool existsOkay ) = 0;

  virtual void write( ) = 0;

  virtual void compressInFile( ) = 0;

  localIndex getBufferedCount( ) { return m_bufferedCount; }
protected:
  virtual void resizeBuffer( ) = 0;

  void emptyBuffer( )
  {
    m_bufferedCount = 0;
    m_bufferHead = &m_dataBuffer[0];
  }

  localIndex m_bufferedCount;
  buffer_unit_type * m_bufferHead;
  buffer_type m_dataBuffer;
};

}
#endif