#include <IndexMap.h>

Inheritance diagram for D3PD::IndexMap:

Collaboration diagram for D3PD::IndexMap:

Public Member Functions
	IndexMap (INamedInterface *parent, const std::string &targetLabel, ToolHandle< ICollectionGetterRegistryTool > &registry, const bool &allowMissing)
	Constructor: for a single target. More...

	IndexMap (INamedInterface *parent, const std::string &targetLabel, const std::vector< std::string > &targetLabels, ToolHandle< ICollectionGetterRegistryTool > &registry, const bool &allowMissing)
	Constructor: for multiple targets. More...

	IndexMap (INamedInterface *parent, ToolHandleArray< ICollectionGetterTool > &getters, const bool &allowMissing)
	Constructor: passing the list of getters directly. More...

StatusCode	configureD3PD ()
	Configure during initialization: type-check. More...

StatusCode	configureD3PD (const std::type_info &ti)
	Configure during initialization: type-check. More...

ICollectionGetterTool *	target ()
	Return the getter defining the first collection within which to index. More...

ICollectionGetterTool *	target (unsigned int i)
	Return the getter defining the i'th collection within which to index. More...

int	ntargets ()
	Return the number of valid targets. More...

virtual void	handle (const Incident &inc)
	Incident handler. More...

StatusCode	reset ()
	Call before asking for an index. Rebuilds cache if needed. More...

int	findIndex (const void *p)
	Find the index corresponding to an element. More...

int	findIndex (const void *p, unsigned int i)
	Find the index corresponding to an element within a specific container. More...

std::pair< int, int >	findIndexPair (const void *p)
	Find the (index,container) pair corresponding to an element. More...

bool	valid () const
	Return the valid flag. More...

std::string	formatLabels () const
	Return list of all configured targets as a comma-separated string. More...

virtual unsigned long	addRef ()
	Dummies needed to satisfy IInterface requirements. More...

virtual unsigned long	release ()

virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)

Private Types
typedef std::unordered_multimap< const void *, std::pair< int, int > >	map_t
	The pointer -> (index,target) map. More...

Private Member Functions
StatusCode	configureCommon ()
	Common part of configuration. More...

Private Attributes
INamedInterface *	m_parent
	The parent tool. More...

const std::string *	m_targetLabel
	Property for the label of the getter defining the target collection. More...

const std::vector< std::string > *	m_targetLabels
	Property for the label of the getter defining the list of target collections. More...

ToolHandle< ICollectionGetterRegistryTool > *	m_registry
	Property for the ICollectionGetterRegistryTool instance. More...

ToolHandleArray< ICollectionGetterTool > *	m_getters
	Property for a direct list of getters. More...

const bool &	m_allowMissing
	Property for the allowMissing flag. More...

std::vector< ICollectionGetterTool * >	m_targets
	Getters defining the collections within which to index. More...

map_t	m_map

bool	m_valid
	Flag if the map is valid. More...

std::vector< TypeConverter >	m_converters
	Converter for each target. More...

Detailed Description

Definition at line 42 of file IndexMap.h.

Member Typedef Documentation

◆ map_t

typedef std::unordered_multimap<const void*, std::pair<int, int> > D3PD::IndexMap::map_t

private

The pointer -> (index,target) map.

Definition at line 199 of file IndexMap.h.

Constructor & Destructor Documentation

◆ IndexMap() [1/3]

D3PD::IndexMap::IndexMap	(	INamedInterface *	parent,
		const std::string &	targetLabel,
		ToolHandle< ICollectionGetterRegistryTool > &	registry,
		const bool &	allowMissing
	)

Constructor: for a single target.

Parameters

parent	The parent tool.
targetLabel	Property for the label of the getter defining the target collection.
registry	Property for the ICollectionGetterRegistryTool instance.
allowMissing	Property for the allowMissing flag.

Definition at line 31 of file IndexMap.cxx.

   : m_parent (parent),
     m_targetLabel (&targetLabel),
     m_targetLabels (0),
     m_registry (&registry),
     m_getters (0),
     m_allowMissing (allowMissing),
     m_valid (false)
 {
 }

◆ IndexMap() [2/3]

D3PD::IndexMap::IndexMap	(	INamedInterface *	parent,
		const std::string &	targetLabel,
		const std::vector< std::string > &	targetLabels,
		ToolHandle< ICollectionGetterRegistryTool > &	registry,
		const bool &	allowMissing
	)

Constructor: for multiple targets.

Constructor.

Parameters

parent	The parent tool.
targetLabel	Property for the label of the getter defining the target collection. If non-empty, this will be considered to be at the start of targetLabels.
targetLabels	Property for the label of the getter defining the target collection.
registry	Property for the ICollectionGetterRegistryTool instance.
allowMissing	Property for the allowMissing flag.

Constructor: for multiple targets.

Parameters

targetLabel	Property for the label of the getter defining the target collection. If non-empty, this will be considered to be at the start of targetLabels.
targetLabels	Property for the label of the getter defining the target collection.
registry	Property for the ICollectionGetterRegistryTool instance.
allowMissing	Property for the allowMissing flag.

Definition at line 58 of file IndexMap.cxx.

   : m_parent (parent),
     m_targetLabel (&targetLabel),
     m_targetLabels (&targetLabels),
     m_registry (&registry),
     m_getters (0),
     m_allowMissing (allowMissing),
     m_valid (false)
 {
 }

◆ IndexMap() [3/3]

D3PD::IndexMap::IndexMap	(	INamedInterface *	parent,
		ToolHandleArray< ICollectionGetterTool > &	getters,
		const bool &	allowMissing
	)

Constructor: passing the list of getters directly.

Parameters

parent	The parent tool.
getters	Property for the list of getters.
allowMissing	Property for the allowMissing flag.

Definition at line 80 of file IndexMap.cxx.

   : m_parent (parent),
     m_targetLabel (0),
     m_targetLabels (0),
     m_registry (0),
     m_getters (&getters),
     m_allowMissing (allowMissing),
     m_valid (false)
 {
 }

Member Function Documentation

◆ addRef()

unsigned long D3PD::IndexMap::addRef ( )

virtual

Dummies needed to satisfy IInterface requirements.

Definition at line 340 of file IndexMap.cxx.

340 { return 0; }

◆ configureCommon()

StatusCode D3PD::IndexMap::configureCommon ( )

private

Common part of configuration.

Definition at line 97 of file IndexMap.cxx.

 {
   ServiceHandle<IIncidentSvc> incSvc ("IncidentSvc", "IndexMap");
   CHECK( incSvc.retrieve() );
   incSvc->addListener (this, "EndEvent");
  
   if (m_registry) {
     // Look up targets by label.
     CHECK( m_registry->retrieve() );
  
     if (!m_targetLabel->empty()) {
       ICollectionGetterTool* target = 0;
       CHECK( (*m_registry)->get (*m_targetLabel, m_parent, target) );
       m_targets.push_back (target);
     }
     if (m_targetLabels) {
       for (size_t i = 0; i < m_targetLabels->size(); i++) {
         ICollectionGetterTool* target = 0;
         CHECK( (*m_registry)->get ((*m_targetLabels)[i], m_parent, target) );
         m_targets.push_back (target);
       }
     }
   }
   else {
     // Use direct list of getters.
     CHECK( m_getters->retrieve() );
     for (size_t i = 0; i < m_getters->size(); i++)
       m_targets.push_back (&*(*m_getters)[i]);
   }
  
   m_converters.resize (m_targets.size());
   return StatusCode::SUCCESS;
 }

◆ configureD3PD() [1/2]

StatusCode D3PD::IndexMap::configureD3PD ( )

Configure during initialization: type-check.

If this is used, the pointer type passed in should match that of the target container(s).

Definition at line 137 of file IndexMap.cxx.

 {
   CHECK( configureCommon() );
  
   // Configure the converters to expect the types of the
   // target containers.
   for (size_t i = 0; i < m_targets.size(); i++) {
     if (m_targets[i])
       CHECK( m_converters[i].init (m_targets[i]->elementTypeinfo(),
                                    m_targets[i]->elementTypeinfo()) );
   }
   return StatusCode::SUCCESS;
 }

◆ configureD3PD() [2/2]

StatusCode D3PD::IndexMap::configureD3PD ( const std::type_info & ti )

Configure during initialization: type-check.

Parameters

The	pointer type that will be passed into the find methods.
The	pointer type that will be passed into the find methods.

If this is used, the pointer type passed in should match that of the target container(s).

Definition at line 159 of file IndexMap.cxx.

 {
   CHECK( configureCommon() );
  
   // Configure the converters.
   for (size_t i = 0; i < m_targets.size(); i++) {
     if (m_targets[i])
       CHECK( m_converters[i].init (m_targets[i]->elementTypeinfo(), ti) );
   }
   return StatusCode::SUCCESS;
 }

◆ findIndex() [1/2]

int D3PD::IndexMap::findIndex ( const void * p )

Find the index corresponding to an element.

Parameters

p	The pointer to find.

Returns -1 if the pointer isn't found.

Definition at line 255 of file IndexMap.cxx.

 {
   return findIndexPair(p).first;
 }

◆ findIndex() [2/2]

int D3PD::IndexMap::findIndex	(	const void *	p,
		unsigned int	i
	)

Find the index corresponding to an element within a specific container.

Parameters

p	The pointer to find.
i	The index of the target in which to search.

Returns -1 if the pointer isn't found.

Definition at line 270 of file IndexMap.cxx.

 {
   int ret = -1;
   for (map_t::iterator it = m_map.find (p);
        it != m_map.end() && it->first == p;
        ++it)
   {
     if (it->second.second == static_cast<int>(i)) {
       ret = it->second.first;
       break;
     }
   }
   return ret;
 }

◆ findIndexPair()

std::pair< int, int > D3PD::IndexMap::findIndexPair ( const void * p )

Find the (index,container) pair corresponding to an element.

Parameters

p	The pointer to find.

Returns (-1,-1) if the pointer isn't found.

Definition at line 293 of file IndexMap.cxx.

 {
   map_t::iterator it = m_map.find (p);
   std::pair<int, int> ret (-1, -1);
   if (it == m_map.end())
     return ret;
  
   // In case of multiple matches, return the first (smallest index)
   // matching container.
   ret = it->second;
   for (++it; it != m_map.end() && it->first == p; ++it) {
     if (it->second.second < ret.second)
       ret = it->second;
   }
  
   return ret;
 }

◆ formatLabels()

std::string D3PD::IndexMap::formatLabels ( ) const

Return list of all configured targets as a comma-separated string.

Definition at line 325 of file IndexMap.cxx.

 {
   std::string out = *m_targetLabel;
   if (m_targetLabels) {
     for (const std::string& l : *m_targetLabels) {
       if (!out.empty())
         out += ",";
       out += l;
     }
   }
   return out;
 }

◆ handle()

void D3PD::IndexMap::handle ( const Incident & inc )

virtual

Incident handler.

Parameters

inc	The incident.

Definition at line 214 of file IndexMap.cxx.

 {
   if (inc.type() == "EndEvent")
   {
     m_map.clear();
     m_valid = false;
   }
 }

◆ ntargets()

int D3PD::IndexMap::ntargets ( )

Return the number of valid targets.

Definition at line 199 of file IndexMap.cxx.

 {
   int n = 0;
   for (size_t i = 0; i < m_targets.size(); i++) {
     if (m_targets[i])
       ++n;
   }
   return n;
 }

◆ queryInterface()

StatusCode D3PD::IndexMap::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)

virtual

Definition at line 342 of file IndexMap.cxx.

344 { return StatusCode::FAILURE; }

◆ release()

unsigned long D3PD::IndexMap::release ( )

virtual

Definition at line 341 of file IndexMap.cxx.

341 { return 0; }

◆ reset()

StatusCode D3PD::IndexMap::reset ( )

Call before asking for an index. Rebuilds cache if needed.

Call before asking for an index.

Rebuilds cache if needed.

Definition at line 227 of file IndexMap.cxx.

 {
   if (!m_valid) {
     for (size_t i = 0; i < m_targets.size(); i++) {
       ICollectionGetterTool* target = m_targets[i];
       if (target) {
         CHECK( target->reset (m_allowMissing) );
         int idx = 0;
         while (const void* obj = target->nextUntyped() ) {
           const void* cobj = m_converters[i].convertUntyped (obj);
           if (cobj)
             m_map.insert (std::make_pair (cobj, std::make_pair(idx++, (int)i)));
           target->releaseObjectUntyped (obj);
         }
       }
     }
     m_valid = true;
   }
   return StatusCode::SUCCESS;
 }

◆ target() [1/2]

ICollectionGetterTool * D3PD::IndexMap::target ( )

Return the getter defining the first collection within which to index.

Definition at line 175 of file IndexMap.cxx.

 {
   for (size_t i = 0; i < m_targets.size(); i++) {
     if (m_targets[i])
       return m_targets[i];
   }
   return 0;
 }

◆ target() [2/2]

ICollectionGetterTool * D3PD::IndexMap::target ( unsigned int i )

Return the getter defining the i'th collection within which to index.

Definition at line 188 of file IndexMap.cxx.

 {
   if (i >= m_targets.size())
     return 0;
   return m_targets[i];
 }

◆ valid()

bool D3PD::IndexMap::valid ( ) const

Return the valid flag.

Definition at line 316 of file IndexMap.cxx.

 {
   return m_valid;
 }

Member Data Documentation

◆ m_allowMissing

const bool& D3PD::IndexMap::m_allowMissing

private

Property for the allowMissing flag.

Definition at line 193 of file IndexMap.h.

◆ m_converters

std::vector<TypeConverter> D3PD::IndexMap::m_converters

private

Converter for each target.

Definition at line 206 of file IndexMap.h.

◆ m_getters

ToolHandleArray<ICollectionGetterTool>* D3PD::IndexMap::m_getters

private

Property for a direct list of getters.

Definition at line 190 of file IndexMap.h.

◆ m_map

map_t D3PD::IndexMap::m_map

private

Definition at line 200 of file IndexMap.h.

◆ m_parent

INamedInterface* D3PD::IndexMap::m_parent

private

The parent tool.

Definition at line 177 of file IndexMap.h.

◆ m_registry

ToolHandle<ICollectionGetterRegistryTool>* D3PD::IndexMap::m_registry

private

Property for the ICollectionGetterRegistryTool instance.

Definition at line 187 of file IndexMap.h.

◆ m_targetLabel

const std::string* D3PD::IndexMap::m_targetLabel

private

Property for the label of the getter defining the target collection.

Definition at line 180 of file IndexMap.h.

◆ m_targetLabels

const std::vector<std::string>* D3PD::IndexMap::m_targetLabels

private

Property for the label of the getter defining the list of target collections.

Definition at line 184 of file IndexMap.h.

◆ m_targets

std::vector<ICollectionGetterTool*> D3PD::IndexMap::m_targets

private

Getters defining the collections within which to index.

Definition at line 196 of file IndexMap.h.

◆ m_valid

bool D3PD::IndexMap::m_valid

private

Flag if the map is valid.

Definition at line 203 of file IndexMap.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_t

Constructor & Destructor Documentation

◆ IndexMap() [1/3]

◆ IndexMap() [2/3]

◆ IndexMap() [3/3]

Member Function Documentation

◆ addRef()

◆ configureCommon()

◆ configureD3PD() [1/2]

◆ configureD3PD() [2/2]

◆ findIndex() [1/2]

◆ findIndex() [2/2]

◆ findIndexPair()

◆ formatLabels()

◆ handle()

◆ ntargets()

◆ queryInterface()

◆ release()

◆ reset()

◆ target() [1/2]

◆ target() [2/2]

◆ valid()

Member Data Documentation

◆ m_allowMissing

◆ m_converters

◆ m_getters

◆ m_map

◆ m_parent

◆ m_registry

◆ m_targetLabel

◆ m_targetLabels

◆ m_targets

◆ m_valid