BmnRoot
Loading...
Searching...
No Matches
Public Member Functions | List of all members
BmnCluster Class Reference

Base class for cluster objects. More...

#include <BmnCluster.h>

Inheritance diagram for BmnCluster:
[legend]
Collaboration diagram for BmnCluster:
[legend]

Public Member Functions

 BmnCluster ()
 Constructor.
 
 BmnCluster (const std::vector< Int_t > &indices, Int_t address)
 
virtual ~BmnCluster ()
 Destructor.
 
void AddDigi (Int_t index)
 Add digi to cluster.
 
void AddDigis (const std::vector< Int_t > &indices)
 Add array of digi to cluster.
 
void SetDigis (const std::vector< Int_t > &indices)
 Set array of digi to cluster. Overwrites existing array.
 
Int_t GetNofDigis () const
 Number of digis in cluster.
 
Int_t GetDigi (Int_t index) const
 Get digi at position index.
 
const std::vector< Int_t > & GetDigis () const
 Get array of digi indices.
 
void ClearDigis ()
 Remove all digis.
 
Int_t GetAddress () const
 
BmnMatch * GetMatch () const
 
void SetAddress (Int_t address)
 
void SetMatch (BmnMatch *match)
 
virtual std::string ToString () const
 Return string representation of the object.
 

Detailed Description

Base class for cluster objects.

Date
07.12.2018

Definition at line 21 of file BmnCluster.h.

Constructor & Destructor Documentation

◆ BmnCluster() [1/2]

BmnCluster::BmnCluster ( )

Constructor.

Definition at line 16 of file BmnCluster.cxx.

◆ BmnCluster() [2/2]

BmnCluster::BmnCluster ( const std::vector< Int_t > &  indices,
Int_t  address 
)

Definition at line 24 of file BmnCluster.cxx.

◆ ~BmnCluster()

BmnCluster::~BmnCluster ( )
virtual

Destructor.

Definition at line 33 of file BmnCluster.cxx.

Member Function Documentation

◆ AddDigi()

void BmnCluster::AddDigi ( Int_t  index)
inline

Add digi to cluster.

Parameters
[in]indexDigi index in TClonesArray.

Definition at line 38 of file BmnCluster.h.

◆ AddDigis()

void BmnCluster::AddDigis ( const std::vector< Int_t > &  indices)
inline

Add array of digi to cluster.

Parameters
[in]indicesArray of digi indices in TClonesArray.

Definition at line 44 of file BmnCluster.h.

◆ ClearDigis()

void BmnCluster::ClearDigis ( )
inline

Remove all digis.

Definition at line 74 of file BmnCluster.h.

◆ GetAddress()

Int_t BmnCluster::GetAddress ( ) const
inline

Accessors

Definition at line 77 of file BmnCluster.h.

Referenced by BmnSsdCluster::ToString().

◆ GetDigi()

Int_t BmnCluster::GetDigi ( Int_t  index) const
inline

Get digi at position index.

Parameters
[in]indexPosition of digi in array.
Returns
Digi index in TClonesArray.

Definition at line 63 of file BmnCluster.h.

◆ GetDigis()

const std::vector< Int_t > & BmnCluster::GetDigis ( ) const
inline

Get array of digi indices.

Returns
Array of digi indices in TClonesArray.

Definition at line 69 of file BmnCluster.h.

◆ GetMatch()

BmnMatch * BmnCluster::GetMatch ( ) const
inline

Definition at line 78 of file BmnCluster.h.

◆ GetNofDigis()

Int_t BmnCluster::GetNofDigis ( ) const
inline

Number of digis in cluster.

Returns
Number of digis in cluster.

Definition at line 56 of file BmnCluster.h.

Referenced by ToString(), and BmnSsdCluster::ToString().

◆ SetAddress()

void BmnCluster::SetAddress ( Int_t  address)
inline

Modifiers

Definition at line 81 of file BmnCluster.h.

◆ SetDigis()

void BmnCluster::SetDigis ( const std::vector< Int_t > &  indices)
inline

Set array of digi to cluster. Overwrites existing array.

Parameters
[in]indicesArray of digi indices in TClonesArray.

Definition at line 50 of file BmnCluster.h.

◆ SetMatch()

void BmnCluster::SetMatch ( BmnMatch *  match)

Definition at line 38 of file BmnCluster.cxx.

◆ ToString()

string BmnCluster::ToString ( ) const
virtual

Return string representation of the object.

Returns
String representation of the object.

Reimplemented in BmnSsdCluster.

Definition at line 44 of file BmnCluster.cxx.

References GetNofDigis(), and i.

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