TileRawDataContainer< TCOLLECTION > Class Template Reference

#include <TileRawDataContainer.h>

Inheritance diagram for TileRawDataContainer< TCOLLECTION >:

Collaboration diagram for TileRawDataContainer< TCOLLECTION >:

Public Types
typedef TCOLLECTION::TElement	TElement
typedef TileRawDataContainer< TCOLLECTION >::const_iterator	TContainer_const_iterator
typedef TCOLLECTION::TCollection_const_iterator	TCollection_const_iterator
typedef IdentifiableContainer< TCOLLECTION >	MyBase
typedef TileFragHash::TYPE	TYPE
typedef TileRawChannelUnit::UNIT	UNIT
typedef T	IDENTIFIABLE
typedef EventContainers::IdentifiableCache< T >	ICACHE
typedef IdentifiableContainerMT< T >	MyType
typedef std::vector< std::atomic< const void * > >::size_type	size_type
typedef T *&	reference
typedef T *const &	const_reference
typedef T *	value_type
typedef T **	pointer
typedef T *const *	const_pointer
typedef T	base_value_type
typedef std::vector< IdentifierHash >	Hash_Container

Public Member Functions
	TileRawDataContainer (bool createColl=false, TYPE type=TileFragHash::Digitizer, UNIT unit=TileRawChannelUnit::ADCcounts, SG::OwnershipPolicy ownPolicy=SG::OWN_ELEMENTS)
	TileRawDataContainer (bool createColl, SG::OwnershipPolicy ownPolicy)
virtual	~TileRawDataContainer ()
void	initialize (bool createColl, TYPE type, SG::OwnershipPolicy ownPolicy=SG::OWN_ELEMENTS)
TYPE	get_hashType () const
UNIT	get_unit () const
void	set_unit (UNIT unit)
TYPE	get_type () const
void	set_type (TYPE type)
uint32_t	get_bsflags () const
void	set_bsflags (uint32_t bsflags)
const TileFragHash &	hashFunc () const
virtual void	print () const
virtual	operator std::string () const
virtual std::string	whoami (void) const
virtual bool	hasExternalCache () const override final
virtual const T *	indexFindPtr (IdentifierHash hashId) const override final
	return pointer on the found entry or null if out of range using hashed index - fast version, does not call cnv if object not there More...
const_iterator	indexFind (IdentifierHash hashId) const
virtual StatusCode	addCollection (const T *coll, IdentifierHash hashId) override final
	insert collection into container with id hash if IDC should not take ownership of collection, set ownsColl to false More...
virtual StatusCode	addOrDelete (std::unique_ptr< T >, IdentifierHash hashId) override final
	Tries to add the item to the cache, if the item already exists then it is deleted This is a convenience method for online multithreaded scenarios. More...
virtual StatusCode	addOrDelete (std::unique_ptr< const T >, IdentifierHash hashId) override final
StatusCode	addOrDelete (std::unique_ptr< T >, IdentifierHash hashId, bool &deleted)
	identical to previous excepts allows counting of deletions More...
StatusCode	addLock (std::unique_ptr< T > ptr, IdentifierHash hashId)
	Like the other add methods but optimized for changing from the inprogress state. More...
virtual bool	tryAddFromCache (IdentifierHash hashId) override final
	Looks in the cache to see if item already exists if not it returns false, If it does exist it incorporates it into the IDC view but changing the mask. More...
StatusCode	fetchOrCreate (IdentifierHash hashId)
	Tries will look for item in cache, if it doesn't exist will call the cache IMAKER If cache doesn't have an IMAKER then this fails. More...
StatusCode	fetchOrCreate (const std::vector< IdentifierHash > &hashId)
virtual StatusCode naughtyRetrieve	ATLAS_NOT_THREAD_SAFE (IdentifierHash hashId, T *&collToRetrieve) const override final
T *	removeCollection (IdentifierHash hashId)
	remove collection from container for id hash, returning it (and ownership) to client More...
virtual void	cleanup () override final
	reset m_hashids and call IdentifiableCache's cleanup More...
virtual size_t	fullSize () const override final
	return full size of container More...
size_t	size () const
	Duplicate of fullSize for backwards compatability. More...
void	prepareItr () const
virtual size_t	numberOfCollections () const override final
	return number of collections More...
const std::vector< EventContainers::hashPair< T > > &	GetAllHashPtrPair () const
virtual std::vector< IdentifierHash >	GetAllCurrentHashes () const override final
	Returns a collection of all hashes availiable in this IDC. More...
const_iterator	begin () const
	return const_iterator for first entry More...
const_iterator	end () const
	return const_iterator for end of container More...
bool	empty () const
	return true if container is empty More...
IDC_WriteHandle	getWriteHandle (IdentifierHash hash)
virtual StatusCode	naughtyRetrieve (IdentifierHash hashId, T *&collToRetrieve) const =0

Protected Types
typedef EventContainers::IdentifiableCacheBase	IdentifiableCacheBase

Protected Member Functions
bool	tryAddFromCache (IdentifierHash hashId, EventContainers::IDC_WriteHandleBase &lock)
void	cleanup (deleter_f *deleter)
bool	insert (IdentifierHash hashId, const void *ptr)
void	Wait () const
void	ResetMask ()

Protected Attributes
bool	m_OnlineMode
std::unique_ptr< I_InternalIDC >	m_link

Private Attributes
UNIT	m_unit
TYPE	m_type
uint32_t	m_bsflags
TileFragHash	m_hashFunc

Detailed Description

template<typename TCOLLECTION>
class TileRawDataContainer< TCOLLECTION >

Definition at line 32 of file TileRawDataContainer.h.

Member Typedef Documentation

base_value_type

template<class T >

typedef T IdentifiableContainerMT< T >::base_value_type

inherited

Definition at line 75 of file IdentifiableContainerMT.h.

const_pointer

template<class T >

typedef T* const* IdentifiableContainerMT< T >::const_pointer

inherited

Definition at line 74 of file IdentifiableContainerMT.h.

const_reference

template<class T >

typedef T* const& IdentifiableContainerMT< T >::const_reference

inherited

Definition at line 71 of file IdentifiableContainerMT.h.

Hash_Container

typedef std::vector<IdentifierHash> EventContainers::IdentifiableContainerBase::Hash_Container

inherited

Definition at line 18 of file IdentifiableContainerBase.h.

ICACHE

template<class T >

typedef EventContainers::IdentifiableCache<T> IdentifiableContainerMT< T >::ICACHE

inherited

Definition at line 67 of file IdentifiableContainerMT.h.

IDENTIFIABLE

template<class T >

typedef T IdentifiableContainerMT< T >::IDENTIFIABLE

inherited

Definition at line 66 of file IdentifiableContainerMT.h.

IdentifiableCacheBase

typedef EventContainers::IdentifiableCacheBase EventContainers::IdentifiableContainerBase::IdentifiableCacheBase

protectedinherited

Definition at line 25 of file IdentifiableContainerBase.h.

MyBase

template<typename TCOLLECTION >

typedef IdentifiableContainer<TCOLLECTION> TileRawDataContainer< TCOLLECTION >::MyBase

Definition at line 41 of file TileRawDataContainer.h.

MyType

template<class T >

typedef IdentifiableContainerMT<T> IdentifiableContainerMT< T >::MyType

inherited

Definition at line 68 of file IdentifiableContainerMT.h.

pointer

template<class T >

typedef T** IdentifiableContainerMT< T >::pointer

inherited

Definition at line 73 of file IdentifiableContainerMT.h.

reference

template<class T >

typedef T*& IdentifiableContainerMT< T >::reference

inherited

Definition at line 70 of file IdentifiableContainerMT.h.

size_type

template<class T >

typedef std::vector<std::atomic<const void*> >::size_type IdentifiableContainerMT< T >::size_type

inherited

Definition at line 69 of file IdentifiableContainerMT.h.

TCollection_const_iterator

template<typename TCOLLECTION >

typedef TCOLLECTION::TCollection_const_iterator TileRawDataContainer< TCOLLECTION >::TCollection_const_iterator

Definition at line 39 of file TileRawDataContainer.h.

TContainer_const_iterator

template<typename TCOLLECTION >

typedef TileRawDataContainer<TCOLLECTION>::const_iterator TileRawDataContainer< TCOLLECTION >::TContainer_const_iterator

Definition at line 38 of file TileRawDataContainer.h.

TElement

template<typename TCOLLECTION >

typedef TCOLLECTION::TElement TileRawDataContainer< TCOLLECTION >::TElement

Definition at line 37 of file TileRawDataContainer.h.

TYPE

template<typename TCOLLECTION >

typedef TileFragHash::TYPE TileRawDataContainer< TCOLLECTION >::TYPE

Definition at line 42 of file TileRawDataContainer.h.

UNIT

template<typename TCOLLECTION >

typedef TileRawChannelUnit::UNIT TileRawDataContainer< TCOLLECTION >::UNIT

Definition at line 43 of file TileRawDataContainer.h.

value_type

template<class T >

typedef T* IdentifiableContainerMT< T >::value_type

inherited

Definition at line 72 of file IdentifiableContainerMT.h.

Constructor & Destructor Documentation

TileRawDataContainer() [1/2]

template<typename TCOLLECTION >

TileRawDataContainer< TCOLLECTION >::TileRawDataContainer	(	bool	createColl = false,
		TYPE	type = TileFragHash::Digitizer,
		UNIT	unit = TileRawChannelUnit::ADCcounts,
		SG::OwnershipPolicy	ownPolicy = SG::OWN_ELEMENTS
	)

TileRawDataContainer() [2/2]

template<typename TCOLLECTION >

TileRawDataContainer< TCOLLECTION >::TileRawDataContainer	(	bool	createColl,
		SG::OwnershipPolicy	ownPolicy
	)

~TileRawDataContainer()

template<typename TCOLLECTION >

virtual TileRawDataContainer< TCOLLECTION >::~TileRawDataContainer ( )

inlinevirtual

Definition at line 53 of file TileRawDataContainer.h.

{ }

Member Function Documentation

addCollection()

template<class T >

StatusCode IdentifiableContainerMT< T >::addCollection ( const T *  coll, IdentifierHash  hashId  )

finaloverridevirtualinherited

insert collection into container with id hash if IDC should not take ownership of collection, set ownsColl to false

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 297 of file IdentifiableContainerMT.h.

{
    // update m_hashids
    if (ATH_UNLIKELY(! IdentifiableContainerBase::insert(hashId, coll))) return StatusCode::FAILURE;
    return StatusCode::SUCCESS;
 
}

addLock()

template<class T >

StatusCode IdentifiableContainerMT< T >::addLock ( std::unique_ptr< T >  ptr, IdentifierHash  hashId  )

inherited

Like the other add methods but optimized for changing from the inprogress state.

Definition at line 372 of file IdentifiableContainerMT.h.

{
    return m_link->addLock(hashId, ptr.release());
}

addOrDelete() [1/3]

template<class T >

virtual StatusCode IdentifiableContainerMT< T >::addOrDelete ( std::unique_ptr< const T >  , IdentifierHash  hashId  )

finaloverridevirtualinherited

Implements EventContainers::IIdentifiableCont< T >.

addOrDelete() [2/3]

template<class T >

StatusCode IdentifiableContainerMT< T >::addOrDelete ( std::unique_ptr< T >  uptr, IdentifierHash  hashId  )

finaloverridevirtualinherited

Tries to add the item to the cache, if the item already exists then it is deleted This is a convenience method for online multithreaded scenarios.

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 350 of file IdentifiableContainerMT.h.

{
    if(ATH_UNLIKELY(hashId >= m_link->fullSize())) return StatusCode::FAILURE;
    auto ptr = uptr.release();
    bool b = IdentifiableContainerBase::insert(hashId, ptr);
    if(!b) delete ptr;
    return StatusCode::SUCCESS;
}

addOrDelete() [3/3]

template<class T >

StatusCode IdentifiableContainerMT< T >::addOrDelete ( std::unique_ptr< T >  uptr, IdentifierHash  hashId, bool &  deleted  )

inherited

identical to previous excepts allows counting of deletions

Definition at line 379 of file IdentifiableContainerMT.h.

{
    if(ATH_UNLIKELY(hashId >= m_link->fullSize())) return StatusCode::FAILURE;
    auto ptr = uptr.release();
    bool b = IdentifiableContainerBase::insert(hashId, ptr);
    if(!b) delete ptr;
    deleted = !b;
    return StatusCode::SUCCESS;
}

ATLAS_NOT_THREAD_SAFE()

template<class T >

virtual StatusCode naughtyRetrieve IdentifiableContainerMT< T >::ATLAS_NOT_THREAD_SAFE ( IdentifierHash  hashId, T *&  collToRetrieve  ) const

finaloverridevirtualinherited

begin()

template<class T >

const_iterator IdentifiableContainerMT< T >::begin ( ) const

inlineinherited

return const_iterator for first entry

Definition at line 233 of file IdentifiableContainerMT.h.

                                 {
        return const_iterator(m_link->cbegin());
    }

cleanup() [1/2]

template<class T >

void IdentifiableContainerMT< T >::cleanup

finaloverridevirtualinherited

reset m_hashids and call IdentifiableCache's cleanup

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 309 of file IdentifiableContainerMT.h.

{
    IdentifiableContainerBase::cleanup(void_unique_ptr::Deleter<T>::deleter);
}

cleanup() [2/2]

void IdentifiableContainerBase::cleanup ( deleter_f *  deleter )

protectedinherited

Definition at line 38 of file IdentifiableContainerBase.cxx.

                                                            {
    if(m_OnlineMode) throw std::runtime_error("Not implemented in online mode");
    m_link->cleanUp(deleter);
  }

empty()

template<class T >

bool IdentifiableContainerMT< T >::empty ( ) const

inlineinherited

return true if container is empty

Definition at line 244 of file IdentifiableContainerMT.h.

                       {
        return numberOfCollections()==0;
    }

end()

template<class T >

const_iterator IdentifiableContainerMT< T >::end ( ) const

inlineinherited

return const_iterator for end of container

Definition at line 239 of file IdentifiableContainerMT.h.

                               {
        return const_iterator(m_link->cend());
    }

fetchOrCreate() [1/2]

template<class T >

StatusCode IdentifiableContainerMT< T >::fetchOrCreate ( const std::vector< IdentifierHash > &  hashId )

inherited

Definition at line 323 of file IdentifiableContainerMT.h.

{
    return IdentifiableContainerBase::fetchOrCreate(hashIds);
}

fetchOrCreate() [2/2]

template<class T >

StatusCode IdentifiableContainerMT< T >::fetchOrCreate ( IdentifierHash  hashId )

inherited

Tries will look for item in cache, if it doesn't exist will call the cache IMAKER If cache doesn't have an IMAKER then this fails.

Definition at line 316 of file IdentifiableContainerMT.h.

{
    return IdentifiableContainerBase::fetchOrCreate(hashId);
}

fullSize()

template<class T >

virtual size_t IdentifiableContainerMT< T >::fullSize ( ) const

inlinefinaloverridevirtualinherited

return full size of container

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 201 of file IdentifiableContainerMT.h.

                                                    {
        return m_link->fullSize();
    }

get_bsflags()

template<typename TCOLLECTION >

uint32_t TileRawDataContainer< TCOLLECTION >::get_bsflags ( ) const

inline

Definition at line 64 of file TileRawDataContainer.h.

{ return this->m_bsflags; }

get_hashType()

template<typename TCOLLECTION >

TYPE TileRawDataContainer< TCOLLECTION >::get_hashType ( ) const

inline

Definition at line 59 of file TileRawDataContainer.h.

{ return this->m_hashFunc.type(); }

get_type()

template<typename TCOLLECTION >

TYPE TileRawDataContainer< TCOLLECTION >::get_type ( ) const

inline

Definition at line 62 of file TileRawDataContainer.h.

{ return this->m_type; }

get_unit()

template<typename TCOLLECTION >

UNIT TileRawDataContainer< TCOLLECTION >::get_unit ( ) const

inline

Definition at line 60 of file TileRawDataContainer.h.

{ return this->m_unit; }

GetAllCurrentHashes()

template<class T >

virtual std::vector<IdentifierHash> IdentifiableContainerMT< T >::GetAllCurrentHashes ( ) const

inlinefinaloverridevirtualinherited

Returns a collection of all hashes availiable in this IDC.

If this is an "offline" mode IDC then this is identical to the cache If this is an "online" mode IDC then this is the items that both exist in the cache and have a postive mask element

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 228 of file IdentifiableContainerMT.h.

                                                                                 {
        return IdentifiableContainerBase::GetAllCurrentHashes();
    }

GetAllHashPtrPair()

template<class T >

const std::vector< EventContainers::hashPair<T> >& IdentifiableContainerMT< T >::GetAllHashPtrPair ( ) const

inlineinherited

Definition at line 217 of file IdentifiableContainerMT.h.

                                                                             {
        static_assert(sizeof(const T*) == sizeof(const void*) && std::is_pointer<const T*>::value);
        static_assert(sizeof(EventContainers::hashPair<T>) == sizeof(EventContainers::hashPair<void>));
        return reinterpret_cast<const std::vector < EventContainers::hashPair<T> >&>
                (m_link->getAllHashPtrPair());
    }

getWriteHandle()

template<class T >

IDC_WriteHandle IdentifiableContainerMT< T >::getWriteHandle ( IdentifierHash  hash )

inlineinherited

Definition at line 248 of file IdentifiableContainerMT.h.

    {
       IDC_WriteHandle lock;
       lock.m_hashId = hash;
       lock.m_IDC_ptr = this;
       return lock;
    }

hasExternalCache()

template<class T >

virtual bool IdentifiableContainerMT< T >::hasExternalCache ( ) const

inlinefinaloverridevirtualinherited

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 152 of file IdentifiableContainerMT.h.

{ return m_OnlineMode; }

hashFunc()

template<typename TCOLLECTION >

const TileFragHash& TileRawDataContainer< TCOLLECTION >::hashFunc ( ) const

inline

Definition at line 66 of file TileRawDataContainer.h.

{ return this->m_hashFunc; }

indexFind()

template<class T >

const_iterator IdentifiableContainerMT< T >::indexFind ( IdentifierHash  hashId ) const

inlineinherited

Definition at line 160 of file IdentifiableContainerMT.h.

                                                            {
        return m_link->indexFind(hashId);
    }

indexFindPtr()

template<class T >

const T * IdentifiableContainerMT< T >::indexFindPtr ( IdentifierHash  hashId ) const

finaloverridevirtualinherited

return pointer on the found entry or null if out of range using hashed index - fast version, does not call cnv if object not there

return valuetype on the found entry or null if out of range using hashed index - fast version, does not call cnv if object not there

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 289 of file IdentifiableContainerMT.h.

{
    return reinterpret_cast<const T* > (IdentifiableContainerBase::indexFindPtr(hashId));
}

initialize()

template<typename TCOLLECTION >

void TileRawDataContainer< TCOLLECTION >::initialize	(	bool	createColl,
		TYPE	type,
		SG::OwnershipPolicy	ownPolicy = SG::OWN_ELEMENTS
	)

insert()

bool EventContainers::IdentifiableContainerBase::insert ( IdentifierHash  hashId, const void *  ptr  )

inlineprotectedinherited

Definition at line 28 of file IdentifiableContainerBase.h.

{ return m_link->insert(hashId, ptr); }

naughtyRetrieve()

template<class T >

virtual StatusCode EventContainers::IIdentifiableCont< T >::naughtyRetrieve ( IdentifierHash  hashId, T *&  collToRetrieve  ) const

pure virtualinherited

numberOfCollections()

template<class T >

virtual size_t IdentifiableContainerMT< T >::numberOfCollections ( ) const

inlinefinaloverridevirtualinherited

return number of collections

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 213 of file IdentifiableContainerMT.h.

                                                             {
        return IdentifiableContainerBase::numberOfCollections();
    }

operator std::string()

template<typename TCOLLECTION >

virtual TileRawDataContainer< TCOLLECTION >::operator std::string ( ) const

virtual

prepareItr()

template<class T >

void IdentifiableContainerMT< T >::prepareItr ( ) const

inlineinherited

Definition at line 210 of file IdentifiableContainerMT.h.

{ m_link->wait(); }

print()

template<typename TCOLLECTION >

virtual void TileRawDataContainer< TCOLLECTION >::print ( ) const

virtual

removeCollection()

template<class T >

T * IdentifiableContainerMT< T >::removeCollection ( IdentifierHash  hashId )

inherited

remove collection from container for id hash, returning it (and ownership) to client

Definition at line 259 of file IdentifiableContainerMT.h.

{
    return reinterpret_cast<T*>(m_link->removeCollection(hashId));
}

ResetMask()

void EventContainers::IdentifiableContainerBase::ResetMask ( )

protectedinherited

set_bsflags()

template<typename TCOLLECTION >

void TileRawDataContainer< TCOLLECTION >::set_bsflags ( uint32_t  bsflags )

inline

Definition at line 65 of file TileRawDataContainer.h.

{ m_bsflags=bsflags; }

set_type()

template<typename TCOLLECTION >

void TileRawDataContainer< TCOLLECTION >::set_type ( TYPE  type )

inline

Definition at line 63 of file TileRawDataContainer.h.

{ m_type=type; }

set_unit()

template<typename TCOLLECTION >

void TileRawDataContainer< TCOLLECTION >::set_unit ( UNIT  unit )

inline

Definition at line 61 of file TileRawDataContainer.h.

{ m_unit=unit; }

size()

template<class T >

size_t IdentifiableContainerMT< T >::size ( ) const

inlineinherited

Duplicate of fullSize for backwards compatability.

Definition at line 206 of file IdentifiableContainerMT.h.

                        {
        return m_link->fullSize();
    }    

tryAddFromCache() [1/2]

template<class T >

bool IdentifiableContainerMT< T >::tryAddFromCache ( IdentifierHash  hashId )

finaloverridevirtualinherited

Looks in the cache to see if item already exists if not it returns false, If it does exist it incorporates it into the IDC view but changing the mask.

Implements EventContainers::IIdentifiableCont< T >.

Definition at line 331 of file IdentifiableContainerMT.h.

{
    return IdentifiableContainerBase::tryAddFromCache(hashId);
}

tryAddFromCache() [2/2]

bool EventContainers::IdentifiableContainerBase::tryAddFromCache ( IdentifierHash  hashId, EventContainers::IDC_WriteHandleBase &  lock  )

inlineprotectedinherited

Definition at line 30 of file IdentifiableContainerBase.h.

                                                                                          { 
        return m_link->tryAddFromCache(hashId, lock); }

Wait()

void EventContainers::IdentifiableContainerBase::Wait ( ) const

inlineprotectedinherited

Definition at line 29 of file IdentifiableContainerBase.h.

{ m_link->wait(); }

whoami()

template<typename TCOLLECTION >

virtual std::string TileRawDataContainer< TCOLLECTION >::whoami ( void  ) const

inlinevirtual

Definition at line 71 of file TileRawDataContainer.h.

                                          { TCOLLECTION  coll;
                 return "TileRawDataContainer of "+coll.whoami(); }

Member Data Documentation

m_bsflags

template<typename TCOLLECTION >

uint32_t TileRawDataContainer< TCOLLECTION >::m_bsflags

private

Definition at line 78 of file TileRawDataContainer.h.

m_hashFunc

template<typename TCOLLECTION >

TileFragHash TileRawDataContainer< TCOLLECTION >::m_hashFunc

private

Definition at line 80 of file TileRawDataContainer.h.

m_link

std::unique_ptr<I_InternalIDC> EventContainers::IdentifiableContainerBase::m_link

protectedinherited

Definition at line 26 of file IdentifiableContainerBase.h.

m_OnlineMode

bool EventContainers::IdentifiableContainerBase::m_OnlineMode

protectedinherited

Definition at line 24 of file IdentifiableContainerBase.h.

m_type

template<typename TCOLLECTION >

TYPE TileRawDataContainer< TCOLLECTION >::m_type

private

Definition at line 77 of file TileRawDataContainer.h.

m_unit

template<typename TCOLLECTION >

UNIT TileRawDataContainer< TCOLLECTION >::m_unit

private

Definition at line 76 of file TileRawDataContainer.h.

---

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

• TileRawDataContainer.h