Belle II Software development
KLMScintillatorFirmware Class Reference

KLM scintillator firmware. More...

#include <KLMScintillatorFirmware.h>

Inheritance diagram for KLMScintillatorFirmware:

Public Types

enum  FirmwareVersion : unsigned int {
  c_Invalid = 0 ,
  c_Phase2 = 1 ,
  c_Run1 = 2 ,
  c_Run2 = 3
}
 Enumerator for the scintillator firmware version. More...
 

Public Member Functions

 KLMScintillatorFirmware ()=default
 Constructor.
 
 KLMScintillatorFirmware (FirmwareVersion firmwareVersion)
 Specialized constructor.
 
 ~KLMScintillatorFirmware ()=default
 Destructor.
 
void setFirmwareVersion (FirmwareVersion firmwareVersion)
 Set firmware version.
 
FirmwareVersion getFirmwareVersion () const
 Get firmware version.
 

Private Member Functions

 ClassDef (KLMScintillatorFirmware, 1)
 Class version.
 

Private Attributes

FirmwareVersion m_FirmwareVersion {c_Invalid}
 KLM scintillator firmware version.
 

Detailed Description

KLM scintillator firmware.

Definition at line 23 of file KLMScintillatorFirmware.h.

Member Enumeration Documentation

◆ FirmwareVersion

enum FirmwareVersion : unsigned int

Enumerator for the scintillator firmware version.

Enumerator
c_Invalid 

Flag for marking an invalid version.

Useful for identifying wrong payloads.

c_Phase2 

Flag for Phase 2 version.

Kept for legacy.

c_Run1 

Flag for Run 1 (from 2019a to 2022b)

c_Run2 

Flag for Run 1 (from 2023c).

Definition at line 30 of file KLMScintillatorFirmware.h.

30 : unsigned int {
31
33 c_Invalid = 0,
34
36 c_Phase2 = 1,
37
39 c_Run1 = 2,
40
42 c_Run2 = 3,
43
44 };
@ c_Run2
Flag for Run 1 (from 2023c).
@ c_Invalid
Flag for marking an invalid version.
@ c_Run1
Flag for Run 1 (from 2019a to 2022b)
@ c_Phase2
Flag for Phase 2 version.

Constructor & Destructor Documentation

◆ KLMScintillatorFirmware()

KLMScintillatorFirmware ( FirmwareVersion  firmwareVersion)
inlineexplicit

Specialized constructor.

Definition at line 54 of file KLMScintillatorFirmware.h.

54 :
55 m_FirmwareVersion{firmwareVersion}
56 {
57 };
FirmwareVersion m_FirmwareVersion
KLM scintillator firmware version.

Member Function Documentation

◆ getFirmwareVersion()

FirmwareVersion getFirmwareVersion ( ) const
inline

Get firmware version.

Definition at line 75 of file KLMScintillatorFirmware.h.

76 {
77 return m_FirmwareVersion;
78 };

◆ setFirmwareVersion()

void setFirmwareVersion ( FirmwareVersion  firmwareVersion)
inline

Set firmware version.

Definition at line 67 of file KLMScintillatorFirmware.h.

68 {
69 m_FirmwareVersion = firmwareVersion;
70 };

Member Data Documentation

◆ m_FirmwareVersion

FirmwareVersion m_FirmwareVersion {c_Invalid}
private

KLM scintillator firmware version.

Definition at line 83 of file KLMScintillatorFirmware.h.


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