G4UIsession Class Reference

#include <G4UIsession.hh>

Inheritance diagram for G4UIsession:

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)
	G4UIsession ()
	G4UIsession (G4int iBatch)
G4int	GetLastReturnCode () const
virtual void	PauseSessionStart (const G4String &Prompt)
virtual G4int	ReceiveG4cerr (const G4String &cerrString)
G4int	ReceiveG4cerr_ (const G4String &msg)
virtual G4int	ReceiveG4cout (const G4String &coutString)
G4int	ReceiveG4cout_ (const G4String &msg)
virtual void	ResetTransformers ()
virtual G4UIsession *	SessionStart ()
virtual	~G4UIsession ()

Static Public Member Functions
static G4int	InSession ()

Protected Attributes
G4int	ifBatch = 0
G4int	lastRC = 0
std::vector< Transformer >	transformersCerr
std::vector< Transformer >	transformersCout

Static Protected Attributes
static G4ICOMS_DLL G4int	inSession = 0
static G4MTGLOB_DLL G4coutDestination *	masterG4coutDestination = nullptr

Detailed Description

Definition at line 42 of file G4UIsession.hh.

Member Typedef Documentation

Transformer

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

inherited

Definition at line 61 of file G4coutDestination.hh.

Constructor & Destructor Documentation

G4UIsession() [1/2]

G4UIsession::G4UIsession

(

)

Definition at line 36 of file G4UIsession.cc.

{
  ++inSession;
}

References inSession.

G4UIsession() [2/2]

G4UIsession::G4UIsession

(

G4int

iBatch

)

Definition at line 42 of file G4UIsession.cc.

  : ifBatch(iBatch)
{
}

~G4UIsession()

G4UIsession::~G4UIsession ( )

virtual

Definition at line 48 of file G4UIsession.cc.

{
  if(!ifBatch)
  {
    --inSession;
  }
}

References ifBatch, and inSession.

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.

GetLastReturnCode()

G4int G4UIsession::GetLastReturnCode ( ) const

inline

Definition at line 63 of file G4UIsession.hh.

{ return lastRC; }

References lastRC.

InSession()

G4int G4UIsession::InSession ( )

static

Definition at line 68 of file G4UIsession.cc.

{
  return inSession;
}

References inSession.

Referenced by G4UIcontrolMessenger::SetNewValue().

PauseSessionStart()

void G4UIsession::PauseSessionStart ( const G4String &  Prompt )

virtual

Reimplemented in G4UIQt, G4UIXm, G4UIWin32, G4ZMQServer, G4UIterminal, G4UIbatch, and G4VBasicShell.

Definition at line 63 of file G4UIsession.cc.

{
}

ReceiveG4cerr()

G4int G4UIsession::ReceiveG4cerr ( const G4String &  cerrString )

virtual

Reimplemented from G4coutDestination.

Reimplemented in G4UIQt, G4UIXm, G4UIWin32, G4ZMQServer, and G4UIterminal.

Definition at line 81 of file G4UIsession.cc.

{
  std::cerr << cerrString << std::flush;
  return 0;
}

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 G4UIsession::ReceiveG4cout ( const G4String &  coutString )

virtual

Reimplemented from G4coutDestination.

Reimplemented in G4UIQt, G4UIXm, G4UIWin32, G4ZMQServer, and G4UIterminal.

Definition at line 74 of file G4UIsession.cc.

{
  std::cout << coutString << std::flush;
  return 0;
}

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.

SessionStart()

G4UIsession * G4UIsession::SessionStart ( )

virtual

Reimplemented in G4ZMQServer, G4UIbatch, G4UIQt, G4UIterminal, G4UIXm, G4UIWin32, and G4VBasicShell.

Definition at line 57 of file G4UIsession.cc.

{
  return nullptr;
}

Field Documentation

ifBatch

G4int G4UIsession::ifBatch = 0

protected

Definition at line 68 of file G4UIsession.hh.

Referenced by ~G4UIsession().

inSession

G4int G4UIsession::inSession = 0

staticprotected

Definition at line 67 of file G4UIsession.hh.

Referenced by G4UIsession(), InSession(), and ~G4UIsession().

lastRC

G4int G4UIsession::lastRC = 0

protected

Definition at line 69 of file G4UIsession.hh.

Referenced by G4UIbatch::G4UIbatch(), GetLastReturnCode(), and G4UIbatch::SessionStart().

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/intercoms/include/G4UIsession.hh
• source/intercoms/src/G4UIsession.cc