RelationVector< T > Class Template Reference

Class for type safe access to objects that are referred to in relations. More...

#include <RelationVector.h>

Public Types
typedef ArrayIterator< RelationVector< T >, T >	iterator
	STL-like iterator over the T objects (not T* ).
typedef ArrayIterator< RelationVector< T >, const T >	const_iterator
	STL-like const_iterator over the T objects (not T* ).

Public Member Functions
	RelationVector (const RelationVectorBase &b)
	Constructor. More...
const std::vector< Belle2::RelationEntry > &	relations () const
	Accessor for the relations vector. More...
size_t	size () const
	Get number of relations. More...
T *	object (int index) const
	Get object with index. More...
T *	operator[] (int index) const
	Get object with index. More...
float	weight (int index) const
	Get weight with index. More...
void	remove (int index)
	Remove relation at given index. More...
void	setWeight (int index, float weight)
	Set a new weight for the given relation.
iterator	begin ()
	Return iterator to first entry.
iterator	end ()
	Return iterator to last entry +1.
const_iterator	begin () const
	Return const_iterator to first entry.
const_iterator	end () const
	Return const_iterator to last entry +1.

Detailed Description

template<class T>
class Belle2::RelationVector< T >

Class for type safe access to objects that are referred to in relations.

Objects of this class are returned by RelationsObject functinons to provide type safe access to the objects in a vector of relations returned by the data store.

Besides accessing objects/weights directly using operator[](int) and weight(int), you can also iterate over the objects directly:

const MCParticle* particle = particles[i];
for (const CDCSimHit& simhit :  particle->getRelationsTo<CDCSimHit>()) {
  //do things with simhit
}

If you want to modify the related objects in the loop body, you can use a non-const reference instead.

Use setWeight() to modify the weight of a single relation. Use remove() to delete a relation.

Definition at line 38 of file DataStore.h.

Constructor & Destructor Documentation

RelationVector()

RelationVector ( const RelationVectorBase &  b )

inlineexplicit

Constructor.

Parameters

b	Not type-safe base class containing the data

Definition at line 89 of file RelationVector.h.

{ return m_relations.size();}

Member Function Documentation

object()

T* object ( int  index ) const

inline

Get object with index.

Parameters

index

Index of relation.

Returns

Object that the relation points to.

Definition at line 106 of file RelationVector.h.

operator[]()

T* operator[] ( int  index ) const

inline

Get object with index.

Parameters

index

Index of relation.

Returns

Object that the relation points to.

Definition at line 113 of file RelationVector.h.

relations()

const std::vector<Belle2::RelationEntry>& relations ( ) const

inline

Accessor for the relations vector.

Returns

Vector of RelationEntry objects.

Definition at line 95 of file RelationVector.h.

remove()

void remove ( int  index )

inline

Remove relation at given index.

This will decrease size() by one. Iterators pointing beyond given index will be invalidated when calling this function.

Note

May be slow if done frequently.

Definition at line 129 of file RelationVector.h.

size()

size_t size ( ) const

inline

Get number of relations.

Definition at line 98 of file RelationVector.h.

weight()

float weight ( int  index ) const

inline

Get weight with index.

Parameters

index

Index of relation.

Returns

Weight that the relation has.

Definition at line 120 of file RelationVector.h.

---

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

• framework/datastore/include/DataStore.h
• framework/datastore/include/RelationVector.h