Belle II Software development
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
BunchStructure Class Reference
Packages » framework

Class to store the fill pattern of colliding bunches. More...

#include <BunchStructure.h>

Inheritance diagram for BunchStructure:

Public Member Functions

 BunchStructure ()
 Default constructor.
 
void setBucket (unsigned i)
 Sets the fill status of RF bucket to true.
 
unsigned getRFBucketsPerRevolution () const
 Returns the number of RF buckets per beam revolution.
 
const std::vector< bool > & getFillPattern () const
 Returns fill pattern.
 
bool getBucket (int i) const
 Returns the fill status of RF bucket.
 
bool isSet () const
 Checks if the fill pattern is really set.
 
unsigned getNumOfFilledBuckets () const
 Returns the number of filled buckets.
 
unsigned generateBucketNumber () const
 Generates RF bucket number according to the fill pattern.
 

Private Types

enum  { c_RFBuckets = 5120 }
 Number of RF buckets per beam revolution. More...
 

Private Member Functions

 ClassDef (BunchStructure, 1)
 dont't write out
 

Private Attributes

std::vector< bool > m_fillPattern
 fill pattern, true means the bucket is filled
 
std::vector< unsigned > m_filledBuckets
 cache for the filled bucket numbers
 

Detailed Description

Class to store the fill pattern of colliding bunches.

Default: if setBucket is not called, works as every second bucket is filled (even bucket numbers).

Definition at line 26 of file BunchStructure.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private

Number of RF buckets per beam revolution.

Definition at line 85 of file BunchStructure.h.

85{c_RFBuckets = 5120};

Constructor & Destructor Documentation

◆ BunchStructure()

BunchStructure ( )
inline

Default constructor.

Definition at line 33 of file BunchStructure.h.

34 {}

Member Function Documentation

◆ ClassDef()

ClassDef ( BunchStructure  ,
1   
)
private

dont't write out

ClassDef

◆ getFillPattern()

const std::vector< bool > & getFillPattern ( ) const
inline

Returns fill pattern.

Returns
fill pattern

Definition at line 52 of file BunchStructure.h.

52{return m_fillPattern;}
Belle2::BunchStructure::m_fillPattern
std::vector< bool > m_fillPattern
fill pattern, true means the bucket is filled
Definition: BunchStructure.h:87

◆ getRFBucketsPerRevolution()

unsigned getRFBucketsPerRevolution ( ) const
inline

Returns the number of RF buckets per beam revolution.

Returns
the number of RF buckets per beam revolution

Definition at line 46 of file BunchStructure.h.

46{return c_RFBuckets;}

◆ isSet()

bool isSet ( ) const
inline

Checks if the fill pattern is really set.

Returns
true, if the fill pattern is set

Definition at line 65 of file BunchStructure.h.

65{return (not m_fillPattern.empty());}

Member Data Documentation

◆ m_filledBuckets

std::vector<unsigned> m_filledBuckets
mutableprivate

cache for the filled bucket numbers

Definition at line 90 of file BunchStructure.h.

◆ m_fillPattern

std::vector<bool> m_fillPattern
private

fill pattern, true means the bucket is filled

Definition at line 87 of file BunchStructure.h.

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