Gaudi Framework, version v23r0 |
Home | Generated: Mon Jan 30 2012 |
Very simple class to represent the container of objects which are not ownered by the container. More...
#include <SharedObjectsContainer.h>
Public Types | |
typedef std::vector< const TYPE * > | ConstVector |
the actual container type | |
typedef ConstVector::value_type | value_type |
various types (to make STL happy) | |
typedef ConstVector::size_type | size_type |
size_type, to conform the STL container interface | |
typedef ConstVector::reference | reference |
typedef ConstVector::const_reference | const_reference |
typedef ConstVector::iterator | iterator |
typedef ConstVector::const_iterator | const_iterator |
typedef ConstVector::reverse_iterator | reverse_iterator |
typedef ConstVector::const_reverse_iterator | const_reverse_iterator |
Public Member Functions | |
SharedObjectsContainer () | |
SharedObjectsContainer (const ConstVector &data) | |
template<class DATA > | |
SharedObjectsContainer (DATA first, DATA last) | |
the templated constructor from the pair of iterators | |
template<class DATA , class PREDICATE > | |
SharedObjectsContainer (DATA first, DATA last, const PREDICATE &cut) | |
the templated constructor from the pair of iterators and the predicate. | |
virtual | ~SharedObjectsContainer () |
destructor | |
virtual const CLID & | clID () const |
Retrieve the unique class ID (virtual) | |
const ConstVector & | data () const |
get the access to the underlying container (const) | |
operator const ConstVector & () const | |
cast to the underlying container | |
size_type | size () const |
get the actual size of the container | |
bool | empty () const |
empty container? | |
void | push_back (const TYPE *object) |
insert one object into the container | |
void | insert (const TYPE *object) |
insert one object into the container | |
template<class DATA > | |
void | insert (DATA first, DATA last) |
add the sequence of objects into the container | |
template<class DATA , class PREDICATE > | |
void | insert (DATA first, DATA last, const PREDICATE &cut) |
add the sequence of 'good'objects into the container | |
template<class OUTPUT , class PREDICATE > | |
OUTPUT | get (const PREDICATE &cut, OUTPUT output) const |
get from the container all objects which satisfy the certain criteria | |
void | erase (iterator i) |
erase the object by iterator | |
template<class PREDICATE > | |
void | erase (const PREDICATE &cut) |
erase the objects which satisfy the criteria | |
bool | erase (const TYPE *object) |
erase the first occurance of the certain element | |
reference | operator[] (size_type index) |
index access | |
const_reference | operator[] (size_type index) const |
index access (const-version) | |
reference | operator() (size_type index) |
'functional'-access | |
const_reference | operator() (size_type index) const |
'functional'-access (const version) | |
reference | at (size_type index) |
checked access | |
const_reference | at (size_type index) const |
checked access (const-version) | |
iterator | begin () |
iterator | end () |
const_iterator | begin () const |
const_iterator | end () const |
reverse_iterator | rbegin () |
reverse_iterator | rend () |
const_reverse_iterator | rbegin () const |
const_reverse_iterator | rend () const |
reference | front () |
the first element (only for non-empty vectors) | |
const_reference | front () const |
the first element (only for non-empty vectors) (const-version) | |
reference | back () |
the last element (only for non-empty vectors) | |
const_reference | back () const |
the last element (only for non-empty vectors) (const-version) | |
bool | operator== (const SharedObjectsContainer &right) const |
equal content with other container ? | |
bool | operator== (const ConstVector &right) const |
equal content with corresponding vector ? | |
bool | operator< (const SharedObjectsContainer &right) const |
comparisons with other container | |
bool | operator< (const ConstVector &right) const |
comparisons with corresponding vector | |
virtual long | index (const ContainedObject *object) const |
Distance of a given object from the beginning of its container. | |
virtual ContainedObject * | containedObject (long index) const |
Pointer to an object of a given distance. | |
virtual size_type | numberOfObjects () const |
Number of objects in the container. | |
virtual long | add (ContainedObject *object) |
Virtual functions (forwards to the concrete container definitions) Add an object to the container. | |
virtual long | remove (ContainedObject *value) |
Release object from the container (the pointer will be removed from the container, but the object itself will remain alive). | |
Static Public Member Functions | |
static const CLID & | classID () |
Retrieve the unuqie class ID (static) | |
Private Attributes | |
ConstVector | m_data |
Very simple class to represent the container of objects which are not ownered by the container.
This concept seem to be very useful for LHCb HLT, DaVinci, tracking, alignments.
Definition at line 30 of file SharedObjectsContainer.h.
typedef ConstVector::const_iterator SharedObjectsContainer< TYPE >::const_iterator |
Definition at line 42 of file SharedObjectsContainer.h.
typedef ConstVector::const_reference SharedObjectsContainer< TYPE >::const_reference |
Definition at line 40 of file SharedObjectsContainer.h.
typedef ConstVector::const_reverse_iterator SharedObjectsContainer< TYPE >::const_reverse_iterator |
Definition at line 44 of file SharedObjectsContainer.h.
typedef std::vector<const TYPE*> SharedObjectsContainer< TYPE >::ConstVector |
the actual container type
Definition at line 35 of file SharedObjectsContainer.h.
typedef ConstVector::iterator SharedObjectsContainer< TYPE >::iterator |
Definition at line 41 of file SharedObjectsContainer.h.
typedef ConstVector::reference SharedObjectsContainer< TYPE >::reference |
Definition at line 39 of file SharedObjectsContainer.h.
typedef ConstVector::reverse_iterator SharedObjectsContainer< TYPE >::reverse_iterator |
Definition at line 43 of file SharedObjectsContainer.h.
typedef ConstVector::size_type SharedObjectsContainer< TYPE >::size_type |
size_type, to conform the STL container interface
Reimplemented from ObjectContainerBase.
Definition at line 38 of file SharedObjectsContainer.h.
typedef ConstVector::value_type SharedObjectsContainer< TYPE >::value_type |
various types (to make STL happy)
Definition at line 37 of file SharedObjectsContainer.h.
SharedObjectsContainer< TYPE >::SharedObjectsContainer | ( | ) | [inline] |
Definition at line 49 of file SharedObjectsContainer.h.
: ObjectContainerBase () , m_data() {} ;
SharedObjectsContainer< TYPE >::SharedObjectsContainer | ( | const ConstVector & | data ) | [inline] |
Definition at line 52 of file SharedObjectsContainer.h.
: ObjectContainerBase () , m_data ( data ) {}
SharedObjectsContainer< TYPE >::SharedObjectsContainer | ( | DATA | first, |
DATA | last | ||
) | [inline] |
the templated constructor from the pair of iterators
first | 'begin'-iterator of the input sequence |
last | 'last'-iterator of the input sequence |
Definition at line 60 of file SharedObjectsContainer.h.
: DataObject () , m_data ( first , last ) {}
SharedObjectsContainer< TYPE >::SharedObjectsContainer | ( | DATA | first, |
DATA | last, | ||
const PREDICATE & | cut | ||
) | [inline] |
the templated constructor from the pair of iterators and the predicate.
Only the elements which satisfy the criteria goes into the container e.g. create the container only with "basic" particles:
typedef SharedObjectsContainer<LHCb::Particle> PARTICLES ; // some sequence of someting, convertiblle to "const LHCb::Particle*": SEQUENCE source = ... ; PARTICLES* particles = new PARTICLES ( source.begin() , source.end () , std::mem_fun(&LHCb::Particle::isBasic) ) ;
first | 'begin'-iterator if the input sequence |
last | 'last'-iterator of the input sequence |
cut | pre predicate |
Definition at line 90 of file SharedObjectsContainer.h.
: DataObject () , m_data () { insert ( first , last , cut ) ; }
virtual SharedObjectsContainer< TYPE >::~SharedObjectsContainer | ( | ) | [inline, virtual] |
virtual long SharedObjectsContainer< TYPE >::add | ( | ContainedObject * | object ) | [inline, virtual] |
Virtual functions (forwards to the concrete container definitions) Add an object to the container.
On success the object's index is returned.
Implements ObjectContainerBase.
Definition at line 346 of file SharedObjectsContainer.h.
reference SharedObjectsContainer< TYPE >::at | ( | size_type | index ) | [inline] |
checked access
Definition at line 279 of file SharedObjectsContainer.h.
const_reference SharedObjectsContainer< TYPE >::at | ( | size_type | index ) | const [inline] |
checked access (const-version)
Definition at line 281 of file SharedObjectsContainer.h.
const_reference SharedObjectsContainer< TYPE >::back | ( | void | ) | const [inline] |
the last element (only for non-empty vectors) (const-version)
Definition at line 303 of file SharedObjectsContainer.h.
reference SharedObjectsContainer< TYPE >::back | ( | void | ) | [inline] |
the last element (only for non-empty vectors)
Definition at line 301 of file SharedObjectsContainer.h.
iterator SharedObjectsContainer< TYPE >::begin | ( | void | ) | [inline] |
Definition at line 285 of file SharedObjectsContainer.h.
const_iterator SharedObjectsContainer< TYPE >::begin | ( | void | ) | const [inline] |
Definition at line 287 of file SharedObjectsContainer.h.
static const CLID& SharedObjectsContainer< TYPE >::classID | ( | ) | [inline, static] |
Retrieve the unuqie class ID (static)
Reimplemented from DataObject.
Definition at line 107 of file SharedObjectsContainer.h.
{ static const CLID s_clid = ( ( static_cast<CLID> ( -1 ) << 16 ) // 16 used and 16 empty bits & !CLID_ObjectVector // not an ObjectVector & !CLID_ObjectList // not an ObjectList & !static_cast<CLID> ( 0x00030000 ) // not a KeyedContainer/map & !static_cast<CLID> ( 0x00040000 ) )// not a KeyedContainer/hashmap + TYPE::classID() ; // the specific CLID from the contents // return s_clid; }
virtual const CLID& SharedObjectsContainer< TYPE >::clID | ( | ) | const [inline, virtual] |
Retrieve the unique class ID (virtual)
Reimplemented from DataObject.
Definition at line 104 of file SharedObjectsContainer.h.
{ return SharedObjectsContainer<TYPE>::classID(); }
virtual ContainedObject* SharedObjectsContainer< TYPE >::containedObject | ( | long | index ) | const [inline, virtual] |
Pointer to an object of a given distance.
index | th eindex to be checked |
Implements ObjectContainerBase.
Definition at line 334 of file SharedObjectsContainer.h.
{ if ( 0 > index || !(index < (long) size () ) ) { return 0 ; } // RETURN const ContainedObject* co = m_data[index] ; return const_cast<ContainedObject*>( co ) ; }
const ConstVector& SharedObjectsContainer< TYPE >::data | ( | ) | const [inline] |
get the access to the underlying container (const)
Definition at line 123 of file SharedObjectsContainer.h.
{ return m_data ; }
bool SharedObjectsContainer< TYPE >::empty | ( | void | ) | const [inline] |
empty container?
Definition at line 132 of file SharedObjectsContainer.h.
iterator SharedObjectsContainer< TYPE >::end | ( | void | ) | [inline] |
Definition at line 286 of file SharedObjectsContainer.h.
const_iterator SharedObjectsContainer< TYPE >::end | ( | void | ) | const [inline] |
Definition at line 288 of file SharedObjectsContainer.h.
void SharedObjectsContainer< TYPE >::erase | ( | iterator | i ) | [inline] |
erase the object by iterator
Definition at line 221 of file SharedObjectsContainer.h.
void SharedObjectsContainer< TYPE >::erase | ( | const PREDICATE & | cut ) | [inline] |
erase the objects which satisfy the criteria
E.g. remove all particles with small transverse momentum
namespace bl = boost::lambda ; typedef SharedObjectsContainer<LHCb::Particle> PARTICLES ; PARTICLES* particles = ... ; particles -> erase ( bl::bind(&LHCb::Particle::pt,bl::_1) < 1 * Gaudi::Units::GeV ) ;
cut | predicate |
Definition at line 240 of file SharedObjectsContainer.h.
bool SharedObjectsContainer< TYPE >::erase | ( | const TYPE * | object ) | [inline] |
erase the first occurance of the certain element
To remove all occurances one can use:
typedef SharedObjectsContainer<LHCb::Particle> PARTICLES ; PARTICLES* particles = ... ; const LHCb::Particle* B = ... ; // remove all occurances while ( particles -> erase ( B ) ) {} ;
object | the element to be removed |
Definition at line 260 of file SharedObjectsContainer.h.
reference SharedObjectsContainer< TYPE >::front | ( | ) | [inline] |
the first element (only for non-empty vectors)
Definition at line 297 of file SharedObjectsContainer.h.
const_reference SharedObjectsContainer< TYPE >::front | ( | void | ) | const [inline] |
the first element (only for non-empty vectors) (const-version)
Definition at line 299 of file SharedObjectsContainer.h.
OUTPUT SharedObjectsContainer< TYPE >::get | ( | const PREDICATE & | cut, |
OUTPUT | output | ||
) | const [inline] |
get from the container all objects which satisfy the certain criteria
E.g. get all particles with transverse momentum in excess of 1 * GeV
namespace bl = boost::lambda ; typedef SharedObjectsContainer<LHCb::Particle> PARTICLES ; typedef std::vector<const LHCb::Particle*> TARGET ; PARTICLES* particles = ... ; TARGET target ; particles -> get ( bl::bind(&LHCb::Particle::pt,bl::_1) > 1 * Gaudi::Units::GeV , std::back_inserter ( target ) ) ;
Essentially this functionality is very useful due to missing "std::copy_if".
cut | the predicate |
outptut | the output iterator |
Definition at line 213 of file SharedObjectsContainer.h.
{ for ( const_iterator iobj = begin() ; end() != iobj ; ++iobj ) { if ( cut ( *iobj ) ) { *output = *iobj ; ++output ; } } return output ; }
virtual long SharedObjectsContainer< TYPE >::index | ( | const ContainedObject * | object ) | const [inline, virtual] |
Distance of a given object from the beginning of its container.
object | the object to be checked |
Implements ObjectContainerBase.
Definition at line 325 of file SharedObjectsContainer.h.
void SharedObjectsContainer< TYPE >::insert | ( | const TYPE * | object ) | [inline] |
insert one object into the container
object | object to be added |
Definition at line 140 of file SharedObjectsContainer.h.
void SharedObjectsContainer< TYPE >::insert | ( | DATA | first, |
DATA | last, | ||
const PREDICATE & | cut | ||
) | [inline] |
add the sequence of 'good'objects into the container
Only the objects which satisfy the predicate go to the container, e.g. put into container only particles which transverse momentum in excess of 1 * GeV:
namespace bl = boost::lambda ; typedef SharedObjectsContainer<LHCb::Particle> PARTICLES ; // some sequence of someting, convertible to "const LHCb::Particle*": SEQUENCE source = ... ; PARTICLES* particles = ... ; particles -> insert ( source.begin() , source.end () , bl::bind(&LHCb::Particle::pt,bl::_1) > 1 * Gaudi::Units::GeV ) ;
first | 'begin'-iterator for the sequnce |
last | 'end'-iterator for the sequence |
cut | the predicate to be applied |
Definition at line 177 of file SharedObjectsContainer.h.
void SharedObjectsContainer< TYPE >::insert | ( | DATA | first, |
DATA | last | ||
) | [inline] |
add the sequence of objects into the container
first | 'begin'-iterator for the sequnce |
last | 'end'-iterator for the sequence |
Definition at line 147 of file SharedObjectsContainer.h.
virtual size_type SharedObjectsContainer< TYPE >::numberOfObjects | ( | ) | const [inline, virtual] |
Number of objects in the container.
Implements ObjectContainerBase.
Definition at line 341 of file SharedObjectsContainer.h.
SharedObjectsContainer< TYPE >::operator const ConstVector & | ( | ) | const [inline] |
cast to the underlying container
Definition at line 125 of file SharedObjectsContainer.h.
{ return data () ; }
reference SharedObjectsContainer< TYPE >::operator() | ( | size_type | index ) | [inline] |
'functional'-access
Definition at line 275 of file SharedObjectsContainer.h.
const_reference SharedObjectsContainer< TYPE >::operator() | ( | size_type | index ) | const [inline] |
'functional'-access (const version)
Definition at line 277 of file SharedObjectsContainer.h.
bool SharedObjectsContainer< TYPE >::operator< | ( | const ConstVector & | right ) | const [inline] |
comparisons with corresponding vector
Definition at line 317 of file SharedObjectsContainer.h.
bool SharedObjectsContainer< TYPE >::operator< | ( | const SharedObjectsContainer< TYPE > & | right ) | const [inline] |
comparisons with other container
Definition at line 314 of file SharedObjectsContainer.h.
bool SharedObjectsContainer< TYPE >::operator== | ( | const ConstVector & | right ) | const [inline] |
equal content with corresponding vector ?
Definition at line 311 of file SharedObjectsContainer.h.
bool SharedObjectsContainer< TYPE >::operator== | ( | const SharedObjectsContainer< TYPE > & | right ) | const [inline] |
equal content with other container ?
Definition at line 308 of file SharedObjectsContainer.h.
reference SharedObjectsContainer< TYPE >::operator[] | ( | size_type | index ) | [inline] |
const_reference SharedObjectsContainer< TYPE >::operator[] | ( | size_type | index ) | const [inline] |
index access (const-version)
Definition at line 273 of file SharedObjectsContainer.h.
void SharedObjectsContainer< TYPE >::push_back | ( | const TYPE * | object ) | [inline] |
insert one object into the container
object | object to be added |
Definition at line 136 of file SharedObjectsContainer.h.
const_reverse_iterator SharedObjectsContainer< TYPE >::rbegin | ( | ) | const [inline] |
Definition at line 291 of file SharedObjectsContainer.h.
reverse_iterator SharedObjectsContainer< TYPE >::rbegin | ( | void | ) | [inline] |
Definition at line 289 of file SharedObjectsContainer.h.
virtual long SharedObjectsContainer< TYPE >::remove | ( | ContainedObject * | value ) | [inline, virtual] |
Release object from the container (the pointer will be removed from the container, but the object itself will remain alive).
If the object was found it's index is returned.
Implements ObjectContainerBase.
Definition at line 359 of file SharedObjectsContainer.h.
reverse_iterator SharedObjectsContainer< TYPE >::rend | ( | ) | [inline] |
Definition at line 290 of file SharedObjectsContainer.h.
const_reverse_iterator SharedObjectsContainer< TYPE >::rend | ( | void | ) | const [inline] |
Definition at line 292 of file SharedObjectsContainer.h.
size_type SharedObjectsContainer< TYPE >::size | ( | void | ) | const [inline] |
get the actual size of the container
Definition at line 130 of file SharedObjectsContainer.h.
ConstVector SharedObjectsContainer< TYPE >::m_data [private] |
Definition at line 371 of file SharedObjectsContainer.h.