GRSISort "v4.0.0.5"
An extension of the ROOT analysis Framework
Loading...
Searching...
No Matches
TEventBuildingLoop Class Reference

Detailed Description

This loop builds events (vectors of fragments) based on timestamps and a build windows.

Definition at line 27 of file TEventBuildingLoop.h.

Public Types

enum class  EBuildMode {
  kDefault , kTime , kTimestamp , kTriggerId ,
  kSkip
}
 

Public Member Functions

 TEventBuildingLoop (const TEventBuildingLoop &)=delete
 
 TEventBuildingLoop (TEventBuildingLoop &&) noexcept=delete
 
 ~TEventBuildingLoop ()
 
void ClearQueue () override
 
std::string EndStatus () override
 
uint64_t GetBuildWindow () const
 
size_t GetItemsCurrent () override
 
size_t GetItemsPopped () override
 
size_t GetItemsPushed () override
 
size_t GetRate () override
 
unsigned int GetSortDepth () const
 
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< const TFragment > > > & InputQueue ()
 
bool IsPaused ()
 
bool IsRunning ()
 
bool Iteration () override
 
void Join ()
 
std::string Name () const
 
virtual void OnEnd ()
 
TEventBuildingLoopoperator= (const TEventBuildingLoop &)=delete
 
TEventBuildingLoopoperator= (TEventBuildingLoop &&) noexcept=delete
 
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< const TFragment > > > & OutOfOrderQueue ()
 
std::shared_ptr< ThreadsafeQueue< std::vector< std::shared_ptr< const TFragment > > > > & OutputQueue ()
 
void Pause ()
 
virtual std::string Progress ()
 
void Resume ()
 
void SetBuildWindow (uint64_t val)
 
void SetSortDepth (unsigned int val)
 
virtual std::string Status ()
 
void Stop ()
 

Static Public Member Functions

static std::string AllThreadHeader ()
 
static std::string AllThreadProgress ()
 
static std::string AllThreadStatus ()
 
static bool AnyThreadRunning ()
 
static std::string AnyThreadStatus ()
 
static void ClearAllQueues ()
 
static size_t ColumnWidth ()
 
static void ColumnWidth (size_t val)
 
static StoppableThreadGet (const std::string &name)
 
static TEventBuildingLoopGet (std::string name="", EBuildMode mode=EBuildMode::kTimestamp, uint64_t buildWindow=2000)
 
static std::vector< StoppableThread * > GetAll ()
 
static int GetNThreads ()
 
static void join_status_thread ()
 
static void PauseAll ()
 
static void Print ()
 
static void ResumeAll ()
 
static void SendStop ()
 
static void start_status_thread ()
 
static void status_out ()
 
static void status_out_loop ()
 
static size_t StatusWidth ()
 
static void StatusWidth (size_t val)
 
static void stop_status_thread ()
 
static void StopAll ()
 

Protected Member Functions

void IncrementItemsPopped ()
 
std::atomic_long & InputSize ()
 
void InputSize (int64_t val)
 
std::atomic_size_t & ItemsPopped ()
 
void ItemsPopped (size_t val)
 

Private Member Functions

 TEventBuildingLoop (std::string name, EBuildMode mode, uint64_t buildWindow)
 
bool CheckBuildCondition (const std::shared_ptr< const TFragment > &)
 
bool CheckTimeCondition (const std::shared_ptr< const TFragment > &)
 
bool CheckTimestampCondition (const std::shared_ptr< const TFragment > &)
 
bool CheckTriggerIdCondition (const std::shared_ptr< const TFragment > &)
 
void Loop ()
 

Private Attributes

EBuildMode fBuildMode
 
uint64_t fBuildWindow
 
std::atomic_bool fForceStop {false}
 
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< const TFragment > > > fInputQueue
 
std::atomic_long fInputSize {0}
 
std::atomic_size_t fItemsPopped {0}
 
std::string fName
 
std::vector< std::shared_ptr< const TFragment > > fNextEvent
 
std::multiset< std::shared_ptr< const TFragment >, std::function< bool(std::shared_ptr< const TFragment >, std::shared_ptr< const TFragment >)> > fOrdered
 
std::shared_ptr< ThreadsafeQueue< std::shared_ptr< const TFragment > > > fOutOfOrderQueue
 
std::shared_ptr< ThreadsafeQueue< std::vector< std::shared_ptr< const TFragment > > > > fOutputQueue
 
std::atomic_bool fPaused {false}
 
std::condition_variable fPausedWait
 
std::mutex fPauseMutex
 
bool fPreviousSortingDepthError
 
std::atomic_bool fRunning {false}
 
bool fSkipInputSort
 
unsigned int fSortingDepth
 
std::thread fThread
 

Static Private Attributes

static size_t fColumnWidth = 20
 
static std::thread fStatusThread
 
static bool fStatusThreadOn = false
 
static size_t fStatusWidth = 80
 
static std::map< std::string, StoppableThread * > fThreadMap
 
+ Inheritance diagram for TEventBuildingLoop:
+ Collaboration diagram for TEventBuildingLoop:

Member Enumeration Documentation

◆ EBuildMode

enum class TEventBuildingLoop::EBuildMode
strong
Enumerator
kDefault 
kTime 
kTimestamp 
kTriggerId 
kSkip 

Definition at line 29 of file TEventBuildingLoop.h.

Constructor & Destructor Documentation

◆ TEventBuildingLoop() [1/3]

TEventBuildingLoop::TEventBuildingLoop ( const TEventBuildingLoop & )
delete

Referenced by Get().

◆ TEventBuildingLoop() [2/3]

TEventBuildingLoop::TEventBuildingLoop ( TEventBuildingLoop && )
deletenoexcept

◆ ~TEventBuildingLoop()

TEventBuildingLoop::~TEventBuildingLoop ( )
default

◆ TEventBuildingLoop() [3/3]

TEventBuildingLoop::TEventBuildingLoop ( std::string name,
EBuildMode mode,
uint64_t buildWindow )
private

Member Function Documentation

◆ AllThreadHeader()

std::string StoppableThread::AllThreadHeader ( )
staticinherited

◆ AllThreadProgress()

std::string StoppableThread::AllThreadProgress ( )
staticinherited

◆ AllThreadStatus()

std::string StoppableThread::AllThreadStatus ( )
staticinherited

◆ AnyThreadRunning()

bool StoppableThread::AnyThreadRunning ( )
staticinherited

◆ AnyThreadStatus()

std::string StoppableThread::AnyThreadStatus ( )
staticinherited

Definition at line 47 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

◆ CheckBuildCondition()

bool TEventBuildingLoop::CheckBuildCondition ( const std::shared_ptr< const TFragment > & frag)
private

◆ CheckTimeCondition()

◆ CheckTimestampCondition()

◆ CheckTriggerIdCondition()

◆ ClearAllQueues()

void StoppableThread::ClearAllQueues ( )
staticinherited

Definition at line 166 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by TGRSIInterruptHandler::Notify().

◆ ClearQueue()

void TEventBuildingLoop::ClearQueue ( )
overridevirtual

Reimplemented from StoppableThread.

Definition at line 64 of file TEventBuildingLoop.cxx.

References fInputQueue, and fOutputQueue.

◆ ColumnWidth() [1/2]

static size_t StoppableThread::ColumnWidth ( )
inlinestaticinherited

Definition at line 82 of file StoppableThread.h.

References StoppableThread::fColumnWidth.

Referenced by TGRSIint::SetupPipeline().

◆ ColumnWidth() [2/2]

static void StoppableThread::ColumnWidth ( size_t val)
inlinestaticinherited

Definition at line 80 of file StoppableThread.h.

References StoppableThread::fColumnWidth.

◆ EndStatus()

std::string TEventBuildingLoop::EndStatus ( )
overridevirtual

Reimplemented from StoppableThread.

Definition at line 256 of file TEventBuildingLoop.cxx.

References fInputQueue, and StoppableThread::ItemsPopped().

◆ Get() [1/2]

◆ Get() [2/2]

TEventBuildingLoop * TEventBuildingLoop::Get ( std::string name = "",
EBuildMode mode = EBuildMode::kTimestamp,
uint64_t buildWindow = 2000 )
static

Definition at line 9 of file TEventBuildingLoop.cxx.

References TEventBuildingLoop(), and StoppableThread::Get().

Referenced by TGRSIint::SetupPipeline().

◆ GetAll()

std::vector< StoppableThread * > StoppableThread::GetAll ( )
staticinherited

Definition at line 315 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

◆ GetBuildWindow()

uint64_t TEventBuildingLoop::GetBuildWindow ( ) const
inline

Definition at line 64 of file TEventBuildingLoop.h.

References fBuildWindow.

◆ GetItemsCurrent()

size_t TEventBuildingLoop::GetItemsCurrent ( )
inlineoverridevirtual

Implements StoppableThread.

Definition at line 60 of file TEventBuildingLoop.h.

References fOutputQueue.

◆ GetItemsPopped()

size_t TEventBuildingLoop::GetItemsPopped ( )
inlineoverridevirtual

Implements StoppableThread.

Definition at line 59 of file TEventBuildingLoop.h.

References fOutputQueue.

◆ GetItemsPushed()

size_t TEventBuildingLoop::GetItemsPushed ( )
inlineoverridevirtual

Implements StoppableThread.

Definition at line 58 of file TEventBuildingLoop.h.

References fOutputQueue.

◆ GetNThreads()

int StoppableThread::GetNThreads ( )
staticinherited

Definition at line 21 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by StoppableThread::Print().

◆ GetRate()

size_t TEventBuildingLoop::GetRate ( )
inlineoverridevirtual

Implements StoppableThread.

Definition at line 61 of file TEventBuildingLoop.h.

◆ GetSortDepth()

unsigned int TEventBuildingLoop::GetSortDepth ( ) const
inline

Definition at line 67 of file TEventBuildingLoop.h.

References fSortingDepth.

◆ IncrementItemsPopped()

◆ InputQueue()

std::shared_ptr< ThreadsafeQueue< std::shared_ptr< const TFragment > > > & TEventBuildingLoop::InputQueue ( )
inline

Definition at line 43 of file TEventBuildingLoop.h.

References fInputQueue.

Referenced by TGRSIint::SetupPipeline().

◆ InputSize() [1/2]

◆ InputSize() [2/2]

void StoppableThread::InputSize ( int64_t val)
inlineprotectedinherited

Definition at line 94 of file StoppableThread.h.

References StoppableThread::fInputSize.

◆ IsPaused()

bool StoppableThread::IsPaused ( )
inherited

Definition at line 224 of file StoppableThread.cxx.

References StoppableThread::fPaused.

◆ IsRunning()

bool StoppableThread::IsRunning ( )
inherited

Definition at line 219 of file StoppableThread.cxx.

References StoppableThread::fRunning.

Referenced by StoppableThread::status_out().

◆ ItemsPopped() [1/2]

◆ ItemsPopped() [2/2]

void StoppableThread::ItemsPopped ( size_t val)
inlineprotectedinherited

Definition at line 93 of file StoppableThread.h.

References StoppableThread::fItemsPopped.

◆ Iteration()

bool TEventBuildingLoop::Iteration ( )
overridevirtual

◆ Join()

void StoppableThread::Join ( )
inherited

◆ join_status_thread()

void StoppableThread::join_status_thread ( )
staticinherited

◆ Loop()

◆ Name()

std::string StoppableThread::Name ( ) const
inlineinherited

◆ OnEnd()

virtual void StoppableThread::OnEnd ( )
inlinevirtualinherited

Reimplemented in TAnalysisWriteLoop, TDataLoop, and TFragmentChainLoop.

Definition at line 59 of file StoppableThread.h.

Referenced by StoppableThread::Loop().

◆ operator=() [1/2]

TEventBuildingLoop & TEventBuildingLoop::operator= ( const TEventBuildingLoop & )
delete

◆ operator=() [2/2]

TEventBuildingLoop & TEventBuildingLoop::operator= ( TEventBuildingLoop && )
deletenoexcept

◆ OutOfOrderQueue()

std::shared_ptr< ThreadsafeQueue< std::shared_ptr< const TFragment > > > & TEventBuildingLoop::OutOfOrderQueue ( )
inline

Definition at line 51 of file TEventBuildingLoop.h.

References fOutOfOrderQueue.

Referenced by TGRSIint::SetupPipeline().

◆ OutputQueue()

std::shared_ptr< ThreadsafeQueue< std::vector< std::shared_ptr< const TFragment > > > > & TEventBuildingLoop::OutputQueue ( )
inline

Definition at line 47 of file TEventBuildingLoop.h.

References fOutputQueue.

Referenced by TGRSIint::SetupPipeline().

◆ Pause()

void StoppableThread::Pause ( )
inherited

Definition at line 202 of file StoppableThread.cxx.

References StoppableThread::fPaused, and StoppableThread::fRunning.

◆ PauseAll()

void StoppableThread::PauseAll ( )
staticinherited

Definition at line 97 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

◆ Print()

void StoppableThread::Print ( )
staticinherited

◆ Progress()

std::string StoppableThread::Progress ( )
virtualinherited

◆ Resume()

void StoppableThread::Resume ( )
inherited

◆ ResumeAll()

void StoppableThread::ResumeAll ( )
staticinherited

Definition at line 104 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by TGRSIint::SetupPipeline().

◆ SendStop()

void StoppableThread::SendStop ( )
staticinherited

Definition at line 135 of file StoppableThread.cxx.

References StoppableThread::fThreadMap.

Referenced by StoppableThread::StopAll(), and TGRSIint::Terminate().

◆ SetBuildWindow()

void TEventBuildingLoop::SetBuildWindow ( uint64_t val)
inline

Definition at line 63 of file TEventBuildingLoop.h.

References fBuildWindow.

◆ SetSortDepth()

void TEventBuildingLoop::SetSortDepth ( unsigned int val)
inline

Definition at line 66 of file TEventBuildingLoop.h.

References fSortingDepth.

Referenced by TGRSIint::SetupPipeline().

◆ start_status_thread()

void StoppableThread::start_status_thread ( )
staticinherited

◆ Status()

std::string StoppableThread::Status ( )
virtualinherited

◆ status_out()

◆ status_out_loop()

void StoppableThread::status_out_loop ( )
staticinherited

◆ StatusWidth() [1/2]

static size_t StoppableThread::StatusWidth ( )
inlinestaticinherited

Definition at line 83 of file StoppableThread.h.

References StoppableThread::fStatusWidth.

Referenced by TGRSIint::SetupPipeline().

◆ StatusWidth() [2/2]

static void StoppableThread::StatusWidth ( size_t val)
inlinestaticinherited

Definition at line 81 of file StoppableThread.h.

References StoppableThread::fStatusWidth.

◆ Stop()

◆ stop_status_thread()

void StoppableThread::stop_status_thread ( )
staticinherited

◆ StopAll()

void StoppableThread::StopAll ( )
staticinherited

Member Data Documentation

◆ fBuildMode

EBuildMode TEventBuildingLoop::fBuildMode
private

Definition at line 85 of file TEventBuildingLoop.h.

Referenced by TEventBuildingLoop(), and CheckBuildCondition().

◆ fBuildWindow

uint64_t TEventBuildingLoop::fBuildWindow
private

◆ fColumnWidth

◆ fForceStop

std::atomic_bool StoppableThread::fForceStop {false}
privateinherited

Definition at line 120 of file StoppableThread.h.

◆ fInputQueue

std::shared_ptr<ThreadsafeQueue<std::shared_ptr<const TFragment> > > TEventBuildingLoop::fInputQueue
private

Definition at line 80 of file TEventBuildingLoop.h.

Referenced by ClearQueue(), EndStatus(), InputQueue(), and Iteration().

◆ fInputSize

std::atomic_long StoppableThread::fInputSize {0}
privateinherited

number of items in the input (queue), only updated within Iteration(), so not always fully up-to-date (signed to hold error from queue::pop)

Definition at line 102 of file StoppableThread.h.

Referenced by StoppableThread::InputSize(), StoppableThread::InputSize(), StoppableThread::Progress(), and StoppableThread::Status().

◆ fItemsPopped

std::atomic_size_t StoppableThread::fItemsPopped {0}
privateinherited

◆ fName

std::string StoppableThread::fName
privateinherited

◆ fNextEvent

std::vector<std::shared_ptr<const TFragment> > TEventBuildingLoop::fNextEvent
private

◆ fOrdered

std::multiset<std::shared_ptr<const TFragment>, std::function<bool(std::shared_ptr<const TFragment>, std::shared_ptr<const TFragment>)> > TEventBuildingLoop::fOrdered
private

Definition at line 96 of file TEventBuildingLoop.h.

Referenced by TEventBuildingLoop(), and Iteration().

◆ fOutOfOrderQueue

std::shared_ptr<ThreadsafeQueue<std::shared_ptr<const TFragment> > > TEventBuildingLoop::fOutOfOrderQueue
private

◆ fOutputQueue

std::shared_ptr<ThreadsafeQueue<std::vector<std::shared_ptr<const TFragment> > > > TEventBuildingLoop::fOutputQueue
private

◆ fPaused

std::atomic_bool StoppableThread::fPaused {false}
privateinherited

◆ fPausedWait

std::condition_variable StoppableThread::fPausedWait
privateinherited

◆ fPauseMutex

std::mutex StoppableThread::fPauseMutex
privateinherited

◆ fPreviousSortingDepthError

bool TEventBuildingLoop::fPreviousSortingDepthError
private

◆ fRunning

std::atomic_bool StoppableThread::fRunning {false}
privateinherited

◆ fSkipInputSort

bool TEventBuildingLoop::fSkipInputSort
private

Definition at line 89 of file TEventBuildingLoop.h.

Referenced by TEventBuildingLoop(), and Iteration().

◆ fSortingDepth

unsigned int TEventBuildingLoop::fSortingDepth
private

◆ fStatusThread

std::thread StoppableThread::fStatusThread
staticprivateinherited

◆ fStatusThreadOn

◆ fStatusWidth

◆ fThread

std::thread StoppableThread::fThread
privateinherited

Definition at line 118 of file StoppableThread.h.

Referenced by StoppableThread::StoppableThread(), and StoppableThread::Join().

◆ fThreadMap