G4TAtomicHitsCollection< T > Class Template Reference

This is an implementation of G4THitsCollection<T> where the underlying type is G4atomic<T>, not just T. More...

#include <Doxymodules_parallel.h>

Inheritance diagram for G4TAtomicHitsCollection< T >:

Public Types
typedef T	base_type
typedef G4atomic< T >	value_type
typedef std::deque< value_type * >	container_type

Public Member Functions
	G4TAtomicHitsCollection ()
	G4TAtomicHitsCollection (G4String detName, G4String colNam)
virtual	~G4TAtomicHitsCollection ()
G4bool	operator== (const G4TAtomicHitsCollection< T > &right) const
virtual void	DrawAllHits ()
virtual void	PrintAllHits ()
value_type *	operator[] (size_t i) const
container_type *	GetVector () const
G4int	insert (T *aHit)
G4int	entries () const
virtual G4VHit *	GetHit (size_t i) const
virtual size_t	GetSize () const

Protected Attributes
container_type *	theCollection
G4Mutex	fMutex

Detailed Description

template<class T>
class G4TAtomicHitsCollection< T >

This is an implementation of G4THitsCollection<T> where the underlying type is G4atomic<T>, not just T.

A static assert is provided to ensure that T is fundamental. This class should be used in lieu of G4THitsCollection<T> when memory is a concern. Atomics are thread-safe and generally faster that mutexes (as long as the STL implementation is lock-free) but the synchronization does not come without a cost. If performance is the primary concern, use G4THitsCollection<T> in thread-local instances.

Definition at line 141 of file Doxymodules_parallel.h.

Member Typedef Documentation

base_type

template<class T >

typedef T G4TAtomicHitsCollection< T >::base_type

Definition at line 88 of file G4TAtomicHitsCollection.hh.

value_type

template<class T >

typedef G4atomic<T> G4TAtomicHitsCollection< T >::value_type

Definition at line 89 of file G4TAtomicHitsCollection.hh.

container_type

template<class T >

typedef std::deque<value_type*> G4TAtomicHitsCollection< T >::container_type

Definition at line 90 of file G4TAtomicHitsCollection.hh.

Constructor & Destructor Documentation

G4TAtomicHitsCollection() [1/2]

template<class T >

G4TAtomicHitsCollection< T >::G4TAtomicHitsCollection

(

)

Definition at line 148 of file G4TAtomicHitsCollection.hh.

  : theCollection(new container_type)
{}

G4TAtomicHitsCollection() [2/2]

template<class T >

G4TAtomicHitsCollection< T >::G4TAtomicHitsCollection	(	G4String	detName,
		G4String	colNam
	)

Definition at line 153 of file G4TAtomicHitsCollection.hh.

  : G4VHitsCollection(detName, colNam)
  , theCollection(new container_type)
{}

~G4TAtomicHitsCollection()

template<class T >

G4TAtomicHitsCollection< T >::~G4TAtomicHitsCollection ( )

virtual

Definition at line 160 of file G4TAtomicHitsCollection.hh.

{
  for(size_t i = 0; i < theCollection->size(); i++)
    delete(*theCollection)[i];
  theCollection->clear();
  delete theCollection;
}

Member Function Documentation

operator==()

template<class T >

G4bool G4TAtomicHitsCollection< T >::operator==

(

const G4TAtomicHitsCollection< T > &

right

)

const

Definition at line 169 of file G4TAtomicHitsCollection.hh.

{
  return (collectionName == right.collectionName);
}

DrawAllHits()

template<class T >

void G4TAtomicHitsCollection< T >::DrawAllHits ( )

virtual

Definition at line 176 of file G4TAtomicHitsCollection.hh.

{
  G4AutoLock l(&fMutex);
  for(size_t i = 0; i < theCollection->size(); i++)
    (*theCollection)[i]->Draw();
}

PrintAllHits()

template<class T >

void G4TAtomicHitsCollection< T >::PrintAllHits ( )

virtual

Definition at line 184 of file G4TAtomicHitsCollection.hh.

{
  G4AutoLock l(&fMutex);
  for(size_t i = 0; i < theCollection->size(); i++)
    (*theCollection)[i]->Print();
}

operator[]()

template<class T >

value_type * G4TAtomicHitsCollection< T >::operator[] ( size_t  i ) const

inline

Definition at line 114 of file G4TAtomicHitsCollection.hh.

{ return (*theCollection)[i]; }

GetVector()

template<class T >

container_type * G4TAtomicHitsCollection< T >::GetVector ( ) const

inline

Definition at line 116 of file G4TAtomicHitsCollection.hh.

{ return theCollection; }

insert()

template<class T >

G4int G4TAtomicHitsCollection< T >::insert ( T *  aHit )

inline

Definition at line 118 of file G4TAtomicHitsCollection.hh.

  {
    G4AutoLock l(&fMutex);
    theCollection->push_back(aHit);
    return theCollection->size();
  }

entries()

template<class T >

G4int G4TAtomicHitsCollection< T >::entries ( ) const

inline

Definition at line 126 of file G4TAtomicHitsCollection.hh.

  {
    G4AutoLock l(&fMutex);
    return theCollection->size();
  }

GetHit()

template<class T >

virtual G4VHit * G4TAtomicHitsCollection< T >::GetHit ( size_t  i ) const

inlinevirtual

Definition at line 134 of file G4TAtomicHitsCollection.hh.

{ return (*theCollection)[i]; }

GetSize()

template<class T >

virtual size_t G4TAtomicHitsCollection< T >::GetSize ( ) const

inlinevirtual

Definition at line 135 of file G4TAtomicHitsCollection.hh.

  {
    G4AutoLock l(&fMutex);
    return theCollection->size();
  }

Member Data Documentation

theCollection

template<class T >

container_type* G4TAtomicHitsCollection< T >::theCollection

protected

Definition at line 142 of file G4TAtomicHitsCollection.hh.

fMutex

template<class T >

G4Mutex G4TAtomicHitsCollection< T >::fMutex

protected

Definition at line 143 of file G4TAtomicHitsCollection.hh.

---

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

• .doxygen/Doxymodules_parallel.h
• extended/parallel/ThreadsafeScorers/include/G4TAtomicHitsCollection.hh