INav4MomAssocs Class Reference

#include <INav4MomAssocs.h>

Inheritance diagram for INav4MomAssocs:

Collaboration diagram for INav4MomAssocs:

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

Public Member Functions
	INav4MomAssocs ()
	Default constructor:
	INav4MomAssocs (const INav4MomAssocs &rhs)
	Copy constructor:
INav4MomAssocs &	operator= (const INav4MomAssocs &rhs)
	Assignment operator:
	INav4MomAssocs (INav4MomAssocs &&rhs)
	Move constructor:
INav4MomAssocs &	operator= (INav4MomAssocs &&rhs)
	Move operator:
	~INav4MomAssocs ()
	Constructor with parameters:
bool	assocs (const INavigable4Momentum *object, ConstDataVector< INavigable4MomentumCollection > &assocs) const
	Retrieve all the associated-to objects which have been associated to the given.
bool	getAssociations (const INav4MomLink &objectLink, INav4MomLinkContainer &associatedElementLinks) const
	Retrieve all the associated-to ElementLinks_to_objects which have been associated to the given.
bool	getAssociations (const INavigable4Momentum *object, INav4MomLinkContainer &associatedElementLinks) const
	Retrieve all the associated-to ElementLinks_to_objects which have been associated to the given.
bool	getAssociations (const AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_type *objPointer, AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_list &assocs) const
	Reimplement the method from the base class to not shaddow it.
bool	getAssociations (const AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_iterator &objIter, AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_list &assocs) const
	Reimplement the method from the base class to not shaddow it.
void	addAssocStore (const DataLink< INav4MomAssocs > &assocStore)
	Retrieve all the associated-to objects which have been associated to the given.
std::vector< DataLink< INav4MomAssocs > >	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< INav4MomAssocs >	INav4MomAssocsLink_t

Protected Attributes
std::map< std::string, INav4MomAssocsLink_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 INavigable4MomentumCollection	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 INavigable4MomentumCollection	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 30 of file INav4MomAssocs.h.

Member Typedef Documentation

asso_container_type

typedef INavigable4MomentumCollection AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_index_type

inherited

Definition at line 58 of file AssociationMap.h.

asso_iterator

typedef AssociationVectorIterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_iterator

inherited

association iterator type

Definition at line 81 of file AssociationMap.h.

asso_link

typedef ElementLink<asso_container_type> AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_link

inherited

Definition at line 60 of file AssociationMap.h.

asso_list

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

inherited

Definition at line 59 of file AssociationMap.h.

asso_store

typedef ElementLinkVector<asso_container_type> AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_store

inherited

Definition at line 61 of file AssociationMap.h.

asso_store_iterator

typedef asso_store::const_iterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_store_iterator

inherited

Definition at line 62 of file AssociationMap.h.

asso_type

typedef asso_container_type::base_value_type AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_type

inherited

Definition at line 54 of file AssociationMap.h.

INav4MomAssocsLink_t

typedef DataLink<INav4MomAssocs> INav4MomAssocs::INav4MomAssocsLink_t

protected

Definition at line 133 of file INav4MomAssocs.h.

object_container_type

typedef INavigable4MomentumCollection AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_index_type

inherited

Definition at line 49 of file AssociationMap.h.

object_iterator

typedef AssociationObjectIterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_iterator

inherited

object iterator type

Definition at line 84 of file AssociationMap.h.

object_link

typedef ElementLink<object_container_type> AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_link

inherited

Definition at line 50 of file AssociationMap.h.

object_list

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

inherited

Definition at line 51 of file AssociationMap.h.

object_type

typedef object_container_type::base_value_type AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_type

inherited

Definition at line 45 of file AssociationMap.h.

store_iterator_type

typedef store_type::iterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::store_iterator_type

inherited

Definition at line 64 of file AssociationMap.h.

store_type

typedef std::map<object_link,asso_store> AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::store_type

inherited

Definition at line 63 of file AssociationMap.h.

Constructor & Destructor Documentation

INav4MomAssocs() [1/3]

INav4MomAssocs::INav4MomAssocs ( )

default

Default constructor:

INav4MomAssocs() [2/3]

INav4MomAssocs::INav4MomAssocs ( const INav4MomAssocs & rhs )

default

Copy constructor:

INav4MomAssocs() [3/3]

INav4MomAssocs::INav4MomAssocs ( INav4MomAssocs && rhs )

default

Move constructor:

~INav4MomAssocs()

INav4MomAssocs::~INav4MomAssocs ( )

inline

Constructor with parameters:

Inline methods:

Destructor:

Definition at line 144 of file INav4MomAssocs.h.

{}

Member Function Documentation

addAssociation()

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

inherited

addAssocStore()

void INav4MomAssocs::addAssocStore

(

const DataLink< INav4MomAssocs > &

assocStore

)

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

Parameters

object

connect this association container to other ones. It is meant to be able to have underlying association stores which can be queried and laying into StoreGate without having to copy them.

Definition at line 161 of file INav4MomAssocs.cxx.

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

addToStore()

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

protectedinherited

internally used function to add links to store

assocs()

bool INav4MomAssocs::assocs	(	const INavigable4Momentum *	object,
		ConstDataVector< INavigable4MomentumCollection > &	assocs ) const

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

Parameters

object

Definition at line 37 of file INav4MomAssocs.cxx.

{
  if ( 0 == object ) {
    return false;
  }
 
  // do the underlying stores contain this object ?
  bool contained = false;
  for ( std::map<std::string, DataLink<INav4MomAssocs> >::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) );
  INav4MomAssocs::asso_iterator endAssocs = endAssociation( object );
  for ( INav4MomAssocs::asso_iterator itr = beginAssociation( object );
        itr != endAssocs;
        ++itr ) {
    associatedElems.push_back( const_cast<INavigable4Momentum*>(*itr) );
  }
 
  return true;
}

beginAssociation()

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

inherited

begin iterator for associations

beginObject()

object_iterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::beginObject ( ) const

inherited

begin iterator for objects

containsAssociation()

bool AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::endAssociation ( const object_type * objectPointer ) const

inherited

end iterator for associations

endObject()

object_iterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::endObject ( ) const

inherited

end iterator for objects

findAssociation()

asso_iterator AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::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/5]

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

inherited

get all associations for a given object

getAssociations() [2/5]

bool INav4MomAssocs::getAssociations ( const AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::object_iterator & objIter, AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::asso_list & assocs ) const

inline

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

Definition at line 100 of file INav4MomAssocs.h.

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

getAssociations() [3/5]

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

inline

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

Definition at line 90 of file INav4MomAssocs.h.

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

getAssociations() [4/5]

bool INav4MomAssocs::getAssociations	(	const INav4MomLink &	objectLink,
		INav4MomLinkContainer &	associatedElementLinks ) const

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

Parameters

objectLink

Definition at line 73 of file INav4MomAssocs.cxx.

{
  if ( !objectLink.isValid() )
    {
      return false;
    }
 
  // Get the object
  const INavigable4Momentum* object(NULL);
  object = (*objectLink);
  if ( object == NULL )
    {
      return false;
    }
 
  return getAssociations( object, associatedElementLinks );
}

getAssociations() [5/5]

bool INav4MomAssocs::getAssociations	(	const INavigable4Momentum *	object,
		INav4MomLinkContainer &	associatedElementLinks ) const

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

Parameters

object

Definition at line 96 of file INav4MomAssocs.cxx.

{
  if ( 0 == object )
    {
      return false;
    }
 
  // do the underlying stores contain this object ?
  bool contained = false;
  for ( std::map<std::string, DataLink<INav4MomAssocs> >::const_iterator itr = m_assocStores.begin();
        itr != m_assocStores.end();
        ++itr )
    {
      if ( itr->second->getAssociations( object, associatedElementLinks ) )
        {
          contained = true;
        }
    }
 
  if ( !contained && !containsObject( object ) )
    {
      return false;
    }
 
  // check key
  store_type::const_iterator mapEnd    = m_associationMap.end();
  store_type::const_iterator foundIter = mapEnd;
  for ( store_type::const_iterator iMap = m_associationMap.begin();
        iMap != mapEnd;
        ++iMap )
    {
      // look for the address of the pointed-at object 
      // must dereference the ElementLink pointer
      if ( &*(*(iMap->first)) == &*(object) )
        {
          foundIter = iMap;
          break;
        }
    }
  if ( foundIter == m_associationMap.end() )
    {
      return false;
    }
 
  // Now, loop over all associations and fill the vector of associations
  associatedElementLinks.reserve( associatedElementLinks.size() +
                                  getNumberOfAssociations(object) );
  ElementLinkVector<INavigable4MomentumCollection>::const_iterator assoItr    = (foundIter->second).begin();
  ElementLinkVector<INavigable4MomentumCollection>::const_iterator assoItrEnd = (foundIter->second).end();
  for ( ; assoItr != assoItrEnd; ++assoItr )
    {
      const INav4MomLink assoLink = (*assoItr);
      associatedElementLinks.push_back( assoLink );
    }
 
  return true;
}

getAssocStores()

std::vector< DataLink< INav4MomAssocs > > INav4MomAssocs::getAssocStores

(

)

const

Return links to all other association stores.

Definition at line 171 of file INav4MomAssocs.cxx.

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

getNumberOfAssociations()

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

inlineinherited

Definition at line 195 of file AssociationMap.h.

    { return this->size(objectPointer); }

getNumberOfObjects()

size_t AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::getObjects ( const asso_type * assoPointer, object_list & theObjects ) const

inherited

get all objects for a given association

internalFind()

store_iterator_type AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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();
    }

operator=() [1/2]

INav4MomAssocs & INav4MomAssocs::operator= ( const INav4MomAssocs & rhs )

default

Assignment operator:

operator=() [2/2]

INav4MomAssocs & INav4MomAssocs::operator= ( INav4MomAssocs && rhs )

default

Move operator:

size()

size_t AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::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< INavigable4MomentumCollection, INavigable4MomentumCollection >::m_associationMap

protectedinherited

internal store

Definition at line 207 of file AssociationMap.h.

m_assocStores

std::map<std::string, INav4MomAssocsLink_t> INav4MomAssocs::m_assocStores

protected

Definition at line 134 of file INav4MomAssocs.h.

s_dum_asso_store

const asso_store AssociationMap< INavigable4MomentumCollection, INavigable4MomentumCollection >::s_dum_asso_store

staticinherited

Definition at line 68 of file AssociationMap.h.

---

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

• INav4MomAssocs.h
• INav4MomAssocs.cxx