DataLinkVector< DC > Class Template Reference

This class is a a vector of DataLink for objects of type DC It uses an internal chain to keep track of modified entries. More...

#include <DataLinkVector.h>

Inheritance diagram for DataLinkVector< DC >:

Collaboration diagram for DataLinkVector< DC >:

Classes
class	DataHolder
	class DataHolder is a simple class which holds a pointer to an object of type DC. More...
class	Entry
	class Entry is a link in a chained list, used for efficient cleanup of vectors. More...
class	iterator
	class iterator - iterator over elements in DataLinkVector which manages the Entry objects More...

Public Types
typedef DC	value_type
typedef DC *	pointer
typedef const DC *	const_pointer
typedef DC &	reference
typedef const DC &	const_reference
typedef DataHolder	DataLinkT
typedef DataLinkVector< DC >	MyType
typedef std::vector< Entry >	EntryVector
typedef EntryVector::iterator	EntryVectorIt

Public Member Functions
	DataLinkVector ()
	Default constructor.
	~DataLinkVector ()
	Default destructor.
void	init (unsigned int nbr)
	initialize vector with nbr DataLinks
iterator	begin () const
	return iterator on first entry
iterator	end () const
	return iterator on after last entry
iterator	find (IdentifierHash id) const
	return iterator on the found entry or end() if out of range
bool	setObjectOwnership (IdentifierHash idhash, bool flag)
	set object ownership
DataLinkT &	operator[] (int id)
	return reference on DataLink BEWARE: Doesn't check for boundary limits !
virtual void	cleanup ()
	cleans up the DataLinkVector goes trough all chained entries and call clear() method of DataLink and clear chain of course.
int	size () const
	access to size of vector

Protected Member Functions
void	chainEntry (Entry *e) const
	add pointed entry in chain of modified entries

Protected Attributes
EntryVector	m_vect
Entry *	m_last

Friends
class	iterator

Detailed Description

template<class DC>
class DataLinkVector< DC >

This class is a a vector of DataLink for objects of type DC It uses an internal chain to keep track of modified entries.

A call to cleanup is required after processing an event or prior to process a new event. cleanup will call the clear() method of all the touched DataLink instances. The template expects the DataLink to export the DigitCollection class type (DC) and the DigitCollection identifier type

Definition at line 33 of file DataLinkVector.h.

Member Typedef Documentation

const_pointer

template<class DC>

typedef const DC* DataLinkVector< DC >::const_pointer

Definition at line 39 of file DataLinkVector.h.

const_reference

template<class DC>

typedef const DC& DataLinkVector< DC >::const_reference

Definition at line 41 of file DataLinkVector.h.

DataLinkT

template<class DC>

typedef DataHolder DataLinkVector< DC >::DataLinkT

Definition at line 80 of file DataLinkVector.h.

EntryVector

template<class DC>

typedef std::vector<Entry> DataLinkVector< DC >::EntryVector

Definition at line 121 of file DataLinkVector.h.

EntryVectorIt

template<class DC>

typedef EntryVector::iterator DataLinkVector< DC >::EntryVectorIt

Definition at line 122 of file DataLinkVector.h.

MyType

template<class DC>

typedef DataLinkVector<DC> DataLinkVector< DC >::MyType

Definition at line 81 of file DataLinkVector.h.

pointer

template<class DC>

typedef DC* DataLinkVector< DC >::pointer

Definition at line 38 of file DataLinkVector.h.

reference

template<class DC>

typedef DC& DataLinkVector< DC >::reference

Definition at line 40 of file DataLinkVector.h.

value_type

template<class DC>

typedef DC DataLinkVector< DC >::value_type

Definition at line 37 of file DataLinkVector.h.

Constructor & Destructor Documentation

DataLinkVector()

template<class DC>

DataLinkVector< DC >::DataLinkVector

(

)

Default constructor.

Definition at line 407 of file DataLinkVector.h.

        : m_last(NULL) { }

~DataLinkVector()

template<class DC>

DataLinkVector< DC >::~DataLinkVector

(

)

Default destructor.

Definition at line 412 of file DataLinkVector.h.

{
    this->cleanup();
}

Member Function Documentation

begin()

template<class DC>

DataLinkVector< DC >::iterator DataLinkVector< DC >::begin

(

)

const

return iterator on first entry

Definition at line 429 of file DataLinkVector.h.

{ return iterator( this, m_vect.begin() ); }

chainEntry()

template<class DC>

void DataLinkVector< DC >::chainEntry ( Entry * e ) const

protected

add pointed entry in chain of modified entries

Definition at line 502 of file DataLinkVector.h.

{
    if( m_last == NULL ) {
        e->setPreviousEntry(e);
        m_last = e;
    }
    else {
        e->setPreviousEntry(m_last->previousEntry());
        m_last->setPreviousEntry(e);
    }
}

cleanup()

template<class DC>

void DataLinkVector< DC >::cleanup ( )

virtual

cleans up the DataLinkVector goes trough all chained entries and call clear() method of DataLink and clear chain of course.

Definition at line 474 of file DataLinkVector.h.

{
    Entry *e;
    // assign last to e and check if it is not NULL
    if( (e = m_last) )
        {
            // for chained entries
            do {
                Entry * tmp = e->previousEntry();
                e->setPreviousEntry(NULL); // clear chain pointer
                if (e->ownObject())     // delete object
                    delete (e->dataLink()).getDataPtr();
                e->dataLink().reset(); // reset keeps it in identified state.
                e->setOwnObject(false); // doesn't own object
                e = tmp;    // go to next entry
            } while( e != m_last ); // until we end where we started
            m_last = NULL;    // clear chain hook
        }
}

end()

template<class DC>

DataLinkVector< DC >::iterator DataLinkVector< DC >::end

(

)

const

return iterator on after last entry

Definition at line 435 of file DataLinkVector.h.

{ return iterator( this, m_vect.end()); }

find()

template<class DC>

DataLinkVector< DC >::iterator DataLinkVector< DC >::find

(

IdentifierHash

id

)

const

return iterator on the found entry or end() if out of range

Definition at line 441 of file DataLinkVector.h.

{ return ( (id >= m_vect.size() )
           ?end():iterator(this,m_vect.begin()+id));}

init()

template<class DC>

void DataLinkVector< DC >::init

(

unsigned int

nbr

)

initialize vector with nbr DataLinks

Definition at line 420 of file DataLinkVector.h.

{
    // fill in vector of Entry
    m_vect.resize(nbr); 
}

operator[]()

template<class DC>

DataLinkVector< DC >::DataLinkT & DataLinkVector< DC >::operator[]

(

int

id

)

return reference on DataLink BEWARE: Doesn't check for boundary limits !

Definition at line 461 of file DataLinkVector.h.

{ 
    Entry* e = &(m_vect[id]);
    if( !e->previousEntry() )
        chainEntry( e );
    return e->dataLink();
}

setObjectOwnership()

template<class DC>

bool DataLinkVector< DC >::setObjectOwnership	(	IdentifierHash	idhash,
		bool	flag )

set object ownership

Definition at line 448 of file DataLinkVector.h.

{
    if ( idhash >= m_vect.size() )
        return false;
    Entry& e = *(m_vect.begin()+idhash);
    e.setOwnObject(flag);
    return true;
}

size()

template<class DC>

int DataLinkVector< DC >::size

(

)

const

access to size of vector

Definition at line 496 of file DataLinkVector.h.

                               {
    return m_vect.size(); 
}

Friends And Related Symbol Documentation

iterator

template<class DC>

friend class iterator

friend

Definition at line 175 of file DataLinkVector.h.

Member Data Documentation

m_last

template<class DC>

Entry* DataLinkVector< DC >::m_last

mutableprotected

Definition at line 217 of file DataLinkVector.h.

m_vect

template<class DC>

EntryVector DataLinkVector< DC >::m_vect

mutableprotected

Definition at line 216 of file DataLinkVector.h.

---

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

• DataLinkVector.h