G4PersistencyManager Class Reference

#include <G4PersistencyManager.hh>

Inheritance diagram for G4PersistencyManager:

Public Member Functions
virtual G4PersistencyManager *	Create ()
virtual G4VPDigitIO *	DigitIO ()
virtual G4VPEventIO *	EventIO ()
	G4PersistencyManager (G4PersistencyCenter *pc, const G4String &n)
const G4String &	GetName ()
virtual G4VPHitIO *	HitIO ()
virtual void	Initialize ()
virtual G4VMCTruthIO *	MCTruthIO ()
G4bool	Retrieve (G4Event *&evt)
G4bool	Retrieve (G4Run *&)
G4bool	Retrieve (G4VPhysicalVolume *&)
void	SetVerboseLevel (G4int v)
G4bool	Store (const G4Event *evt)
G4bool	Store (const G4Run *)
G4bool	Store (const G4VPhysicalVolume *)
virtual G4VTransactionManager *	TransactionManager ()
virtual	~G4PersistencyManager ()

Static Protected Member Functions
static G4PersistencyManager *	GetPersistencyManager ()

Protected Attributes
G4PersistencyCenter *	f_pc = nullptr
G4int	m_verbose = 0

Private Attributes
G4bool	f_is_initialized = false
G4String	nameMgr

Static Private Attributes
static G4ThreadLocal G4VPersistencyManager *	fPersistencyManager = nullptr

Friends
class	G4PersistencyCenter

Detailed Description

Definition at line 110 of file G4PersistencyManager.hh.

Constructor & Destructor Documentation

G4PersistencyManager()

G4PersistencyManager::G4PersistencyManager	(	G4PersistencyCenter *	pc,
		const G4String &	n
	)

Definition at line 37 of file G4PersistencyManager.cc.

  : f_pc(ptc)
  , nameMgr(n)
{
  m_verbose = f_pc->VerboseLevel();
}

References f_pc, m_verbose, and G4PersistencyCenter::VerboseLevel().

~G4PersistencyManager()

G4PersistencyManager::~G4PersistencyManager ( )

virtual

Definition at line 46 of file G4PersistencyManager.cc.

{
}

Member Function Documentation

Create()

virtual G4PersistencyManager * G4PersistencyManager::Create ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 122 of file G4PersistencyManager.hh.

{ return nullptr; }

Referenced by G4PersistencyCenter::SelectSystem().

DigitIO()

virtual G4VPDigitIO * G4PersistencyManager::DigitIO ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 137 of file G4PersistencyManager.hh.

{ return nullptr; }

Referenced by G4PersistencyManagerT< T >::DigitIO(), SetVerboseLevel(), and Store().

EventIO()

virtual G4VPEventIO * G4PersistencyManager::EventIO ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 129 of file G4PersistencyManager.hh.

{ return nullptr; }

Referenced by G4PersistencyManagerT< T >::EventIO(), Retrieve(), SetVerboseLevel(), and Store().

GetName()

const G4String & G4PersistencyManager::GetName ( )

inline

Definition at line 126 of file G4PersistencyManager.hh.

{ return nameMgr; }

References nameMgr.

Referenced by G4PersistencyManagerT< T >::Create(), and G4PersistencyCenter::RegisterPersistencyManager().

GetPersistencyManager()

G4PersistencyManager * G4PersistencyManager::GetPersistencyManager ( )

staticprotected

Definition at line 51 of file G4PersistencyManager.cc.

{
  return G4PersistencyCenter::GetPersistencyCenter()
    ->CurrentPersistencyManager();
}

References G4PersistencyCenter::CurrentPersistencyManager(), and G4PersistencyCenter::GetPersistencyCenter().

HitIO()

virtual G4VPHitIO * G4PersistencyManager::HitIO ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 133 of file G4PersistencyManager.hh.

{ return nullptr; }

Referenced by G4PersistencyManagerT< T >::HitIO(), SetVerboseLevel(), and Store().

Initialize()

virtual void G4PersistencyManager::Initialize ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 149 of file G4PersistencyManager.hh.

{}

Referenced by Retrieve(), and Store().

MCTruthIO()

virtual G4VMCTruthIO * G4PersistencyManager::MCTruthIO ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 141 of file G4PersistencyManager.hh.

{ return nullptr; }

Referenced by G4PersistencyManagerT< T >::MCTruthIO(), SetVerboseLevel(), and Store().

Retrieve() [1/3]

G4bool G4PersistencyManager::Retrieve ( G4Event *&  evt )

virtual

Implements G4VPersistencyManager.

Definition at line 274 of file G4PersistencyManager.cc.

{
  if(m_verbose > 2)
  {
    G4cout << "G4PersistencyManager::Retrieve(G4Event*&) is called." << G4endl;
  }
 
  if(TransactionManager() == nullptr)
    return true;
 
  if(f_pc->CurrentRetrieveMode("MCTruth") == false &&
     f_pc->CurrentRetrieveMode("Hits") == false &&
     f_pc->CurrentRetrieveMode("Digits") == false)
  {
    return true;
  }
 
  // Call package dependent Initialize()
  //
  if(!f_is_initialized)
  {
    f_is_initialized = true;
    if(m_verbose > 1)
    {
      G4cout << "G4PersistencyManager:: Initializing Transaction ... "
             << G4endl;
    }
    Initialize();
  }
 
  // Start event IO transaction
  //
  if(TransactionManager()->StartRead())
  {
    if(m_verbose > 2)
    {
      G4cout << "G4PersistencyManager: Read transaction started." << G4endl;
    }
  }
  else
  {
    G4cerr << "TransactionManager::Retrieve(G4Event) - StartRead() failed."
           << G4endl;
    return false;
  }
 
  G4bool st = false;
  G4String file;
 
  // Retrieve a G4EVENT
  //
  G4String obj = "Hits";
  if(f_pc->CurrentRetrieveMode(obj) == true)
  {
    file = f_pc->CurrentReadFile(obj);
    if(TransactionManager()->SelectReadFile(obj, file))
    {
      st = EventIO()->Retrieve(evt);
      if(st && m_verbose > 1)
      {
        G4cout << " -- File : " << file << " -- Event# " << evt->GetEventID()
               << " -- G4Event is Retrieved." << G4endl;
      }
    }
    else
    {
      st = false;
    }
  }
 
  if(st)
  {
    TransactionManager()->Commit();
  }
  else
  {
    G4cerr << "G4PersistencyManager::Retrieve() - Transaction aborted."
           << G4endl;
    TransactionManager()->Abort();
  }
 
  return st;
}

References G4VTransactionManager::Abort(), G4VTransactionManager::Commit(), G4PersistencyCenter::CurrentReadFile(), G4PersistencyCenter::CurrentRetrieveMode(), EventIO(), f_is_initialized, f_pc, geant4_check_module_cycles::file, G4cerr, G4cout, G4endl, G4Event::GetEventID(), Initialize(), m_verbose, G4VPEventIO::Retrieve(), and TransactionManager().

Retrieve() [2/3]

G4bool G4PersistencyManager::Retrieve ( G4Run *&  )

inlinevirtual

Implements G4VPersistencyManager.

Definition at line 165 of file G4PersistencyManager.hh.

{ return false; }

Retrieve() [3/3]

G4bool G4PersistencyManager::Retrieve ( G4VPhysicalVolume *&  )

inlinevirtual

Implements G4VPersistencyManager.

Definition at line 171 of file G4PersistencyManager.hh.

{ return false; }

SetVerboseLevel()

void G4PersistencyManager::SetVerboseLevel

(

G4int

v

)

Definition at line 58 of file G4PersistencyManager.cc.

{
  m_verbose = v;
  if(m_verbose > 2)
  {
    G4cout << "G4PersistencyManager[\"" << nameMgr << "\"," << this
           << "]: verbose level is set to " << m_verbose << "." << G4endl;
  }
  if(EventIO() != nullptr)
    EventIO()->SetVerboseLevel(m_verbose);
  if(MCTruthIO() != nullptr)
    MCTruthIO()->SetVerboseLevel(m_verbose);
  if(HitIO() != nullptr)
    HitIO()->SetVerboseLevel(m_verbose);
  if(DigitIO() != nullptr)
    DigitIO()->SetVerboseLevel(m_verbose);
  if(TransactionManager() != nullptr)
    TransactionManager()->SetVerboseLevel(m_verbose);
 
  std::size_t i;
 
  G4HCIOcatalog* hcio = G4HCIOcatalog::GetHCIOcatalog();
  if(hcio != nullptr)
  {
    hcio->SetVerboseLevel(m_verbose);
    for(i = 0; i < hcio->NumberOfHCIOmanager(); ++i)
    {
      hcio->GetHCIOmanager(i)->SetVerboseLevel(m_verbose);
    }
  }
  G4DCIOcatalog* dcio = G4DCIOcatalog::GetDCIOcatalog();
  if(dcio != nullptr)
  {
    dcio->SetVerboseLevel(m_verbose);
    for(i = 0; i < dcio->NumberOfDCIOmanager(); ++i)
    {
      dcio->GetDCIOmanager(i)->SetVerboseLevel(m_verbose);
    }
  }
}

References DigitIO(), EventIO(), G4cout, G4endl, G4DCIOcatalog::GetDCIOcatalog(), G4DCIOcatalog::GetDCIOmanager(), G4HCIOcatalog::GetHCIOcatalog(), G4HCIOcatalog::GetHCIOmanager(), HitIO(), m_verbose, MCTruthIO(), nameMgr, G4DCIOcatalog::NumberOfDCIOmanager(), G4HCIOcatalog::NumberOfHCIOmanager(), G4HCIOcatalog::SetVerboseLevel(), G4VMCTruthIO::SetVerboseLevel(), G4VPDigitIO::SetVerboseLevel(), G4VPDigitsCollectionIO::SetVerboseLevel(), G4VPEventIO::SetVerboseLevel(), G4VPHitIO::SetVerboseLevel(), G4VPHitsCollectionIO::SetVerboseLevel(), G4DCIOcatalog::SetVerboseLevel(), G4VTransactionManager::SetVerboseLevel(), and TransactionManager().

Referenced by G4PersistencyCenter::SelectSystem(), G4PersistencyCenter::SetVerboseLevel(), and G4PersistencyManagerT< T >::SetVerboseLevel().

Store() [1/3]

G4bool G4PersistencyManager::Store ( const G4Event *  evt )

virtual

Implements G4VPersistencyManager.

Definition at line 100 of file G4PersistencyManager.cc.

{
  if(m_verbose > 2)
  {
    G4cout << "G4PersistencyManager::Store() is called for event# "
           << evt->GetEventID() << "." << G4endl;
  }
 
  if(TransactionManager() == nullptr)
    return true;
 
  G4bool is_store = f_pc->CurrentStoreMode("MCTruth") != kOff ||
                    f_pc->CurrentStoreMode("Hits") != kOff ||
                    f_pc->CurrentStoreMode("Digits") != kOff;
 
  if(!is_store)
    return true;
 
  // Call package dependent Initialize()
  //
  if(!f_is_initialized)
  {
    f_is_initialized = true;
    if(m_verbose > 1)
    {
      G4cout << "G4PersistencyManager:: Initializing Transaction ... "
             << G4endl;
    }
    Initialize();
  }
 
  G4bool st1 = true, st2 = true;
 
  // Start event IO transaction
  //
  if(TransactionManager()->StartUpdate())
  {
    if(m_verbose > 2)
    {
      G4cout << "G4PersistencyManager: Update transaction started for event#"
             << evt->GetEventID() << "." << G4endl;
    }
  }
  else
  {
    G4cerr << "TransactionManager::Store(G4Event) - StartUpdate() failed."
           << G4endl;
    return false;
  }
 
  G4String file;
  G4String obj;
 
  G4bool stmct = true, st3 = true;
 
  // Store MCTruth event
  //
  obj                = "MCTruth";
  G4MCTEvent* mctevt = nullptr;
  if(f_pc->CurrentStoreMode(obj) == kOn)
  {
    //  Note: This part of code will not be activated until a method
    //  to obtain the current pointer of G4MCTEvent* become available.
 
    // if ( (mctevt = f_MCTman->GetCurrentEvent()) != 0 ) {
    if(mctevt != nullptr)
    {
      file = f_pc->CurrentWriteFile(obj);
      if(TransactionManager()->SelectWriteFile(obj, file))
      {
        stmct = MCTruthIO()->Store(mctevt);
        if(stmct && m_verbose > 1)
        {
          G4cout << " -- File : " << file << " -- Event# " << evt->GetEventID()
                 << " -- G4MCTEvent Stored." << G4endl;
        }
      }
      else
      {
        stmct = false;
      }
    }  // end of if ( mctevt != nullptr )
  }
 
  // Store hits collection
  //
  obj = "Hits";
  if(f_pc->CurrentStoreMode(obj) == kOn)
  {
    if(G4HCofThisEvent* hc = evt->GetHCofThisEvent())
    {
      file = f_pc->CurrentWriteFile(obj);
      if(TransactionManager()->SelectWriteFile(obj, file))
      {
        st1 = HitIO()->Store(hc);
        if(st1 && m_verbose > 1)
        {
          G4cout << " -- File : " << file << " -- Event# " << evt->GetEventID()
                 << " -- Hit Collections Stored." << G4endl;
        }
      }
      else
      {
        st1 = false;
      }
    }
  }
 
  // Store digits collection
  //
  obj = "Digits";
  if(f_pc->CurrentStoreMode(obj) == kOn)
  {
    if(G4DCofThisEvent* dc = evt->GetDCofThisEvent())
    {
      file = f_pc->CurrentWriteFile(obj);
      if(TransactionManager()->SelectWriteFile(obj, file))
      {
        st2 = DigitIO()->Store(dc);
        if(st2 && m_verbose > 1)
        {
          G4cout << " -- File : " << file << " -- Event# " << evt->GetEventID()
                 << " -- Digit Collections Stored." << G4endl;
        }
      }
      else
      {
        st2 = false;
      }
    }
  }
 
  // Store this G4EVENT
  //
  if(mctevt != 0 || evt != 0)
  {
    obj  = "Hits";
    file = f_pc->CurrentWriteFile(obj);
    if(TransactionManager()->SelectWriteFile(obj, file))
    {
      st3 = EventIO()->Store(evt);
      if(st3 && m_verbose > 1)
      {
        G4cout << " -- File name: " << f_pc->CurrentWriteFile("Hits")
               << " -- Event# " << evt->GetEventID()
               << " -- G4Pevent is Stored." << G4endl;
      }
    }
    else
    {
      st3 = false;
    }
  }
 
  G4bool st = stmct && st1 && st2 && st3;
 
  if(st)
  {
    TransactionManager()->Commit();
    if(m_verbose > 0)
      G4cout << "G4PersistencyManager: event# " << evt->GetEventID()
             << " is stored." << G4endl;
  }
  else
  {
    G4cerr << "G4PersistencyManager::Store(G4Event) - Transaction aborted."
           << G4endl;
    TransactionManager()->Abort();
  }
 
  return st;
}

References G4VTransactionManager::Abort(), G4VTransactionManager::Commit(), G4PersistencyCenter::CurrentStoreMode(), G4PersistencyCenter::CurrentWriteFile(), DigitIO(), EventIO(), f_is_initialized, f_pc, geant4_check_module_cycles::file, G4cerr, G4cout, G4endl, G4Event::GetDCofThisEvent(), G4Event::GetEventID(), G4Event::GetHCofThisEvent(), G4INCL::PhysicalConstants::hc, HitIO(), Initialize(), kOff, kOn, m_verbose, MCTruthIO(), G4VPDigitIO::Store(), G4VPEventIO::Store(), G4VPHitIO::Store(), G4VMCTruthIO::Store(), and TransactionManager().

Store() [2/3]

G4bool G4PersistencyManager::Store ( const G4Run *  )

inlinevirtual

Implements G4VPersistencyManager.

Definition at line 162 of file G4PersistencyManager.hh.

{ return false; }

Store() [3/3]

G4bool G4PersistencyManager::Store ( const G4VPhysicalVolume *  )

inlinevirtual

Implements G4VPersistencyManager.

Definition at line 168 of file G4PersistencyManager.hh.

{ return false; }

TransactionManager()

virtual G4VTransactionManager * G4PersistencyManager::TransactionManager ( )

inlinevirtual

Reimplemented in G4PersistencyManagerT< T >.

Definition at line 145 of file G4PersistencyManager.hh.

{ return nullptr; }

Referenced by Retrieve(), SetVerboseLevel(), Store(), and G4PersistencyManagerT< T >::TransactionManager().

Friends And Related Function Documentation

G4PersistencyCenter

friend class G4PersistencyCenter

friend

Definition at line 112 of file G4PersistencyManager.hh.

Field Documentation

f_is_initialized

G4bool G4PersistencyManager::f_is_initialized = false

private

Definition at line 187 of file G4PersistencyManager.hh.

Referenced by Retrieve(), and Store().

f_pc

G4PersistencyCenter* G4PersistencyManager::f_pc = nullptr

protected

Definition at line 181 of file G4PersistencyManager.hh.

Referenced by G4PersistencyManagerT< T >::Create(), G4PersistencyManager(), Retrieve(), and Store().

fPersistencyManager

G4ThreadLocal G4VPersistencyManager * G4VPersistencyManager::fPersistencyManager = nullptr

staticprivateinherited

Definition at line 79 of file G4VPersistencyManager.hh.

Referenced by G4VPersistencyManager::G4VPersistencyManager(), G4VPersistencyManager::GetPersistencyManager(), and G4VPersistencyManager::~G4VPersistencyManager().

m_verbose

G4int G4PersistencyManager::m_verbose = 0

protected

Definition at line 182 of file G4PersistencyManager.hh.

Referenced by G4PersistencyManager(), G4PersistencyManagerT< T >::G4PersistencyManagerT(), Retrieve(), SetVerboseLevel(), and Store().

nameMgr

G4String G4PersistencyManager::nameMgr

private

Definition at line 186 of file G4PersistencyManager.hh.

Referenced by GetName(), and SetVerboseLevel().

---

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

• source/persistency/mctruth/include/G4PersistencyManager.hh
• source/persistency/mctruth/src/G4PersistencyManager.cc