#include <GaudiKernel/ObjectVector.h>

Collaboration diagram for ObjectVector:

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 Member Functions
	ObjectVector ()=default
	Constructors. More...

	ObjectVector (const ObjectVector< TYPE > &)=delete

ObjectVector &	operator= (const ObjectVector< TYPE > &)=delete

	ObjectVector (ObjectVector &&rhs)

	~ObjectVector () override
	Destructor. More...

const CLID &	clID () const override
	Retrieve class ID. More...

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

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

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

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

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

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

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

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

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

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

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

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() More...

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

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

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

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

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

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

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

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

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

long	remove (ContainedObject *value) override
	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) More...

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

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

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. More...

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

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

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

long	index (const ContainedObject *obj) const override
	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. More...

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

ContainedObject *	containedObject (long dist) override

std::ostream &	fillStream (std::ostream &s) const override
	Fill the output stream (ASCII) More...

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

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

Detailed Description

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 22 of file ContainedObject.h.

Member Typedef Documentation

◆ const_iterator

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

Definition at line 56 of file ObjectVector.h.

◆ const_pointer

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

Definition at line 65 of file ObjectVector.h.

◆ const_reference

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

Definition at line 53 of file ObjectVector.h.

◆ const_reverse_iterator

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

Definition at line 59 of file ObjectVector.h.

◆ contained_type

typedef TYPE ObjectVector::contained_type

Definition at line 49 of file ObjectVector.h.

◆ iterator

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

Definition at line 55 of file ObjectVector.h.

◆ pointer

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

Definition at line 64 of file ObjectVector.h.

◆ reference

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

Definition at line 52 of file ObjectVector.h.

◆ reverse_iterator

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

Definition at line 58 of file ObjectVector.h.

◆ value_type

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

Definition at line 50 of file ObjectVector.h.

Constructor & Destructor Documentation

◆ ObjectVector() [1/3]

ObjectVector::ObjectVector ( )

default

Constructors.

◆ ObjectVector() [2/3]

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

delete

◆ ObjectVector() [3/3]

ObjectVector::ObjectVector ( ObjectVector && rhs )

inline

Definition at line 73 of file ObjectVector.h.

                                      : ObjectContainerBase( std::move( rhs ) ), m_vector{ std::move( rhs.m_vector ) } {
     std::for_each( begin(), end(), [this]( TYPE* obj ) { obj->setParent( this ); } );
   }

◆ ~ObjectVector()

ObjectVector::~ObjectVector ( )

inlineoverride

Destructor.

Definition at line 78 of file ObjectVector.h.

                            {
     for ( auto& i : m_vector ) {
       // Set the back pointer to 0 to avoid repetitional searching
       // for the object in the container, and deleting the object
       i->setParent( nullptr );
       delete i;
     }
   }

Member Function Documentation

◆ add()

long ObjectVector::add ( ContainedObject * pObject )

inlineoverride

Add an object to the container.

Definition at line 168 of file ObjectVector.h.

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

◆ back() [1/2]

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

inline

Return reference to the last element.

Definition at line 155 of file ObjectVector.h.

155 { return m_vector.back(); }

◆ back() [2/2]

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

inline

Return const_reference to the last element.

Definition at line 158 of file ObjectVector.h.

158 { return m_vector.back(); }

◆ begin() [1/2]

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

inline

Return an iterator pointing to the beginning of the container.

Definition at line 96 of file ObjectVector.h.

96 { return m_vector.begin(); }

◆ begin() [2/2]

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

inline

Return a const_iterator pointing to the beginning of the container.

Definition at line 99 of file ObjectVector.h.

99 { return m_vector.begin(); }

◆ capacity()

ObjectVector<TYPE>::size_type ObjectVector::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 134 of file ObjectVector.h.

134 { return m_vector.capacity(); }

◆ classID()

static const CLID& ObjectVector::classID ( )

inlinestatic

Retrieve class ID.

Definition at line 90 of file ObjectVector.h.

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

◆ clear()

void ObjectVector::clear ( )

inline

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

Definition at line 241 of file ObjectVector.h.

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

◆ clID()

const CLID& ObjectVector::clID ( ) const

inlineoverride

Retrieve class ID.

Definition at line 88 of file ObjectVector.h.

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

◆ containedObject() [1/2]

ContainedObject const* ObjectVector::containedObject ( long dist ) const

inlineoverride

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

Definition at line 260 of file ObjectVector.h.

260 { return m_vector[dist]; }

◆ containedObject() [2/2]

ContainedObject* ObjectVector::containedObject ( long dist )

inlineoverride

Definition at line 261 of file ObjectVector.h.

261 { return m_vector[dist]; }

◆ empty()

bool ObjectVector::empty ( ) const

inline

Return true if the size of the container is 0.

Definition at line 146 of file ObjectVector.h.

146 { return m_vector.empty(); }

◆ end() [1/2]

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

inline

Return an iterator pointing to the end of the container.

Definition at line 102 of file ObjectVector.h.

102 { return m_vector.end(); }

◆ end() [2/2]

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

inline

Return a const_iterator pointing to the end of the container.

Definition at line 105 of file ObjectVector.h.

105 { return m_vector.end(); }

◆ erase() [1/2]

void ObjectVector::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 229 of file ObjectVector.h.

                                                                                                     {
     for ( auto 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( nullptr );
       delete *i;
     }
     // Removing from the container itself
     m_vector.erase( first, last );
   }

◆ erase() [2/2]

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

inline

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

Definition at line 217 of file ObjectVector.h.

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

◆ fillStream()

std::ostream& ObjectVector::fillStream ( std::ostream & s ) const

inlineoverride

Fill the output stream (ASCII)

Definition at line 264 of file ObjectVector.h.

                                                          {
     s << "class ObjectVector :    size = " << std::setw( 12 ) << size() << "\n";
     // Output the base class
     // ObjectContainerBase::fillStream(s);
     if ( !empty() ) {
       s << "\nContents of the STL vector :";
       long count = 0;
       for ( const auto& i : m_vector ) { s << "\nIndex " << std::setw( 12 ) << count++ << " of object of type " << *i; }
     }
     return s;
   }

◆ front() [1/2]

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

inline

Return reference to the first element.

Definition at line 149 of file ObjectVector.h.

149 { return m_vector.front(); }

◆ front() [2/2]

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

inline

Return const_reference to the first element.

Definition at line 152 of file ObjectVector.h.

152 { return m_vector.front(); }

◆ index()

long ObjectVector::index ( const ContainedObject * obj ) const

inlineoverride

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.

Definition at line 254 of file ObjectVector.h.

                                                           {
     auto i = std::find_if( begin(), end(), [&]( const ContainedObject* o ) { return o == obj; } );
     return i != end() ? std::distance( begin(), i ) : -1;
   }

◆ insert()

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

inline

Insert "value" before "position".

Definition at line 210 of file ObjectVector.h.

                                                                                                    {
     value->setParent( this );
     return m_vector.insert( position, value );
   }

◆ max_size()

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

inline

Return the largest possible size of the container.

Definition at line 130 of file ObjectVector.h.

130 { return m_vector.max_size(); }

◆ numberOfObjects()

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

inlineoverride

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

Definition at line 127 of file ObjectVector.h.

127 { return m_vector.size(); }

◆ operator=()

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

delete

◆ operator[]() [1/2]

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

inline

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

Definition at line 244 of file ObjectVector.h.

244 { return m_vector[n]; }

◆ operator[]() [2/2]

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

inline

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

Definition at line 247 of file ObjectVector.h.

                                                                                                         {
     return m_vector[n];
   }

◆ pop_back()

void ObjectVector::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 181 of file ObjectVector.h.

                   {
     auto 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( nullptr );
     delete position;
     // Removing from the container itself
     m_vector.pop_back();
   }

◆ push_back()

void ObjectVector::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 161 of file ObjectVector.h.

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

◆ rbegin() [1/2]

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

inline

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

Definition at line 108 of file ObjectVector.h.

108 { return m_vector.rbegin(); }

◆ rbegin() [2/2]

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

inline

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

Definition at line 112 of file ObjectVector.h.

112 { return m_vector.rbegin(); }

◆ remove()

long ObjectVector::remove ( ContainedObject * value )

inlineoverride

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)

Definition at line 193 of file ObjectVector.h.

                                                  {
     // Find the object of the value value
     auto i = std::find_if( begin(), end(), [&]( const ContainedObject* j ) { return j == value; } );
     if ( i == end() ) {
       // Object cannot be released from the conatiner,
       // as it is not contained in it
       return 0;
     }
     long idx = std::distance( begin(), i );
     // Set the back pointer to 0 to avoid repetitional searching
     // for the object in the container and deleting the object
     ( *i )->setParent( nullptr );
     erase( i );
     return idx;
   }

◆ rend() [1/2]

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

inline

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

Definition at line 115 of file ObjectVector.h.

115 { return m_vector.rend(); }

◆ rend() [2/2]

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

inline

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

Definition at line 118 of file ObjectVector.h.

118 { return m_vector.rend(); }

◆ reserve()

void ObjectVector::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 143 of file ObjectVector.h.

143 { m_vector.reserve( value ); }

◆ size()

ObjectVector<TYPE>::size_type ObjectVector::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 124 of file ObjectVector.h.

124 { return m_vector.size(); }

Member Data Documentation

◆ m_vector

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

private

The STL vector itself.

Definition at line 278 of file ObjectVector.h.

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

GaudiKernel/include/GaudiKernel/ContainedObject.h
GaudiKernel/include/GaudiKernel/ObjectVector.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ contained_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ value_type

Constructor & Destructor Documentation

◆ ObjectVector() [1/3]

◆ ObjectVector() [2/3]

◆ ObjectVector() [3/3]

◆ ~ObjectVector()

Member Function Documentation

◆ add()

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ classID()

◆ clear()

◆ clID()

◆ containedObject() [1/2]

◆ containedObject() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ fillStream()

◆ front() [1/2]

◆ front() [2/2]

◆ index()

◆ insert()

◆ max_size()

◆ numberOfObjects()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ push_back()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ remove()

◆ rend() [1/2]

◆ rend() [2/2]

◆ reserve()

◆ size()

Member Data Documentation

◆ m_vector