ObjectVector is one of the basic Gaudi container classes capable of being registered in Data Stores. More...

#include <GaudiKernel/ObjectVector.h>

Inheritance diagram for ObjectVector< TYPE >:

Collaboration diagram for ObjectVector< TYPE >:

Public Types
typedef TYPE	contained_type

typedef std::vector< TYPE * > ::value_type	value_type

typedef std::vector< TYPE * > ::reference	reference

typedef std::vector< TYPE * > ::const_reference	const_reference

typedef std::vector< TYPE * > ::iterator	iterator

typedef std::vector< TYPE * > ::const_iterator	const_iterator

typedef std::vector< TYPE * > ::reverse_iterator	reverse_iterator

typedef std::vector< TYPE * > ::const_reverse_iterator	const_reverse_iterator

typedef std::vector< TYPE * > ::pointer	pointer

typedef std::vector< TYPE * > ::const_pointer	const_pointer

Public Types inherited from ObjectContainerBase
typedef size_t	size_type
	size_type, to conform the STL container interface

Public Member Functions
	ObjectVector ()
	Constructors.

	ObjectVector (const char *)

	ObjectVector (const ObjectVector< TYPE > &value)
	Copy constructor.

virtual	~ObjectVector ()
	Destructor.

virtual const CLID &	clID () const
	Retrieve class ID.

const ObjectVector< TYPE > &	operator= (const ObjectVector< TYPE > &right)
	Clone operator.

ObjectVector< TYPE >::iterator	begin ()
	Return an iterator pointing to the beginning of the container.

ObjectVector< TYPE > ::const_iterator	begin () const
	Return a const_iterator pointing to the beginning of the container.

ObjectVector< TYPE >::iterator	end ()
	Return an iterator pointing to the end of the container.

ObjectVector< TYPE > ::const_iterator	end () const
	Return a const_iterator pointing to the end of the container.

ObjectVector< TYPE > ::reverse_iterator	rbegin ()
	Return a reverse_iterator pointing to the beginning of the reversed container.

ObjectVector< TYPE > ::const_reverse_iterator	rbegin () const
	Return a const_reverse_iterator pointing to the beginning of the reversed container.

ObjectVector< TYPE > ::reverse_iterator	rend ()
	Return a reverse_iterator pointing to the end of the reversed container.

ObjectVector< TYPE > ::const_reverse_iterator	rend () const
	Return a const_reverse_iterator pointing to the end of the reversed container.

ObjectVector< TYPE >::size_type	size () const
	Return the size of the container.

virtual ObjectVector< TYPE > ::size_type	numberOfObjects () const
	The same as size(), return number of objects in the container.

ObjectVector< TYPE >::size_type	max_size () const
	Return the largest possible size of the container.

ObjectVector< TYPE >::size_type	capacity () const
	Return number of elements for which memory has been allocated It is always greater than or equal to size()

void	reserve (typename ObjectVector< TYPE >::size_type value)
	Reserve place for "value" objects in the container.

bool	empty () const
	Return true if the size of the container is 0.

ObjectVector< TYPE >::reference	front ()
	Return reference to the first element.

ObjectVector< TYPE > ::const_reference	front () const
	Return const_reference to the first element.

ObjectVector< TYPE >::reference	back ()
	Return reference to the last element.

ObjectVector< TYPE > ::const_reference	back () const
	Return const_reference to the last element.

void	push_back (typename ObjectVector< TYPE >::const_reference value)
	push_back = append = insert a new element at the end of the container

virtual long	add (ContainedObject *pObject)
	Add an object to the container.

void	pop_back ()
	pop_back = remove the last element from the container The removed object will be deleted (see the method release)

virtual long	remove (ContainedObject *value)
	Release object from the container (the poiter will be removed from the container, but the object itself will remain alive) (see the method pop_back)

ObjectVector< TYPE >::iterator	insert (typename ObjectVector< TYPE >::iterator position, typename ObjectVector< TYPE >::const_reference value)
	Insert "value" before "position".

void	erase (typename ObjectVector< TYPE >::iterator position)
	Erase the object at "position" from the container. The removed object will be deleted.

void	erase (typename ObjectVector< TYPE >::iterator first, typename ObjectVector< TYPE >::iterator last)
	Erase the range [first, last) from the container. The removed object will be deleted.

void	clear ()
	Clear the entire content of the container and delete all contained objects.

ObjectVector< TYPE >::reference	operator[] (typename ObjectVector< TYPE >::size_type n)
	Return the reference to the n'th object in the container.

ObjectVector< TYPE > ::const_reference	operator[] (typename ObjectVector< TYPE >::size_type n) const
	Return the const_reference to the n'th object in the container.

virtual long	index (const ContainedObject *obj) const
	Return distance of a given object from the beginning of its container It correcponds to the "index" ( from 0 to size()-1 ) If "obj" not fount, return -1.

virtual ContainedObject *	containedObject (long dist) const
	Return const pointer to an object of a given distance (index)

virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII)

Static Public Member Functions
static const CLID &	classID ()
	Retrieve class ID.

Private Attributes
std::vector< TYPE * >	m_vector
	The STL vector itself.

Additional Inherited Members
Protected Member Functions inherited from ObjectContainerBase
	ObjectContainerBase ()
	Constructor.

virtual	~ObjectContainerBase ()
	Destructor.

Friends inherited from DataObject

Detailed Description

template<class TYPE>
class ObjectVector< TYPE >

ObjectVector is one of the basic Gaudi container classes capable of being registered in Data Stores.

It is based on Standard Library (STL) std::vector (see STL Programmer's Guide) ObjectVector has all functions of the std::vector interface, and in addition a number of Gaudi specific functions.

Each object is allowed to belong into a single container only. After inserting the object into the container, it takes over all responsibilities for the object. E.g. erasing the object from its container causes removing the object's pointer from the container and deleting the object itself.

Author: Pavel Binko; Pere Mato

Date: 19/10/1999, 30/11/2000

Definition at line 12 of file ContainedObject.h.

Member Typedef Documentation

template<class TYPE>

typedef std::vector<TYPE*>::const_iterator ObjectVector< TYPE >::const_iterator

Definition at line 49 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::const_pointer ObjectVector< TYPE >::const_pointer

Definition at line 58 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::const_reference ObjectVector< TYPE >::const_reference

Definition at line 46 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::const_reverse_iterator ObjectVector< TYPE >::const_reverse_iterator

Definition at line 52 of file ObjectVector.h.

template<class TYPE>

typedef TYPE ObjectVector< TYPE >::contained_type

Definition at line 42 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::iterator ObjectVector< TYPE >::iterator

Definition at line 48 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::pointer ObjectVector< TYPE >::pointer

Definition at line 57 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::reference ObjectVector< TYPE >::reference

Definition at line 45 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::reverse_iterator ObjectVector< TYPE >::reverse_iterator

Definition at line 51 of file ObjectVector.h.

template<class TYPE>

typedef std::vector<TYPE*>::value_type ObjectVector< TYPE >::value_type

Definition at line 43 of file ObjectVector.h.

Constructor & Destructor Documentation

template<class TYPE>

ObjectVector< TYPE >::ObjectVector ( )

inline

Constructors.

Definition at line 63 of file ObjectVector.h.

: m_vector(0) { }

template<class TYPE>

ObjectVector< TYPE >::ObjectVector ( const char * )

inline

Definition at line 65 of file ObjectVector.h.

: m_vector(0) { }

template<class TYPE>

ObjectVector< TYPE >::ObjectVector ( const ObjectVector< TYPE > & value )

inline

Copy constructor.

Definition at line 68 of file ObjectVector.h.

: ObjectContainerBase(), m_vector(value.m_vector) { }

template<class TYPE>

virtual ObjectVector< TYPE >::~ObjectVector ( )

inlinevirtual

Destructor.

Definition at line 72 of file ObjectVector.h.

                          {
    for( typename ObjectVector<TYPE>::iterator i = begin(); i != end(); i++ ) {
      // Set the back pointer to 0 to avoid repetitional searching
      // for the object in the container, and deleting the object
      (*i)->setParent (0);
      delete *i;
    }
  }

Member Function Documentation

template<class TYPE>

virtual long ObjectVector< TYPE >::add ( ContainedObject * pObject )

inlinevirtual

Add an object to the container.

Implements ObjectContainerBase.

Definition at line 208 of file ObjectVector.h.

                                             {
    try {
      typename ObjectVector<TYPE>::value_type ptr =
            dynamic_cast<typename ObjectVector<TYPE>::value_type>(pObject);
      if ( 0 != ptr ) {
        push_back(ptr);
        return m_vector.size()-1;
      }
    }
    catch(...) {
    }
    return -1;
  }

template<class TYPE>

ObjectVector<TYPE>::reference ObjectVector< TYPE >::back ( )

inline

Return reference to the last element.

Definition at line 189 of file ObjectVector.h.

                                               {
    return m_vector.back();
  }

template<class TYPE>

ObjectVector<TYPE>::const_reference ObjectVector< TYPE >::back ( ) const

inline

Return const_reference to the last element.

Definition at line 194 of file ObjectVector.h.

                                                           {
    return m_vector.back();
  }

template<class TYPE>

ObjectVector<TYPE>::iterator ObjectVector< TYPE >::begin ( )

inline

Return an iterator pointing to the beginning of the container.

Definition at line 98 of file ObjectVector.h.

                                               {
    return m_vector.begin();
  }

template<class TYPE>

ObjectVector<TYPE>::const_iterator ObjectVector< TYPE >::begin ( ) const

inline

Return a const_iterator pointing to the beginning of the container.

Definition at line 103 of file ObjectVector.h.

                                                           {
    return m_vector.begin();
  }

template<class TYPE>

ObjectVector<TYPE>::size_type ObjectVector< TYPE >::capacity ( ) const

inline

Return number of elements for which memory has been allocated It is always greater than or equal to size()

Definition at line 158 of file ObjectVector.h.

                                                         {
    return m_vector.capacity();
  }

template<class TYPE>

static const CLID& ObjectVector< TYPE >::classID ( )

inlinestatic

Retrieve class ID.

Definition at line 86 of file ObjectVector.h.

                               {
    static CLID clid = TYPE::classID() + CLID_ObjectVector;
    return clid;
  }

template<class TYPE>

void ObjectVector< TYPE >::clear ( )

inline

Clear the entire content of the container and delete all contained objects.

Definition at line 292 of file ObjectVector.h.

                  {
    erase(begin(), end());
  }

template<class TYPE>

virtual const CLID& ObjectVector< TYPE >::clID ( ) const

inlinevirtual

Retrieve class ID.

Reimplemented from DataObject.

Definition at line 82 of file ObjectVector.h.

                                   {
    return ObjectVector<TYPE>::classID();
  }

template<class TYPE>

virtual ContainedObject* ObjectVector< TYPE >::containedObject ( long dist ) const

inlinevirtual

Return const pointer to an object of a given distance (index)

Implements ObjectContainerBase.

Definition at line 322 of file ObjectVector.h.

                                                              {
    return m_vector[dist];
  }

template<class TYPE>

bool ObjectVector< TYPE >::empty ( ) const

inline

Return true if the size of the container is 0.

Definition at line 174 of file ObjectVector.h.

                      {
    return m_vector.empty();
  }

template<class TYPE>

ObjectVector<TYPE>::iterator ObjectVector< TYPE >::end ( )

inline

Return an iterator pointing to the end of the container.

Definition at line 108 of file ObjectVector.h.

                                             {
    return m_vector.end();
  }

template<class TYPE>

ObjectVector<TYPE>::const_iterator ObjectVector< TYPE >::end ( ) const

inline

Return a const_iterator pointing to the end of the container.

Definition at line 113 of file ObjectVector.h.

                                                         {
    return m_vector.end();
  }

template<class TYPE>

void ObjectVector< TYPE >::erase ( typename ObjectVector< TYPE >::iterator position )

inline

Erase the object at "position" from the container. The removed object will be deleted.

Definition at line 267 of file ObjectVector.h.

                                                             {
    if( 0 != (*position)->parent() ) {
      // Set the back pointer to 0 to avoid repetitional searching
      // for the object in the container, and deleting the object
      (*position)->setParent (0);
      delete *position;
    }
    // Removing from the container itself
    m_vector.erase(position);
  }

template<class TYPE>

void ObjectVector< TYPE >::erase	(	typename ObjectVector< TYPE >::iterator	first,
		typename ObjectVector< TYPE >::iterator	last
	)

inline

Erase the range [first, last) from the container. The removed object will be deleted.

Definition at line 279 of file ObjectVector.h.

                                                         {
    for(typename ObjectVector<TYPE>::iterator i = first; i != last; i++ ) {
      // Set the back pointer to 0 to avoid repetitional searching
      // for the object in the container, and deleting the object
      (*i)->setParent(0);
      delete *i;
    }
    // Removing from the container itself
    m_vector.erase(first, last);
  }

template<class TYPE>

virtual std::ostream& ObjectVector< TYPE >::fillStream ( std::ostream & s ) const

inlinevirtual

Fill the output stream (ASCII)

Reimplemented from DataObject.

Definition at line 327 of file ObjectVector.h.

                                                        {
    s << "class ObjectVector :    size = "
      << std::setw(12)
      << size() << "\n";
    // Output the base class
    //ObjectContainerBase::fillStream(s);
    if ( 0 != size() ) {
      s << "\nContents of the STL vector :";
      long   count = 0;
      typename ObjectVector<TYPE>::const_iterator iter;
      for( iter = m_vector.begin(); iter != m_vector.end(); iter++, count++ ) {
        s << "\nIndex "
          << std::setw(12)
          << count
          << " of object of type " << **iter;
      }
    }
    return s;
  }

template<class TYPE>

ObjectVector<TYPE>::reference ObjectVector< TYPE >::front ( )

inline

Return reference to the first element.

Definition at line 179 of file ObjectVector.h.

                                                {
    return m_vector.front();
  }

template<class TYPE>

ObjectVector<TYPE>::const_reference ObjectVector< TYPE >::front ( ) const

inline

Return const_reference to the first element.

Definition at line 184 of file ObjectVector.h.

                                                            {
    return m_vector.front();
  }

template<class TYPE>

virtual long ObjectVector< TYPE >::index ( const ContainedObject * obj ) const

inlinevirtual

Return distance of a given object from the beginning of its container It correcponds to the "index" ( from 0 to size()-1 ) If "obj" not fount, return -1.

Implements ObjectContainerBase.

Definition at line 311 of file ObjectVector.h.

                                                         {
    long i;
    for( i = 0; i < (long)m_vector.size(); i++ ) {
      if( m_vector[i] == obj ) {
        return i;
      }
    }
    return -1;
  }

template<class TYPE>

ObjectVector<TYPE>::iterator ObjectVector< TYPE >::insert	(	typename ObjectVector< TYPE >::iterator	position,
		typename ObjectVector< TYPE >::const_reference	value
	)

inline

Insert "value" before "position".

Definition at line 259 of file ObjectVector.h.

                                                                                                   {
    value->setParent(this);
    typename ObjectVector<TYPE>::iterator i = m_vector.insert(position, value);
    return i;
  }

template<class TYPE>

ObjectVector<TYPE>::size_type ObjectVector< TYPE >::max_size ( ) const

inline

Return the largest possible size of the container.

Definition at line 152 of file ObjectVector.h.

                                                         {
    return m_vector.max_size();
  }

template<class TYPE>

virtual ObjectVector<TYPE>::size_type ObjectVector< TYPE >::numberOfObjects ( ) const

inlinevirtual

The same as size(), return number of objects in the container.

Implements ObjectContainerBase.

Definition at line 147 of file ObjectVector.h.

                                                                       {
    return m_vector.size();
  }

template<class TYPE>

const ObjectVector<TYPE>& ObjectVector< TYPE >::operator= ( const ObjectVector< TYPE > & right )

inline

Clone operator.

Definition at line 92 of file ObjectVector.h.

                                                                         {
    m_vector = right.m_vector;
    return *this;
  }

template<class TYPE>

ObjectVector<TYPE>::reference ObjectVector< TYPE >::operator[] ( typename ObjectVector< TYPE >::size_type n )

inline

Return the reference to the n'th object in the container.

Definition at line 298 of file ObjectVector.h.

                                                        {
    return m_vector[n];
  }

template<class TYPE>

ObjectVector<TYPE>::const_reference ObjectVector< TYPE >::operator[] ( typename ObjectVector< TYPE >::size_type n ) const

inline

Return the const_reference to the n'th object in the container.

Definition at line 304 of file ObjectVector.h.

                                                              {
    return m_vector[n];
  }

template<class TYPE>

void ObjectVector< TYPE >::pop_back ( )

inline

pop_back = remove the last element from the container The removed object will be deleted (see the method release)

Definition at line 224 of file ObjectVector.h.

                   {
    typename ObjectVector<TYPE>::value_type position = m_vector.back();
    // Set the back pointer to 0 to avoid repetitional searching
    // for the object in the container, and deleting the object
    position->setParent (0);
    delete position;
    // Removing from the container itself
    m_vector.pop_back();
  }

template<class TYPE>

void ObjectVector< TYPE >::push_back ( typename ObjectVector< TYPE >::const_reference value )

inline

push_back = append = insert a new element at the end of the container

Definition at line 199 of file ObjectVector.h.

                                                                      {
    if( 0 != value->parent() ) {
      const_cast<ObjectContainerBase*>(value->parent())->remove(value);
    }
    value->setParent(this);
    m_vector.push_back(value);
  }

template<class TYPE>

ObjectVector<TYPE>::reverse_iterator ObjectVector< TYPE >::rbegin ( )

inline

Return a reverse_iterator pointing to the beginning of the reversed container.

Definition at line 118 of file ObjectVector.h.

                                                        {
    return m_vector.rbegin();
  }

template<class TYPE>

ObjectVector<TYPE>::const_reverse_iterator ObjectVector< TYPE >::rbegin ( ) const

inline

Return a const_reverse_iterator pointing to the beginning of the reversed container.

Definition at line 124 of file ObjectVector.h.

                                                                    {
    return m_vector.rbegin();
  }

template<class TYPE>

virtual long ObjectVector< TYPE >::remove ( ContainedObject * value )

inlinevirtual

Release object from the container (the poiter will be removed from the container, but the object itself will remain alive) (see the method pop_back)

Implements ObjectContainerBase.

Definition at line 236 of file ObjectVector.h.

                                              {
    // Find the object of the value value
    typename ObjectVector<TYPE>::iterator i;
    for( i = begin(); i != end(); i++ ) {
      if( value == *i ) {
        break;
      }
    }
    if( end() == i )  {
      // Object cannot be released from the conatiner,
      // as it is not contained in it
      return StatusCode::FAILURE;
    }
    else  {
      // Set the back pointer to 0 to avoid repetitional searching
      // for the object in the container and deleting the object
      (*i)->setParent (0);
      erase(i);
      return StatusCode::SUCCESS;
    }
  }

template<class TYPE>

ObjectVector<TYPE>::reverse_iterator ObjectVector< TYPE >::rend ( )

inline

Return a reverse_iterator pointing to the end of the reversed container.

Definition at line 129 of file ObjectVector.h.

                                                      {
    return m_vector.rend();
  }

template<class TYPE>

ObjectVector<TYPE>::const_reverse_iterator ObjectVector< TYPE >::rend ( ) const

inline

Return a const_reverse_iterator pointing to the end of the reversed container.

Definition at line 134 of file ObjectVector.h.

                                                                  {
    return m_vector.rend();
  }

template<class TYPE>

void ObjectVector< TYPE >::reserve ( typename ObjectVector< TYPE >::size_type value )

inline

Reserve place for "value" objects in the container.

If "value" is less than or equal to capacity(), this call has no effect, otherwise, it is a request for allocation of additional memory. If the request is successful, then capacity() is >= n, otherwise, capacity() is unchanged. In either case, size() is unchanged

Definition at line 169 of file ObjectVector.h.

                                                             {
    m_vector.reserve( value );
  }

template<class TYPE>

ObjectVector<TYPE>::size_type ObjectVector< TYPE >::size ( ) const

inline

Return the size of the container.

Size means the number of objects stored in the container, independently on the amount of information stored in each object

Definition at line 142 of file ObjectVector.h.

                                                     {
    return m_vector.size();
  }

Member Data Documentation

template<class TYPE>

std::vector<TYPE*> ObjectVector< TYPE >::m_vector

private

The STL vector itself.

Definition at line 349 of file ObjectVector.h.

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

/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v24r2/GaudiKernel/GaudiKernel/ContainedObject.h
/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v24r2/GaudiKernel/GaudiKernel/ObjectVector.h

Gaudi Framework, version v24r2

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class TYPE> class ObjectVector< TYPE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TYPE>
class ObjectVector< TYPE >