TrackParticleAssocs Class Reference

#include <TrackParticleAssocs.h>

Inheritance diagram for TrackParticleAssocs:

Collaboration diagram for TrackParticleAssocs:

Public Types
Store Iterator Types
typedef AssociationVectorIterator	asso_iterator
	association iterator type
typedef AssociationObjectIterator	object_iterator
	object iterator type

Public Member Functions
	TrackParticleAssocs ()
	Default constructor:
	TrackParticleAssocs (const TrackParticleAssocs &rhs)
	Copy constructor:
TrackParticleAssocs &	operator= (const TrackParticleAssocs &rhs)
	Assignment operator:
	~TrackParticleAssocs ()
	Constructor with parameters:
bool	assocs (const Rec::TrackParticle *object, ConstDataVector< Rec::TrackParticleContainer > &associatedElems) const
	Retrieve all the associated-to objects which have been associated to the given.
bool	getAssociations (const AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_type *objPointer, AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_list &assocs) const
	Reimplement the method from the base class to not shaddow it.
bool	getAssociations (const AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_iterator &objIter, AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_list &assocs) const
	Reimplement the method from the base class to not shaddow it.
void	addAssocStore (const DataLink< TrackParticleAssocs > &assocStore)
DataLink< TrackParticleAssocs >	assocStore (const std::string &name) const
	Look up an associated store. For testing.
size_t	nAssocStores () const
	Number of associated stores.
std::vector< DataLink< TrackParticleAssocs > >	getAssocStores () const
	Return links to all other association stores.
Add Associations
Parameters objectContainer - pointer to the object container objectIndex - index of object in container objectPointer - pointer to object assoContainer - container of potentially associated objects assoIndex - index of associated object in container assoPointer - pointer to associated object
void	addAssociation (const object_container_type *objectContainer, const object_index_type &objectIndex, const asso_container_type *assoContainer, const asso_index_type &assoIndex)

Protected Types
typedef DataLink< TrackParticleAssocs >	TrackParticleAssocsLink_t

Protected Attributes
std::map< std::string, TrackParticleAssocsLink_t >	m_assocStores

Object and Association Iterators
The association iterators are returned for a given object, which can either be referenced by its pointer or its iterator in the internal store. Parameters objectPointer - pointer to a given object objectIter - iterator to a given object
store_type	m_associationMap
	internal store
object_iterator	beginObject () const
	begin iterator for objects
object_iterator	endObject () const
	end iterator for objects
asso_iterator	beginAssociation (const object_type *objectPointer) const
	begin iterator for associations
asso_iterator	endAssociation (const object_type *objectPointer) const
	end iterator for associations
const object_type *	getObject (const object_iterator &objectIter) const
	get association iterators by object iterator
object_iterator	findObject (const object_type *theObject) const
	finding an object with allocation
bool	containsObject (const object_type *theObject) const
	testing if object is in store
size_t	getNumberOfObjects () const
	retrieve number of objects in store
const asso_type *	getAssociation (asso_iterator assoIter) const
	associations iterator access
asso_iterator	findAssociation (const object_iterator &objectIter, const asso_type *assoPointer) const
	find association
bool	containsAssociation (const object_iterator &objectIter, const asso_type *assoPointer) const
	containment check
bool	getObjects (const asso_type *assoPointer, object_list &theObjects) const
	get all objects for a given association
bool	getAssociations (const object_type *objPointer, asso_list &assocs) const
	get all associations for a given object
size_t	size ()
	get number of associations
size_t	getNumberOfAssociations (const object_type *objectPointer) const
store_iterator_type	internalFind (const object_link &objectLink, const asso_link &assoLink)
	internally used find method
bool	addToStore (const object_link &objectLink, const asso_link &assoLink)
	internally used function to add links to store

Argument and Internal Store Types
typedef Rec::TrackParticleContainer	object_container_type
typedef object_container_type::base_value_type	object_type
typedef SG::GenerateIndexingPolicy< object_container_type >::type::index_type	object_index_type
typedef ElementLink< object_container_type >	object_link
typedef std::list< const object_type * >	object_list
typedef Rec::TrackParticleContainer	asso_container_type
typedef asso_container_type::base_value_type	asso_type
typedef SG::GenerateIndexingPolicy< asso_container_type >::type::index_type	asso_index_type
typedef std::list< const asso_type * >	asso_list
typedef ElementLink< asso_container_type >	asso_link
typedef ElementLinkVector< asso_container_type >	asso_store
typedef asso_store::const_iterator	asso_store_iterator
typedef std::map< object_link, asso_store >	store_type
typedef store_type::iterator	store_iterator_type
static const asso_store	s_dum_asso_store

Detailed Description

Definition at line 25 of file TrackParticleAssocs.h.

Member Typedef Documentation

asso_container_type

typedef Rec::TrackParticleContainer AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_container_type

inherited

Definition at line 53 of file AssociationMap.h.

asso_index_type

typedef SG::GenerateIndexingPolicy<asso_container_type>::type::index_type AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_index_type

inherited

Definition at line 58 of file AssociationMap.h.

asso_iterator

typedef AssociationVectorIterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_iterator

inherited

association iterator type

Definition at line 81 of file AssociationMap.h.

asso_link

typedef ElementLink<asso_container_type> AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_link

inherited

Definition at line 60 of file AssociationMap.h.

asso_list

typedef std::list<const asso_type*> AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_list

inherited

Definition at line 59 of file AssociationMap.h.

asso_store

typedef ElementLinkVector<asso_container_type> AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_store

inherited

Definition at line 61 of file AssociationMap.h.

asso_store_iterator

typedef asso_store::const_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_store_iterator

inherited

Definition at line 62 of file AssociationMap.h.

asso_type

typedef asso_container_type::base_value_type AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_type

inherited

Definition at line 54 of file AssociationMap.h.

object_container_type

typedef Rec::TrackParticleContainer AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_container_type

inherited

Definition at line 44 of file AssociationMap.h.

object_index_type

typedef SG::GenerateIndexingPolicy<object_container_type>::type::index_type AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_index_type

inherited

Definition at line 49 of file AssociationMap.h.

object_iterator

typedef AssociationObjectIterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_iterator

inherited

object iterator type

Definition at line 84 of file AssociationMap.h.

object_link

typedef ElementLink<object_container_type> AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_link

inherited

Definition at line 50 of file AssociationMap.h.

object_list

typedef std::list<const object_type*> AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_list

inherited

Definition at line 51 of file AssociationMap.h.

object_type

typedef object_container_type::base_value_type AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_type

inherited

Definition at line 45 of file AssociationMap.h.

store_iterator_type

typedef store_type::iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::store_iterator_type

inherited

Definition at line 64 of file AssociationMap.h.

store_type

typedef std::map<object_link,asso_store> AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::store_type

inherited

Definition at line 63 of file AssociationMap.h.

TrackParticleAssocsLink_t

typedef DataLink<TrackParticleAssocs> TrackParticleAssocs::TrackParticleAssocsLink_t

protected

Definition at line 96 of file TrackParticleAssocs.h.

Constructor & Destructor Documentation

TrackParticleAssocs() [1/2]

TrackParticleAssocs::TrackParticleAssocs

(

)

Default constructor:

Definition at line 23 of file TrackParticleAssocs.cxx.

                                         :
  AssociationMap<Rec::TrackParticleContainer, Rec::TrackParticleContainer>(), 
  m_assocStores()
{}

TrackParticleAssocs() [2/2]

TrackParticleAssocs::TrackParticleAssocs

(

const TrackParticleAssocs &

rhs

)

Copy constructor:

Definition at line 28 of file TrackParticleAssocs.cxx.

                                                                        :
  AssociationMap<Rec::TrackParticleContainer,Rec::TrackParticleContainer>(rhs),
  m_assocStores( rhs.m_assocStores )
{}

~TrackParticleAssocs()

TrackParticleAssocs::~TrackParticleAssocs ( )

inline

Constructor with parameters:

Destructor:

Definition at line 104 of file TrackParticleAssocs.h.

{}

Member Function Documentation

addAssociation()

void AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::addAssociation ( const object_container_type * objectContainer, const object_index_type & objectIndex, const asso_container_type * assoContainer, const asso_index_type & assoIndex )

inherited

addAssocStore()

void TrackParticleAssocs::addAssocStore

(

const DataLink< TrackParticleAssocs > &

assocStore

)

Definition at line 83 of file TrackParticleAssocs.cxx.

  {
     const std::string& id = assocStore.dataID();
     const std::map<std::string, DataLink<TrackParticleAssocs> >::const_iterator itr = m_assocStores.find(id);
     if ( itr == m_assocStores.end() ) {
       m_assocStores[id] = assocStore;
     }
  }

addToStore()

bool AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::addToStore ( const object_link & objectLink, const asso_link & assoLink )

protectedinherited

internally used function to add links to store

assocs()

bool TrackParticleAssocs::assocs	(	const Rec::TrackParticle *	object,
		ConstDataVector< Rec::TrackParticleContainer > &	associatedElems ) const

Retrieve all the associated-to objects which have been associated to the given.

Parameters

object

Definition at line 47 of file TrackParticleAssocs.cxx.

{
  if ( 0 == object ) {
    return false;
  }
 
  // do the underlying stores contain this object ?
  bool contained = false;
  for ( std::map<std::string, DataLink<TrackParticleAssocs> >::const_iterator itr = m_assocStores.begin();
    itr != m_assocStores.end();
    ++itr ) {
    if ( itr->second->assocs(object, associatedElems) ) {
      contained = true;
    }
  }
  
  if ( !contained && !containsObject( object ) ) {
    return false;
  }
  
  associatedElems.reserve( associatedElems.size() + getNumberOfAssociations(object) );
  TrackParticleAssocs::asso_iterator endAssocs = endAssociation( object );
  for ( TrackParticleAssocs::asso_iterator itr = beginAssociation( object );
    itr != endAssocs;
    ++itr ) {
    associatedElems.push_back( const_cast<Rec::TrackParticle*>(*itr) );
  }
  
  return true;
}

assocStore()

DataLink< TrackParticleAssocs > TrackParticleAssocs::assocStore

(

const std::string &

name

)

const

Look up an associated store. For testing.

Definition at line 94 of file TrackParticleAssocs.cxx.

{
  std::map<std::string, TrackParticleAssocsLink_t>::const_iterator i =
    m_assocStores.find (name);
  if (i != m_assocStores.end())
    return i->second;
  return DataLink<TrackParticleAssocs>();
}

beginAssociation()

asso_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::beginAssociation ( const object_type * objectPointer ) const

inherited

begin iterator for associations

beginObject()

object_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::beginObject ( ) const

inherited

begin iterator for objects

containsAssociation()

bool AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::containsAssociation ( const object_iterator & objectIter, const asso_type * assoPointer ) const

inlineinherited

containment check

Definition at line 165 of file AssociationMap.h.

    { return objectIter.containsAssociation(assoPointer); }

containsObject()

bool AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::containsObject ( const object_type * theObject ) const

inlineinherited

testing if object is in store

Definition at line 143 of file AssociationMap.h.

    { return this->findObject(theObject) != this->endObject(); }

endAssociation()

asso_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::endAssociation ( const object_type * objectPointer ) const

inherited

end iterator for associations

endObject()

object_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::endObject ( ) const

inherited

end iterator for objects

findAssociation()

asso_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::findAssociation ( const object_iterator & objectIter, const asso_type * assoPointer ) const

inlineinherited

find association

Definition at line 158 of file AssociationMap.h.

    { return objectIter.findAssociation(assoPointer); }

findObject()

object_iterator AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::findObject ( const object_type * theObject ) const

inlineinherited

finding an object with allocation

Definition at line 139 of file AssociationMap.h.

    { return object_iterator(m_associationMap).find(theObject); }

getAssociation()

const asso_type * AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::getAssociation ( asso_iterator assoIter ) const

inlineinherited

associations iterator access

The associations are accessed as function of the row key (the object).

Definition at line 154 of file AssociationMap.h.

    { return *assoIter; }

getAssociations() [1/3]

bool AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::getAssociations ( const object_type * objPointer, asso_list & assocs ) const

inherited

get all associations for a given object

getAssociations() [2/3]

bool TrackParticleAssocs::getAssociations ( const AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_iterator & objIter, AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_list & assocs ) const

inline

Reimplement the method from the base class to not shaddow it.

Definition at line 70 of file TrackParticleAssocs.h.

  {
    return AssociationMap< Rec::TrackParticleContainer, 
      Rec::TrackParticleContainer >::getAssociations( objIter, assocs );
  }  

getAssociations() [3/3]

bool TrackParticleAssocs::getAssociations ( const AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::object_type * objPointer, AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::asso_list & assocs ) const

inline

Reimplement the method from the base class to not shaddow it.

Definition at line 60 of file TrackParticleAssocs.h.

  {
    return AssociationMap< Rec::TrackParticleContainer, 
      Rec::TrackParticleContainer >::getAssociations( objPointer, assocs );
  }

getAssocStores()

std::vector< DataLink< TrackParticleAssocs > > TrackParticleAssocs::getAssocStores

(

)

const

Return links to all other association stores.

Definition at line 110 of file TrackParticleAssocs.cxx.

{
  std::vector<DataLink<TrackParticleAssocs> > ret;
  ret.reserve (m_assocStores.size());
  for (const auto& p : m_assocStores) {
    ret.push_back (p.second);
  }
  return ret;
}

getNumberOfAssociations()

size_t AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::getNumberOfAssociations ( const object_type * objectPointer ) const

inlineinherited

Definition at line 195 of file AssociationMap.h.

    { return this->size(objectPointer); }

getNumberOfObjects()

size_t AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::getNumberOfObjects ( ) const

inlineinherited

retrieve number of objects in store

Definition at line 147 of file AssociationMap.h.

{ return this->size(); }

getObject()

const object_type * AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::getObject ( const object_iterator & objectIter ) const

inlineinherited

get association iterators by object iterator

type-safe retrieval of object pointer from iterator

Definition at line 135 of file AssociationMap.h.

    { return (*objectIter).getObject(); }

getObjects()

bool AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::getObjects ( const asso_type * assoPointer, object_list & theObjects ) const

inherited

get all objects for a given association

internalFind()

store_iterator_type AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::internalFind ( const object_link & objectLink, const asso_link & assoLink )

inlineprotectedinherited

internally used find method

Definition at line 210 of file AssociationMap.h.

    {
      // check key
      store_iterator_type mapEnd    = m_associationMap.end();
      store_iterator_type foundIter = mapEnd;
      for ( store_iterator_type iMap = m_associationMap.begin();
        iMap != mapEnd;
        ++iMap ) {
    // look for the address of the pointed-at object 
    // must dereference the ElementLink pointer
    if ( iMap->first.cptr() == objectLink.cptr() ) {
      foundIter = iMap;
      break;
    }
      }
      
      if ( foundIter == m_associationMap.end() ) { return foundIter; }
      // check data
      if ( std::find((foundIter->second).begin(),
             (foundIter->second).end(),
             assoLink) !=
       (foundIter->second).end() )
    { return foundIter; }
      // not found at all
      return m_associationMap.end();
    }

nAssocStores()

size_t TrackParticleAssocs::nAssocStores

(

)

const

Number of associated stores.

Definition at line 104 of file TrackParticleAssocs.cxx.

{
  return m_assocStores.size();
}

operator=()

TrackParticleAssocs & TrackParticleAssocs::operator=

(

const TrackParticleAssocs &

rhs

)

Assignment operator:

Definition at line 34 of file TrackParticleAssocs.cxx.

{
  if ( this != &rhs ) {
    AssociationMap< Rec::TrackParticleContainer,Rec::TrackParticleContainer >::operator=(rhs);
    m_assocStores = rhs.m_assocStores;
  }
  return *this;
}

size()

size_t AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::size ( )

inlineinherited

get number of associations

Definition at line 188 of file AssociationMap.h.

{ return m_associationMap.size(); }

Member Data Documentation

m_associationMap

store_type AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::m_associationMap

protectedinherited

internal store

Definition at line 207 of file AssociationMap.h.

m_assocStores

std::map<std::string, TrackParticleAssocsLink_t> TrackParticleAssocs::m_assocStores

protected

Definition at line 97 of file TrackParticleAssocs.h.

s_dum_asso_store

const asso_store AssociationMap< Rec::TrackParticleContainer, Rec::TrackParticleContainer >::s_dum_asso_store

staticinherited

Definition at line 68 of file AssociationMap.h.

---

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

• TrackParticleAssocs.h
• TrackParticleAssocs.cxx