include/Geant4/G4BuffercoutDestination.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4BuffercoutDestination
0027 //
0028 // Class Description:
0029 //
0030 // A cout destination that buffers received stream in a buffer and
0031 // dumps the buffer only when full.
0032 // Optionally allows for an infinite buffer.
0033
0034 //      ---------------- G4BuffercoutDestination ----------------
0035 //
0036 // Author: A.Dotti (SLAC), 14 April 2017
0037 // --------------------------------------------------------------------
0038 #ifndef G4BUFFERCOUTDESTINATION_HH
0039 #define G4BUFFERCOUTDESTINATION_HH
0040
0041 #include <memory>
0042 #include <sstream>
0043
0044 #include "G4coutDestination.hh"
0045
0046 class G4BuffercoutDestination : public G4coutDestination
0047 {
0048  public:
0049   explicit G4BuffercoutDestination(std::size_t maxSize = 0);
0050   ~G4BuffercoutDestination() override;
0051
0052   G4int ReceiveG4debug(const G4String& msg) override;
0053   G4int ReceiveG4cout(const G4String& msg) override;
0054   G4int ReceiveG4cerr(const G4String& msg) override;
0055
0056   // Flush buffer to std output
0057   virtual G4int FlushG4debug();
0058    // Flush buffer to std output
0059   virtual G4int FlushG4cout();
0060   // Flush buffer to std error
0061   virtual G4int FlushG4cerr();
0062
0063   // Flush all buffers
0064   virtual void Finalize();
0065
0066   // Set maximum size of buffer, when buffer grows to specified size,
0067   // it will trigger flush. Dimension in char
0068   void SetMaxSize(std::size_t max);
0069   std::size_t GetMaxSize() const { return m_maxSize; }
0070
0071  protected:
0072   std::size_t m_maxSize = 0;
0073
0074   class BufferImpl;
0075   std::unique_ptr<BufferImpl> m_buffer_dbg;
0076   std::unique_ptr<BufferImpl> m_buffer_out;
0077   std::unique_ptr<BufferImpl> m_buffer_err;
0078 };
0079
0080 #endif