G4FilecoutDestination Class Reference

#include <G4FilecoutDestination.hh>

Inheritance diagram for G4FilecoutDestination:

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)
void	Close ()
	G4FilecoutDestination (const G4String &fname, std::ios_base::openmode mode=std::ios_base::app)
void	Open (std::ios_base::openmode mode=std::ios_base::app)
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	SetFileName (const G4String &fname)
virtual	~G4FilecoutDestination ()

Protected Attributes
std::vector< Transformer >	transformersCerr
std::vector< Transformer >	transformersCout

Static Protected Attributes
static G4MTGLOB_DLL G4coutDestination *	masterG4coutDestination = nullptr

Private Attributes
std::ios_base::openmode	m_mode
G4String	m_name
std::unique_ptr< std::ofstream >	m_output

Detailed Description

Definition at line 44 of file G4FilecoutDestination.hh.

Member Typedef Documentation

Transformer

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

inherited

Definition at line 61 of file G4coutDestination.hh.

Constructor & Destructor Documentation

G4FilecoutDestination()

G4FilecoutDestination::G4FilecoutDestination ( const G4String &  fname, std::ios_base::openmode  mode = std::ios_base::app  )

inlineexplicit

Definition at line 47 of file G4FilecoutDestination.hh.

    : m_name(fname)
    , m_mode(mode)
    , m_output(nullptr)
  {}

~G4FilecoutDestination()

G4FilecoutDestination::~G4FilecoutDestination ( )

virtual

Definition at line 36 of file G4FilecoutDestination.cc.

{
  Close();
  if(m_output)
    m_output.reset();
}

References Close(), and m_output.

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.

Close()

void G4FilecoutDestination::Close

(

)

Definition at line 59 of file G4FilecoutDestination.cc.

{
  if(m_output && m_output->is_open())
  {
    m_output->close();
  }
}

References m_output.

Referenced by Open(), and ~G4FilecoutDestination().

Open()

void G4FilecoutDestination::Open

(

std::ios_base::openmode

mode = std::ios_base::app

)

Definition at line 44 of file G4FilecoutDestination.cc.

{
  if(m_name.empty())
  {
#ifndef __MIC
    // Cannot use G4Exception, because G4cout/G4cerr is not setup
    throw std::ios_base::failure("No output file name specified");
#endif
  }
  if(m_output != nullptr && m_output->is_open())
    Close();
  m_output.reset(new std::ofstream(m_name, std::ios_base::out | mode));
}

References Close(), m_name, and m_output.

Referenced by ReceiveG4cerr(), and ReceiveG4cout().

ReceiveG4cerr()

G4int G4FilecoutDestination::ReceiveG4cerr ( const G4String &  msg )

overridevirtual

Reimplemented from G4coutDestination.

Definition at line 77 of file G4FilecoutDestination.cc.

{
  if(m_output == nullptr || !m_output->is_open())
    Open(m_mode);
  *m_output << msg;
  return 0;
}

References m_mode, m_output, and Open().

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 G4FilecoutDestination::ReceiveG4cout ( const G4String &  msg )

overridevirtual

Reimplemented from G4coutDestination.

Definition at line 68 of file G4FilecoutDestination.cc.

{
  if(m_output == nullptr || !m_output->is_open())
    Open(m_mode);
  *m_output << msg;
  return 0;
}

References m_mode, m_output, and Open().

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().

ResetTransformers()

void G4coutDestination::ResetTransformers ( )

virtualinherited

Definition at line 41 of file G4coutDestination.cc.

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

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

SetFileName()

void G4FilecoutDestination::SetFileName ( const G4String &  fname )

inline

Definition at line 55 of file G4FilecoutDestination.hh.

{ m_name = fname; }

References test::fname, and m_name.

Field Documentation

m_mode

std::ios_base::openmode G4FilecoutDestination::m_mode

private

Definition at line 66 of file G4FilecoutDestination.hh.

Referenced by ReceiveG4cerr(), and ReceiveG4cout().

m_name

G4String G4FilecoutDestination::m_name

private

Definition at line 65 of file G4FilecoutDestination.hh.

Referenced by Open(), and SetFileName().

m_output

std::unique_ptr<std::ofstream> G4FilecoutDestination::m_output

private

Definition at line 67 of file G4FilecoutDestination.hh.

Referenced by Close(), Open(), ReceiveG4cerr(), ReceiveG4cout(), and ~G4FilecoutDestination().

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/G4FilecoutDestination.hh
• source/global/management/src/G4FilecoutDestination.cc