G4Cache< VALTYPE > Class Template Reference

#include <G4Cache.hh>

Public Types
typedef VALTYPE	value_type

Public Member Functions
	G4Cache ()
	G4Cache (const G4Cache &rhs)
	G4Cache (const value_type &v)
value_type &	Get () const
G4Cache &	operator= (const G4Cache &rhs)
value_type	Pop ()
void	Put (const value_type &val) const
virtual	~G4Cache ()

Protected Member Functions
const G4int &	GetId () const

Private Member Functions
value_type &	GetCache () const

Private Attributes
G4int	id
G4CacheReference< value_type >	theCache

Static Private Attributes
static std::atomic< unsigned int >	dstrctr
static std::atomic< unsigned int >	instancesctr

Detailed Description

template<class VALTYPE>
class G4Cache< VALTYPE >

Definition at line 88 of file G4Cache.hh.

Member Typedef Documentation

value_type

template<class VALTYPE >

typedef VALTYPE G4Cache< VALTYPE >::value_type

Definition at line 91 of file G4Cache.hh.

Constructor & Destructor Documentation

G4Cache() [1/3]

template<class V >

G4Cache< V >::G4Cache

Definition at line 210 of file G4Cache.hh.

{
  G4AutoLock l(G4TypeMutex<G4Cache<V>>());
  id = instancesctr++;
#ifdef g4cdebug
  std::cout << "G4Cache id: " << id << std::endl;
#endif
}

References G4TypeMutex().

G4Cache() [2/3]

template<class VALTYPE >

G4Cache< VALTYPE >::G4Cache

(

const value_type &

v

)

~G4Cache()

template<class V >

G4Cache< V >::~G4Cache

virtual

Definition at line 270 of file G4Cache.hh.

{
#ifdef g4cdebug
  std::cout << "~G4Cache id: " << id << std::endl;
#endif
  // don't automatically lock --> wait until we can catch an error
  // without scoping the G4AutoLock
  //
  G4AutoLock l(G4TypeMutex<G4Cache<V>>(), std::defer_lock);
 
  // sometimes the mutex is unavailable in destructors so
  // try to lock the associated mutex, but catch if it fails
  try
  {
    // a system_error in lock means that the mutex is unavailable
    // we want to throw the error that comes from locking an unavailable
    // mutex so that we know there is a memory leak
    // if the mutex is valid, this will hold until the other thread finishes
    //
    l.lock();
  } catch(std::system_error& e)
  {
    // the error that comes from locking an unavailable mutex
#ifdef G4VERBOSE
    G4cout << "Non-critical error: mutex lock failure in ~G4Cache<"
           << typeid(V).name() << ">. " << G4endl
           << "If the RunManagerKernel has been deleted, it failed to "
           << "delete an allocated resource" << G4endl
           << "and this destructor is being called after the statics "
           << "were destroyed." << G4endl;
    G4cout << "Exception: [code: " << e.code() << "] caught: " << e.what()
           << G4endl;
#endif
  }
  ++dstrctr;
  G4bool last = (dstrctr == instancesctr);
  theCache.Destroy(id, last);
  if(last)
  {
    instancesctr.store(0);
    dstrctr.store(0);
  }
}

References G4cout, G4endl, G4TypeMutex(), G4TemplateAutoLock< _Mutex_t >::lock(), and G4InuclParticleNames::name().

G4Cache() [3/3]

template<class VALTYPE >

G4Cache< VALTYPE >::G4Cache

(

const G4Cache< VALTYPE > &

rhs

)

Member Function Documentation

Get()

template<class V >

V & G4Cache< V >::Get

inline

Definition at line 315 of file G4Cache.hh.

{
  return GetCache();
}

Referenced by G4ParticleHPFinalState::adjust_final_state(), G4FissionLibrary::ApplyYourself(), G4ParticleHP2AInelasticFS::ApplyYourself(), G4ParticleHP2N2AInelasticFS::ApplyYourself(), G4ParticleHP2NAInelasticFS::ApplyYourself(), G4ParticleHP2NDInelasticFS::ApplyYourself(), G4ParticleHP2NInelasticFS::ApplyYourself(), G4ParticleHP2NPInelasticFS::ApplyYourself(), G4ParticleHP2PInelasticFS::ApplyYourself(), G4ParticleHP3AInelasticFS::ApplyYourself(), G4ParticleHP3NAInelasticFS::ApplyYourself(), G4ParticleHP3NInelasticFS::ApplyYourself(), G4ParticleHP3NPInelasticFS::ApplyYourself(), G4ParticleHP4NInelasticFS::ApplyYourself(), G4ParticleHPAInelasticFS::ApplyYourself(), G4ParticleHPCaptureFS::ApplyYourself(), G4ParticleHPD2AInelasticFS::ApplyYourself(), G4ParticleHPDAInelasticFS::ApplyYourself(), G4ParticleHPDInelasticFS::ApplyYourself(), G4ParticleHPElasticFS::ApplyYourself(), G4ParticleHPFissionFS::ApplyYourself(), G4ParticleHPHe3InelasticFS::ApplyYourself(), G4ParticleHPN2AInelasticFS::ApplyYourself(), G4ParticleHPN2PInelasticFS::ApplyYourself(), G4ParticleHPN3AInelasticFS::ApplyYourself(), G4ParticleHPNAInelasticFS::ApplyYourself(), G4ParticleHPND2AInelasticFS::ApplyYourself(), G4ParticleHPNDInelasticFS::ApplyYourself(), G4ParticleHPNHe3InelasticFS::ApplyYourself(), G4ParticleHPNInelasticFS::ApplyYourself(), G4ParticleHPNPAInelasticFS::ApplyYourself(), G4ParticleHPNPInelasticFS::ApplyYourself(), G4ParticleHPNT2AInelasticFS::ApplyYourself(), G4ParticleHPNTInelasticFS::ApplyYourself(), G4ParticleHPNXInelasticFS::ApplyYourself(), G4ParticleHPPAInelasticFS::ApplyYourself(), G4ParticleHPPDInelasticFS::ApplyYourself(), G4ParticleHPPInelasticFS::ApplyYourself(), G4ParticleHPPTInelasticFS::ApplyYourself(), G4ParticleHPT2AInelasticFS::ApplyYourself(), G4ParticleHPTInelasticFS::ApplyYourself(), G4ParticleHPInelasticBaseFS::BaseApply(), G4VectorCache< VALTYPE >::Begin(), G4MapCache< KEYTYPE, VALTYPE >::Begin(), G4BiasingProcessInterface::BuildPhysicsTable(), G4BiasingProcessInterface::BuildWorkerPhysicsTable(), G4VectorCache< VALTYPE >::Clear(), G4ParticleHPContEnergyAngular::ClearHistories(), G4ParticleHPInelasticCompFS::CompositeApply(), G4VectorCache< VALTYPE >::End(), G4MapCache< KEYTYPE, VALTYPE >::End(), G4BiasingProcessInterface::EndTracking(), G4MapCache< KEYTYPE, VALTYPE >::Erase(), G4MapCache< KEYTYPE, VALTYPE >::Find(), G4VBiasingOperator::G4VBiasingOperator(), G4VectorCache< VALTYPE >::G4VectorCache(), G4BiasingOperationManager::GetBiasingOperations(), G4VBiasingOperator::GetBiasingOperators(), G4ParticleHPPhotonDist::GetPhotons(), G4MapCache< KEYTYPE, VALTYPE >::Insert(), G4ThreadLocalSingleton< T >::Instance(), G4PhaseSpaceDecayChannel::ManyBodyDecayIt(), G4ParticleHPContEnergyAngular::MeanEnergyOfThisInteraction(), G4PhaseSpaceDecayChannel::OneBodyDecayIt(), G4VectorCache< VALTYPE >::operator[](), G4VectorCache< VALTYPE >::Pop_back(), G4VectorCache< VALTYPE >::Push_back(), G4ParticleHPContEnergyAngular::Sample(), G4PenelopeBremsstrahlungFS::SampleGammaEnergy(), G4VectorCache< VALTYPE >::Size(), G4MapCache< KEYTYPE, VALTYPE >::Size(), G4BiasingProcessInterface::StartTracking(), G4PhaseSpaceDecayChannel::ThreeBodyDecayIt(), G4PhaseSpaceDecayChannel::TwoBodyDecayIt(), G4ParticleHPInelasticCompFS::use_nresp71_model(), G4ParticleHPContEnergyAngular::~G4ParticleHPContEnergyAngular(), G4ParticleHPFinalState::~G4ParticleHPFinalState(), and G4ParticleHPPhotonDist::~G4ParticleHPPhotonDist().

GetCache()

template<class VALTYPE >

value_type & G4Cache< VALTYPE >::GetCache ( ) const

inlineprivate

Definition at line 124 of file G4Cache.hh.

  {
    theCache.Initialize(id);
    return theCache.GetCache(id);
  }

References G4CacheReference< VALTYPE >::GetCache(), G4CacheReference< VALTYPE >::Initialize(), and G4Cache< VALTYPE >::theCache.

Referenced by G4Cache< VALTYPE >::operator=().

GetId()

template<class VALTYPE >

const G4int & G4Cache< VALTYPE >::GetId ( ) const

inlineprotected

Definition at line 116 of file G4Cache.hh.

{ return id; }

References G4Cache< VALTYPE >::id.

Referenced by G4MapCache< KEYTYPE, VALTYPE >::~G4MapCache().

operator=()

template<class VALTYPE >

G4Cache< V > & G4Cache< V >::operator=

(

const G4Cache< VALTYPE > &

rhs

)

Definition at line 241 of file G4Cache.hh.

{
  if(this == &rhs)
    return *this;
 
  // Force copy of cached data
  //
  V aCopy = rhs.GetCache();
  Put(aCopy);
 
#ifdef g4cdebug
  std::cout << "Assignement operator with id: " << id << std::endl;
#endif
  return *this;
}

References G4Cache< VALTYPE >::GetCache().

Pop()

template<class V >

V G4Cache< V >::Pop

inline

Definition at line 328 of file G4Cache.hh.

{
  return GetCache();
}

Put()

template<class VALTYPE >

void G4Cache< V >::Put ( const value_type &  val ) const

inline

Definition at line 321 of file G4Cache.hh.

{
  GetCache() = val;
}

Referenced by G4FissionLibrary::ApplyYourself(), G4ParticleHPCaptureFS::ApplyYourself(), G4ParticleHPElasticFS::ApplyYourself(), G4ParticleHPFissionFS::ApplyYourself(), G4ParticleHPInelasticBaseFS::BaseApply(), G4BiasingProcessInterface::BuildPhysicsTable(), G4BiasingProcessInterface::BuildWorkerPhysicsTable(), G4ParticleHPInelasticCompFS::CompositeApply(), G4PhaseSpaceDecayChannel::DecayIt(), G4BiasingProcessInterface::EndTracking(), G4BiasingProcessInterface::G4BiasingProcessInterface(), G4ParticleHPContEnergyAngular::G4ParticleHPContEnergyAngular(), G4ParticleHPFinalState::G4ParticleHPFinalState(), G4ParticleHPPhotonDist::G4ParticleHPPhotonDist(), G4PenelopeBremsstrahlungFS::G4PenelopeBremsstrahlungFS(), G4ThreadLocalSingleton< T >::G4ThreadLocalSingleton(), G4VBiasingOperator::G4VBiasingOperator(), G4ThreadLocalSingleton< T >::Instance(), G4ParticleHPContEnergyAngular::MeanEnergyOfThisInteraction(), G4ParticleHPContEnergyAngular::Sample(), G4PenelopeBremsstrahlungFS::SampleGammaEnergy(), and G4BiasingProcessInterface::StartTracking().

Field Documentation

dstrctr

template<class V >

std::atomic< unsigned int > G4Cache< V >::dstrctr

staticprivate

Definition at line 122 of file G4Cache.hh.

id

template<class VALTYPE >

G4int G4Cache< VALTYPE >::id

private

Definition at line 119 of file G4Cache.hh.

Referenced by G4Cache< VALTYPE >::GetId().

instancesctr

template<class V >

std::atomic< unsigned int > G4Cache< V >::instancesctr

staticprivate

Definition at line 121 of file G4Cache.hh.

theCache

template<class VALTYPE >

G4CacheReference<value_type> G4Cache< VALTYPE >::theCache

mutableprivate

Definition at line 120 of file G4Cache.hh.

Referenced by G4Cache< VALTYPE >::GetCache().

---

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

• source/global/management/include/G4Cache.hh