G4BuffercoutDestination Class Reference

#include <G4BuffercoutDestination.hh>

Inheritance diagram for G4BuffercoutDestination:

Public Types
using	Transformer = std::function< G4bool(G4String &)>

Public Member Functions
void	AddCerrTransformer (const Transformer &t)
void	AddCerrTransformer (Transformer &&t)
void	AddCoutTransformer (const Transformer &t)
void	AddCoutTransformer (Transformer &&t)
virtual void	Finalize ()
virtual G4int	FlushG4cerr ()
virtual G4int	FlushG4cout ()
	G4BuffercoutDestination (std::size_t maxSize=0)
std::size_t	GetCurrentSizeErr () const
std::size_t	GetCurrentSizeOut () const
std::size_t	GetMaxSize () const
virtual G4int	ReceiveG4cerr (const G4String &msg) override
G4int	ReceiveG4cerr_ (const G4String &msg)
virtual G4int	ReceiveG4cout (const G4String &msg) override
G4int	ReceiveG4cout_ (const G4String &msg)
virtual void	ResetTransformers ()
void	SetMaxSize (std::size_t max)
virtual	~G4BuffercoutDestination ()

Protected Member Functions
void	ResetCerr ()
void	ResetCout ()

Protected Attributes
std::ostringstream	m_buffer_err
std::ostringstream	m_buffer_out
std::size_t	m_currentSize_err = 0
std::size_t	m_currentSize_out = 0
std::size_t	m_maxSize = 0
std::vector< Transformer >	transformersCerr
std::vector< Transformer >	transformersCout

Static Protected Attributes
static G4MTGLOB_DLL G4coutDestination *	masterG4coutDestination = nullptr

Detailed Description

Definition at line 45 of file G4BuffercoutDestination.hh.

Member Typedef Documentation

Transformer

using G4coutDestination::Transformer = std::function<G4bool(G4String&)>

inherited

Definition at line 61 of file G4coutDestination.hh.

Constructor & Destructor Documentation

G4BuffercoutDestination()

G4BuffercoutDestination::G4BuffercoutDestination ( std::size_t  maxSize = 0 )

explicit

Definition at line 37 of file G4BuffercoutDestination.cc.

  : m_buffer_out("")
  , m_buffer_err("")
  , m_maxSize(max)
{}

~G4BuffercoutDestination()

G4BuffercoutDestination::~G4BuffercoutDestination ( )

virtual

Definition at line 44 of file G4BuffercoutDestination.cc.

{ Finalize(); }

References Finalize().

Member Function Documentation

AddCerrTransformer() [1/2]

void G4coutDestination::AddCerrTransformer ( const Transformer &  t )

inlineinherited

Definition at line 67 of file G4coutDestination.hh.

  {
    transformersCerr.push_back(t);
  }

References G4coutDestination::transformersCerr.

Referenced by G4MTcoutDestination::HandleFileCerr().

AddCerrTransformer() [2/2]

void G4coutDestination::AddCerrTransformer ( Transformer &&  t )

inlineinherited

Definition at line 71 of file G4coutDestination.hh.

{ transformersCerr.push_back(t); }

References G4coutDestination::transformersCerr.

AddCoutTransformer() [1/2]

void G4coutDestination::AddCoutTransformer ( const Transformer &  t )

inlineinherited

Definition at line 62 of file G4coutDestination.hh.

  {
    transformersCout.push_back(t);
  }

References G4coutDestination::transformersCout.

Referenced by G4MTcoutDestination::AddMasterOutput(), G4MTcoutDestination::HandleFileCout(), and G4MTcoutDestination::SetDefaultOutput().

AddCoutTransformer() [2/2]

void G4coutDestination::AddCoutTransformer ( Transformer &&  t )

inlineinherited

Definition at line 66 of file G4coutDestination.hh.

{ transformersCout.push_back(t); }

References G4coutDestination::transformersCout.

Finalize()

void G4BuffercoutDestination::Finalize ( )

virtual

Definition at line 47 of file G4BuffercoutDestination.cc.

{
  FlushG4cerr();
  FlushG4cout();
}

References FlushG4cerr(), and FlushG4cout().

Referenced by ~G4BuffercoutDestination().

FlushG4cerr()

G4int G4BuffercoutDestination::FlushG4cerr ( )

virtual

Definition at line 96 of file G4BuffercoutDestination.cc.

{
  std::cerr << m_buffer_err.str() << std::flush;
  ResetCerr();
  return 0;
}

References m_buffer_err, and ResetCerr().

Referenced by G4MTcoutDestination::DumpBuffer(), Finalize(), and ReceiveG4cerr().

FlushG4cout()

G4int G4BuffercoutDestination::FlushG4cout ( )

virtual

Definition at line 80 of file G4BuffercoutDestination.cc.

{
  std::cout << m_buffer_out.str() << std::flush;
  ResetCout();
  return 0;
}

References m_buffer_out, and ResetCout().

Referenced by G4MTcoutDestination::DumpBuffer(), Finalize(), and ReceiveG4cout().

GetCurrentSizeErr()

std::size_t G4BuffercoutDestination::GetCurrentSizeErr ( ) const

inline

Definition at line 66 of file G4BuffercoutDestination.hh.

{ return m_currentSize_err; }

References m_currentSize_err.

GetCurrentSizeOut()

std::size_t G4BuffercoutDestination::GetCurrentSizeOut ( ) const

inline

Definition at line 65 of file G4BuffercoutDestination.hh.

{ return m_currentSize_out; }

References m_currentSize_out.

GetMaxSize()

std::size_t G4BuffercoutDestination::GetMaxSize ( ) const

inline

Definition at line 64 of file G4BuffercoutDestination.hh.

{ return m_maxSize; }

References m_maxSize.

ReceiveG4cerr()

G4int G4BuffercoutDestination::ReceiveG4cerr ( const G4String &  msg )

overridevirtual

Reimplemented from G4coutDestination.

Definition at line 67 of file G4BuffercoutDestination.cc.

{
  m_currentSize_err += msg.size();
  m_buffer_err << msg;
  // If there is a max size and it has been reached, flush
  if(m_maxSize > 0 && m_currentSize_err >= m_maxSize)
  {
    FlushG4cerr();
  }
  return 0;
}

References FlushG4cerr(), m_buffer_err, m_currentSize_err, and m_maxSize.

ReceiveG4cerr_()

G4int G4coutDestination::ReceiveG4cerr_ ( const G4String &  msg )

inherited

Definition at line 84 of file G4coutDestination.cc.

{
  if(transformersCout.size() > 0)
  {
    G4String m = msg;
    std::for_each(transformersCerr.begin(), transformersCerr.end(),
                  [&m](const Transformer& t) { t(m); }
                  // Call transforming function on message
    );
    return ReceiveG4cerr(m);
  }
  else
  {
    return ReceiveG4cerr(msg);
  }
}

References m, G4coutDestination::ReceiveG4cerr(), G4coutDestination::transformersCerr, and G4coutDestination::transformersCout.

Referenced by G4MasterForwardcoutDestination::ReceiveG4cerr().

ReceiveG4cout()

G4int G4BuffercoutDestination::ReceiveG4cout ( const G4String &  msg )

overridevirtual

Reimplemented from G4coutDestination.

Definition at line 54 of file G4BuffercoutDestination.cc.

{
  m_currentSize_out += msg.size();
  m_buffer_out << msg;
  // If there is a max size and it has been reached, flush
  if(m_maxSize > 0 && m_currentSize_out >= m_maxSize)
  {
    FlushG4cout();
  }
  return 0;
}

References FlushG4cout(), m_buffer_out, m_currentSize_out, and m_maxSize.

ReceiveG4cout_()

G4int G4coutDestination::ReceiveG4cout_ ( const G4String &  msg )

inherited

Definition at line 62 of file G4coutDestination.cc.

{
  // Avoid copy of string if not necessary
  if(transformersCout.size() > 0)
  {
    G4String m    = msg;
    G4bool result = true;
    for(const auto& el : transformersCout)
    {
      result &= el(m);
      if(!result)
        break;
    }
    return (result ? ReceiveG4cout(m) : 0);
  }
  else
  {
    return ReceiveG4cout(msg);
  }
}

References m, G4coutDestination::ReceiveG4cout(), and G4coutDestination::transformersCout.

Referenced by G4MasterForwardcoutDestination::ReceiveG4cout().

ResetCerr()

void G4BuffercoutDestination::ResetCerr ( )

protected

Definition at line 104 of file G4BuffercoutDestination.cc.

{
  m_buffer_err.str("");
  m_buffer_err.clear();
  m_currentSize_err = 0;
}

References m_buffer_err, and m_currentSize_err.

Referenced by FlushG4cerr().

ResetCout()

void G4BuffercoutDestination::ResetCout ( )

protected

Definition at line 88 of file G4BuffercoutDestination.cc.

{
  m_buffer_out.str("");
  m_buffer_out.clear();
  m_currentSize_out = 0;
}

References m_buffer_out, and m_currentSize_out.

Referenced by FlushG4cout().

ResetTransformers()

void G4coutDestination::ResetTransformers ( )

virtualinherited

Definition at line 41 of file G4coutDestination.cc.

{
  transformersCout.clear();
  transformersCerr.clear();
}

References G4coutDestination::transformersCerr, and G4coutDestination::transformersCout.

SetMaxSize()

void G4BuffercoutDestination::SetMaxSize ( std::size_t  max )

inline

Definition at line 63 of file G4BuffercoutDestination.hh.

{ m_maxSize = max; }

References m_maxSize, and G4INCL::Math::max().

Field Documentation

m_buffer_err

std::ostringstream G4BuffercoutDestination::m_buffer_err

protected

Definition at line 73 of file G4BuffercoutDestination.hh.

Referenced by FlushG4cerr(), ReceiveG4cerr(), and ResetCerr().

m_buffer_out

std::ostringstream G4BuffercoutDestination::m_buffer_out

protected

Definition at line 72 of file G4BuffercoutDestination.hh.

Referenced by FlushG4cout(), ReceiveG4cout(), and ResetCout().

m_currentSize_err

std::size_t G4BuffercoutDestination::m_currentSize_err = 0

protected

Definition at line 75 of file G4BuffercoutDestination.hh.

Referenced by GetCurrentSizeErr(), ReceiveG4cerr(), and ResetCerr().

m_currentSize_out

std::size_t G4BuffercoutDestination::m_currentSize_out = 0

protected

Definition at line 74 of file G4BuffercoutDestination.hh.

Referenced by GetCurrentSizeOut(), ReceiveG4cout(), and ResetCout().

m_maxSize

std::size_t G4BuffercoutDestination::m_maxSize = 0

protected

Definition at line 76 of file G4BuffercoutDestination.hh.

Referenced by GetMaxSize(), ReceiveG4cerr(), ReceiveG4cout(), and SetMaxSize().

masterG4coutDestination

G4coutDestination * G4coutDestination::masterG4coutDestination = nullptr

staticprotectedinherited

Definition at line 88 of file G4coutDestination.hh.

Referenced by G4UIQt::G4UIQt(), G4MasterForwardcoutDestination::ReceiveG4cerr(), G4MasterForwardcoutDestination::ReceiveG4cout(), and G4UIQt::~G4UIQt().

transformersCerr

std::vector<Transformer> G4coutDestination::transformersCerr

protectedinherited

Definition at line 94 of file G4coutDestination.hh.

Referenced by G4coutDestination::AddCerrTransformer(), G4coutDestination::ReceiveG4cerr_(), and G4coutDestination::ResetTransformers().

transformersCout

std::vector<Transformer> G4coutDestination::transformersCout

protectedinherited

Definition at line 93 of file G4coutDestination.hh.

Referenced by G4coutDestination::AddCoutTransformer(), G4coutDestination::ReceiveG4cerr_(), G4coutDestination::ReceiveG4cout_(), and G4coutDestination::ResetTransformers().

---

The documentation for this class was generated from the following files:

• source/global/management/include/G4BuffercoutDestination.hh
• source/global/management/src/G4BuffercoutDestination.cc