Belle II Software development
Public Member Functions | Protected Attributes | List of all members
CACell Class Reference
Packages » tracking

The CACell class This Class stores all relevant information one wants to have stored in a cell for a Cellular automaton. More...

#include <CACell.h>

Public Member Functions

 CACell ()
 ************************* CONSTRUCTORS *************************
 
bool operator== (const CACell &b) const
 ************************* OPERATORS *************************
 
bool operator!= (const CACell &b) const
 overloaded '!='-operator
 
unsigned int getState () const
 ************************* PUBLIC MEMBER FUNCTIONS *************************
 
bool isSeed () const
 returns whether CACell is allowed to be a seed for TCs
 
bool isActivated () const
 returns activationState (CA-feature)
 
bool isUpgradeAllowed () const
 returns info whether stateIncrease is allowed or not (CA-feature)
 
void increaseState ()
 setters:
 
void setStateUpgrade (bool up)
 sets flag whether CACell is allowed to increase state during update step within CA
 
void setSeed (bool isSeedTrue)
 sets flag whether CACell is allowed to be the seed of a new track candidate or not
 
void setActivationState (bool activationState)
 sets flag whether CACell is active (takes part during current CA iteration) or inactive (does not take part, it is 'dead')
 

Protected Attributes

unsigned int m_state = 0
 ************************* DATA MEMBERS *************************
 
bool m_activated = true
 activation state.
 
bool m_stateUpgrade = false
 sets flag whether Segment is allowed to increase state during update step within CA
 
bool m_seed = false
 sets flag whether Segment is allowed to be the seed of a new track candidate or not
 

Detailed Description

The CACell class This Class stores all relevant information one wants to have stored in a cell for a Cellular automaton.

Definition at line 20 of file CACell.h.

Constructor & Destructor Documentation

◆ CACell()

CACell ( )
inline

************************* CONSTRUCTORS *************************

Default constructor for the ROOT IO.

Definition at line 24 of file CACell.h.

24{}

Member Function Documentation

◆ getState()

unsigned int getState ( ) const
inline

************************* PUBLIC MEMBER FUNCTIONS *************************

getters: returns state of CACell (CA-feature)

Definition at line 40 of file CACell.h.

40{ return m_state; }

◆ increaseState()

void increaseState ( )
inline

setters:

increases state during CA update step

Definition at line 54 of file CACell.h.

54{ m_state++; }

◆ isActivated()

bool isActivated ( ) const
inline

returns activationState (CA-feature)

Definition at line 46 of file CACell.h.

46{ return m_activated; }

◆ isSeed()

bool isSeed ( ) const
inline

returns whether CACell is allowed to be a seed for TCs

Definition at line 43 of file CACell.h.

43{ return m_seed; }

◆ isUpgradeAllowed()

bool isUpgradeAllowed ( ) const
inline

returns info whether stateIncrease is allowed or not (CA-feature)

Definition at line 49 of file CACell.h.

49{ return m_stateUpgrade; }

◆ operator!=()

bool operator!= ( const CACell & b) const
inline

overloaded '!='-operator

Definition at line 33 of file CACell.h.

34 { return (m_state != b.m_state or m_activated != b.m_activated); }

◆ operator==()

bool operator== ( const CACell & b) const
inline

************************* OPERATORS *************************

overloaded '=='-operator

Definition at line 29 of file CACell.h.

30 { return (m_state == b.m_state and m_activated == b.m_activated); }

◆ setActivationState()

void setActivationState ( bool activationState)
inline

sets flag whether CACell is active (takes part during current CA iteration) or inactive (does not take part, it is 'dead')

Definition at line 63 of file CACell.h.

63{ m_activated = activationState; }

◆ setSeed()

void setSeed ( bool isSeedTrue)
inline

sets flag whether CACell is allowed to be the seed of a new track candidate or not

Definition at line 60 of file CACell.h.

60{ m_seed = isSeedTrue; }

◆ setStateUpgrade()

void setStateUpgrade ( bool up)
inline

sets flag whether CACell is allowed to increase state during update step within CA

Definition at line 57 of file CACell.h.

57{ m_stateUpgrade = up; }

Member Data Documentation

◆ m_activated

bool m_activated = true
protected

activation state.

Living CACells (active) are allowed to evolve in the CA, dead ones (inactive) are not allowed

Definition at line 72 of file CACell.h.

◆ m_seed

bool m_seed = false
protected

sets flag whether Segment is allowed to be the seed of a new track candidate or not

Definition at line 78 of file CACell.h.

◆ m_state

unsigned int m_state = 0
protected

************************* DATA MEMBERS *************************

state of CACell during CA process, begins with 0

Definition at line 69 of file CACell.h.

◆ m_stateUpgrade

bool m_stateUpgrade = false
protected

sets flag whether Segment is allowed to increase state during update step within CA

Definition at line 75 of file CACell.h.

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