StFmsCollection Class Reference

#include <StFmsCollection.h>

Inheritance diagram for StFmsCollection:

Collaboration diagram for StFmsCollection:

Public Member Functions
	StFmsCollection ()
	~StFmsCollection ()
void	addHit (StFmsHit *)
void	addCluster (StFmsCluster *)
void	addPoint (StFmsPoint *)
unsigned int	numberOfHits () const
unsigned int	numberOfClusters () const
unsigned int	numberOfPoints () const
StSPtrVecFmsHit &	hits ()
const StSPtrVecFmsHit &	hits () const
StSPtrVecFmsCluster &	clusters ()
const StSPtrVecFmsCluster &	clusters () const
StSPtrVecFmsPoint &	points ()
const StSPtrVecFmsPoint &	points () const

Private Attributes
StSPtrVecFmsHit	mHits
	Owns all FMS hits. More...
StSPtrVecFmsCluster	mClusters
	Owns all FMS clusters. More...
StSPtrVecFmsPoint	mPoints
	Owns all FMS points (photons) More...

Detailed Description

Collection of all hits (towers), clusters and points (photons) in the FMS.

This collection owns all these objects, and is itself owned by StEvent. It is therefore vital to not delete any of the objects stored in this container yourself - the collection will handle freeing memory. Similarly, any object added to the collection via an add() method must be allocated with new, and not be owned anywhere else.

Definition at line 36 of file StFmsCollection.h.

Constructor & Destructor Documentation

StFmsCollection::StFmsCollection

(

)

Constructor

Definition at line 21 of file StFmsCollection.cxx.

StFmsCollection::~StFmsCollection

(

)

Destructor. Deletes all hits, clusters and points

Definition at line 23 of file StFmsCollection.cxx.

Member Function Documentation

void StFmsCollection::addCluster

(

StFmsCluster *

cluster

)

Add a cluster to the collection

Definition at line 41 of file StFmsCollection.cxx.

Here is the caller graph for this function:

void StFmsCollection::addHit

(

StFmsHit *

hit

)

Add a hit to the collection

Definition at line 37 of file StFmsCollection.cxx.

Here is the caller graph for this function:

void StFmsCollection::addPoint

(

StFmsPoint *

point

)

Add a point to the collection

Definition at line 45 of file StFmsCollection.cxx.

Here is the caller graph for this function:

StSPtrVecFmsCluster & StFmsCollection::clusters

(

)

Return the cluster list

Definition at line 57 of file StFmsCollection.cxx.

Here is the caller graph for this function:

const StSPtrVecFmsCluster & StFmsCollection::clusters

(

)

const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 61 of file StFmsCollection.cxx.

StSPtrVecFmsHit & StFmsCollection::hits

(

)

Return the hit list

Definition at line 49 of file StFmsCollection.cxx.

Here is the caller graph for this function:

const StSPtrVecFmsHit & StFmsCollection::hits

(

)

const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 53 of file StFmsCollection.cxx.

unsigned int StFmsCollection::numberOfClusters

(

)

const

Return the number of clusters in the collection

Definition at line 29 of file StFmsCollection.cxx.

Here is the caller graph for this function:

unsigned int StFmsCollection::numberOfHits

(

)

const

Return the number of hits in the collection

Definition at line 25 of file StFmsCollection.cxx.

Here is the caller graph for this function:

unsigned int StFmsCollection::numberOfPoints

(

)

const

Return the number of points in the collection

Definition at line 33 of file StFmsCollection.cxx.

Here is the caller graph for this function:

StSPtrVecFmsPoint & StFmsCollection::points

(

)

Return the cluster list

Definition at line 65 of file StFmsCollection.cxx.

Here is the caller graph for this function:

const StSPtrVecFmsPoint & StFmsCollection::points

(

)

const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 69 of file StFmsCollection.cxx.

Member Data Documentation

StSPtrVecFmsCluster StFmsCollection::mClusters

private

Owns all FMS clusters.

Definition at line 69 of file StFmsCollection.h.

StSPtrVecFmsHit StFmsCollection::mHits

private

Owns all FMS hits.

Definition at line 68 of file StFmsCollection.h.

StSPtrVecFmsPoint StFmsCollection::mPoints

private

Owns all FMS points (photons)

Definition at line 70 of file StFmsCollection.h.

---

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

• /Users/thomasburton/Documents/projects/StFms/StRoot/StEvent/StFmsCollection.h
• /Users/thomasburton/Documents/projects/StFms/StRoot/StEvent/StFmsCollection.cxx