G4MasterForwardcoutDestination Class Reference

#include <G4MasterForwardcoutDestination.hh>

Inheritance diagram for G4MasterForwardcoutDestination:

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)
	G4MasterForwardcoutDestination ()=default
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 ()
virtual	~G4MasterForwardcoutDestination ()

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

Static Protected Attributes
static G4MTGLOB_DLL G4coutDestination *	masterG4coutDestination = nullptr

Detailed Description

Definition at line 44 of file G4MasterForwardcoutDestination.hh.

Member Typedef Documentation

Transformer

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

inherited

Definition at line 61 of file G4coutDestination.hh.

Constructor & Destructor Documentation

G4MasterForwardcoutDestination()

G4MasterForwardcoutDestination::G4MasterForwardcoutDestination ( )

default

~G4MasterForwardcoutDestination()

G4MasterForwardcoutDestination::~G4MasterForwardcoutDestination ( )

virtual

Definition at line 40 of file G4MasterForwardcoutDestination.cc.

{}

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.

ReceiveG4cerr()

G4int G4MasterForwardcoutDestination::ReceiveG4cerr ( const G4String &  msg )

overridevirtual

Reimplemented from G4coutDestination.

Definition at line 58 of file G4MasterForwardcoutDestination.cc.

{
  if(masterG4coutDestination && this != masterG4coutDestination)
  {
    G4AutoLock l(&out_mutex);
    return masterG4coutDestination->ReceiveG4cerr_(msg);
  }
  return 0;
}

References G4coutDestination::masterG4coutDestination, anonymous_namespace{G4MasterForwardcoutDestination.cc}::out_mutex, and G4coutDestination::ReceiveG4cerr_().

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

ReceiveG4cout()

G4int G4MasterForwardcoutDestination::ReceiveG4cout ( const G4String &  msg )

overridevirtual

Reimplemented from G4coutDestination.

Definition at line 43 of file G4MasterForwardcoutDestination.cc.

{
  // If a master destination is set check that we are not in a recursive
  // situation, send the message to the master, using a lock to serialize calls
  // Master is probably a (G)UI that is not thread-safe
 
  if(masterG4coutDestination && this != masterG4coutDestination)
  {
    G4AutoLock l(&out_mutex);
    return masterG4coutDestination->ReceiveG4cout_(msg);
  }
  return 0;
}

References G4coutDestination::masterG4coutDestination, anonymous_namespace{G4MasterForwardcoutDestination.cc}::out_mutex, and G4coutDestination::ReceiveG4cout_().

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

ResetTransformers()

void G4coutDestination::ResetTransformers ( )

virtualinherited

Definition at line 41 of file G4coutDestination.cc.

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

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

Field Documentation

masterG4coutDestination

G4coutDestination * G4coutDestination::masterG4coutDestination = nullptr

staticprotectedinherited

Definition at line 88 of file G4coutDestination.hh.

Referenced by G4UIQt::G4UIQt(), ReceiveG4cerr(), 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/G4MasterForwardcoutDestination.hh
• source/global/management/src/G4MasterForwardcoutDestination.cc