A static class to control supported input modules. More...

#include <InputController.h>

Static Public Member Functions
static bool	canControlInput ()
	Is there an input module to be controlled.

static void	setCanControlInput (bool on)
	Call this function from supported input modules.

static bool	getEventMerging ()
	Get if we are merging events from two paths.

static void	enableEventMerging (Module *steerRootInputModule)
	Set that we are merging events from two paths.

static void	setNextEntry (long entry, bool independentPath=false)
	Set the file entry to be loaded the next time event() is called.

static long	getNextEntry (bool independentPath=false)
	Return entry number set via setNextEntry().

static void	setNextEntry (long exp, long run, long event)
	Set the file entry to be loaded the next time event() is called, by evt/run/exp number.

static void	setSkippedEntries (long entries, bool independentPath=false)
	set the number of entries skipped by the RootInputModule.

static long	getNextExperiment ()
	Return experiment number set via setNextEntry().

static long	getNextRun ()
	Return run number set via setNextEntry().

static long	getNextEvent ()
	Return event number set via setNextEntry().

static long	getCurrentEntry (bool independentPath=false)
	returns the entry number currently loaded.

static long	getSkippedEntries (bool independentPath=false)
	returns the number of entries skipped by the RootInputModule.

static long	numEntries (bool independentPath=false)
	Returns total number of entries in the event tree.

static std::string	getCurrentFileName (bool independentPath=false)
	Return name of current file in loaded chain (or empty string if none loaded).

static void	eventLoaded (long entry, bool independentPath=false)
	Indicate that an event (in the given entry) was loaded and reset all members related to the next entry.

static void	setChain (const TChain *chain, bool independentPath=false)
	Set the loaded TChain (event durability).

static void	resetForChildProcess ()
	Reset InputController (e.g.

static long	getNumEntriesToProcess ()
	Necessary to make sure the ProgressModule shows reasonable output.

Static Private Attributes
static bool	s_canControlInput = false
	Is there an input module to be controlled?

static bool	s_doEventMerging = false
	Are we merging events from two paths?

static Module *	s_steerRootInputModule = nullptr
	Explicit pointer to steerRootInput.

static std::pair< long, long >	s_nextEntry = { -1, -1}
	entry to be loaded the next time event() is called in an input module.

static long	s_nextExperiment = -1
	Experiment number to load next.

static long	s_nextRun = -1
	Run number to load next.

static long	s_nextEvent = -1
	Event (not entry!) to load next.

static std::pair< long, long >	s_eventNumbers
	number of events in paths if two input modules are used (independent paths)

static std::pair< long, long >	s_currentEntry = { 0, 0}
	current entry in file.

static std::pair< long, long >	s_skippedEntries = { 0, 0}
	entries skipped by RootInputModule (if any) Storing two values (second one if independent path is executed)

static std::pair< const TChain , const TChain >	s_chain = { nullptr, nullptr}
	Opened TChain (event durability).

Detailed Description

A static class to control supported input modules.

You can use setNextEntry() to request loading of any event in 0..numEntries()-1, which will be done the next time the input module's event() function is called.

Use canControlInput() to check wether control is actually possible.

Definition at line 30 of file InputController.h.

Constructor & Destructor Documentation

◆ InputController()

InputController ( )

inlineprivate

Definition at line 101 of file InputController.h.

101{ }

◆ ~InputController()

~InputController ( )

inlineprivate

Definition at line 102 of file InputController.h.

102{ }

Member Function Documentation

◆ canControlInput()

static bool canControlInput ( )

inlinestatic

Is there an input module to be controlled.

Definition at line 33 of file InputController.h.

33{ return s_canControlInput; }

Belle2::InputController::s_canControlInput

static bool s_canControlInput

Is there an input module to be controlled?

Definition: InputController.h:105

◆ enableEventMerging()

void enableEventMerging ( Module * steerRootInputModule )

static

Set that we are merging events from two paths.

Definition at line 27 of file InputController.cc.

{
  if (s_doEventMerging) {
    B2FATAL("Event merging is already enabled, can not merge twice in the same job, aborting");
  };
  s_doEventMerging = true;
  s_steerRootInputModule = steerRootInputModule;
}

◆ eventLoaded()

void eventLoaded	(	long	entry,
		bool	independentPath = `false`
	)

static

Indicate that an event (in the given entry) was loaded and reset all members related to the next entry.

Definition at line 46 of file InputController.cc.

{
  if (!independentPath) s_nextEntry.first = -1;
  else s_nextEntry.second = -1;
  s_nextExperiment = -1;
  s_nextRun = -1;
  s_nextEvent = -1;
  if (!independentPath) s_currentEntry.first = entry;
  else s_currentEntry.second = entry;
}

◆ getCurrentEntry()

static long getCurrentEntry ( bool independentPath = false )

inlinestatic

returns the entry number currently loaded.

Definition at line 74 of file InputController.h.

74{ return (!independentPath) ? s_currentEntry.first : s_currentEntry.second; }

◆ getCurrentFileName()

std::string getCurrentFileName ( bool independentPath = false )

static

Return name of current file in loaded chain (or empty string if none loaded).

Definition at line 68 of file InputController.cc.

{
  const TChain* chain = !independentPath ? s_chain.first : s_chain.second;
  if (!chain)
    return "";
 
  const TFile* f = chain->GetFile();
  if (!f)
    return "";
 
  return f->GetName();
}

◆ getEventMerging()

static bool getEventMerging ( )

inlinestatic

Get if we are merging events from two paths.

Definition at line 39 of file InputController.h.

39{ return s_doEventMerging; }

◆ getNextEntry()

static long getNextEntry ( bool independentPath = false )

inlinestatic

Return entry number set via setNextEntry().

Definition at line 53 of file InputController.h.

53{ return (!independentPath) ? s_nextEntry.first : s_nextEntry.second;};

◆ getNextEvent()

static long getNextEvent ( )

inlinestatic

Return event number set via setNextEntry().

Definition at line 71 of file InputController.h.

71{ return s_nextEvent; }

◆ getNextExperiment()

static long getNextExperiment ( )

inlinestatic

Return experiment number set via setNextEntry().

Definition at line 65 of file InputController.h.

65{ return s_nextExperiment; }

◆ getNextRun()

static long getNextRun ( )

inlinestatic

Return run number set via setNextEntry().

Definition at line 68 of file InputController.h.

68{ return s_nextRun; }

◆ getNumEntriesToProcess()

long getNumEntriesToProcess ( )

static

Necessary to make sure the ProgressModule shows reasonable output.

Definition at line 94 of file InputController.cc.

{
  if (!s_doEventMerging) {
    return numEntries();
  } else {
    return numEntries(true) * numEntries(false);
  }
}

◆ getSkippedEntries()

static long getSkippedEntries ( bool independentPath = false )

inlinestatic

returns the number of entries skipped by the RootInputModule.

Definition at line 77 of file InputController.h.

77{ return (!independentPath) ? s_skippedEntries.first : s_skippedEntries.second; }

Belle2::InputController::s_skippedEntries

static std::pair< long, long > s_skippedEntries

entries skipped by RootInputModule (if any) Storing two values (second one if independent path is exe...

Definition: InputController.h:143

◆ numEntries()

long numEntries ( bool independentPath = false )

static

Returns total number of entries in the event tree.

If no file is opened, zero is returned.

Definition at line 81 of file InputController.cc.

{
  if (!independentPath) {
    if (s_chain.first)
      return s_chain.first->GetEntries();
  } else {
    if (s_chain.second)
      return s_chain.second->GetEntries();
  }
 
  return 0;
}

◆ resetForChildProcess()

void resetForChildProcess ( )

static

Reset InputController (e.g.

after forking a thread)

Definition at line 57 of file InputController.cc.

{
  s_canControlInput = false;
  s_nextEntry = { -1, -1};
  s_nextExperiment = -1;
  s_nextRun = -1;
  s_nextEvent = -1;
  s_currentEntry = { 0, 0};
  //s_chain is not touched, so numEntries() still works
}

◆ setCanControlInput()

static void setCanControlInput ( bool on )

inlinestatic

Call this function from supported input modules.

Definition at line 36 of file InputController.h.

36{ s_canControlInput = on; }

◆ setChain()

void setChain	(	const TChain *	chain,
		bool	independentPath = `false`
	)

static

Set the loaded TChain (event durability).

Definition at line 37 of file InputController.cc.

{
  if (!independentPath) {
    s_chain.first = chain;
  } else {
    s_chain.second = chain;
  }
}

◆ setNextEntry() [1/2]

static void setNextEntry	(	long	entry,
		bool	independentPath = `false`
	)

inlinestatic

Set the file entry to be loaded the next time event() is called.

This is mainly useful for interactive applications (e.g. event display).

The input module should call eventLoaded() after the entry was loaded.

Definition at line 50 of file InputController.h.

50{ (!independentPath) ? s_nextEntry.first = entry : s_nextEntry.second = entry; }

◆ setNextEntry() [2/2]

static void setNextEntry	(	long	exp,
		long	run,
		long	event
	)

inlinestatic

Set the file entry to be loaded the next time event() is called, by evt/run/exp number.

The input module should call eventLoaded() after the entry was loaded.

Definition at line 59 of file InputController.h.

59{ s_nextExperiment = exp; s_nextRun = run; s_nextEvent = event; }

◆ setSkippedEntries()

static void setSkippedEntries	(	long	entries,
		bool	independentPath = `false`
	)

inlinestatic

set the number of entries skipped by the RootInputModule.

Definition at line 62 of file InputController.h.

62{ (!independentPath) ? s_skippedEntries.first = entries : s_skippedEntries.second = entries; }

Member Data Documentation

◆ s_canControlInput

bool s_canControlInput = false

staticprivate

Is there an input module to be controlled?

Definition at line 105 of file InputController.h.

◆ s_chain

std::pair< const TChain *, const TChain * > s_chain = { nullptr, nullptr}

staticprivate

Opened TChain (event durability).

Storing two values (second one if independent path is executed)

Definition at line 148 of file InputController.h.

◆ s_currentEntry

std::pair< long, long > s_currentEntry = { 0, 0}

staticprivate

current entry in file.

Storing two values (second one if independent path is executed)

Definition at line 138 of file InputController.h.

◆ s_doEventMerging

bool s_doEventMerging = false

staticprivate

Are we merging events from two paths?

Definition at line 108 of file InputController.h.

◆ s_eventNumbers

std::pair<long, long> s_eventNumbers

staticprivate

number of events in paths if two input modules are used (independent paths)

Definition at line 133 of file InputController.h.

◆ s_nextEntry

std::pair< long, long > s_nextEntry = { -1, -1}

staticprivate

entry to be loaded the next time event() is called in an input module.

Storing two values (second one if independent path is executed) -1 indicates that execution should continue normally.

Definition at line 118 of file InputController.h.

◆ s_nextEvent

long s_nextEvent = -1

staticprivate

Event (not entry!) to load next.

Definition at line 130 of file InputController.h.

◆ s_nextExperiment

long s_nextExperiment = -1

staticprivate

Experiment number to load next.

-1 by default.

Definition at line 124 of file InputController.h.

◆ s_nextRun

long s_nextRun = -1

staticprivate

Run number to load next.

Definition at line 127 of file InputController.h.

◆ s_skippedEntries

std::pair< long, long > s_skippedEntries = { 0, 0}

staticprivate

entries skipped by RootInputModule (if any) Storing two values (second one if independent path is executed)

Definition at line 143 of file InputController.h.

◆ s_steerRootInputModule

Module * s_steerRootInputModule = nullptr

staticprivate

Explicit pointer to steerRootInput.

Definition at line 111 of file InputController.h.

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

framework/core/include/InputController.h
framework/core/src/InputController.cc

Static Public Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InputController()

◆ ~InputController()

Member Function Documentation

◆ canControlInput()

◆ enableEventMerging()

◆ eventLoaded()

◆ getCurrentEntry()

◆ getCurrentFileName()

◆ getEventMerging()

◆ getNextEntry()

◆ getNextEvent()

◆ getNextExperiment()

◆ getNextRun()

◆ getNumEntriesToProcess()

◆ getSkippedEntries()

◆ numEntries()

◆ resetForChildProcess()

◆ setCanControlInput()

◆ setChain()

◆ setNextEntry() [1/2]

◆ setNextEntry() [2/2]

◆ setSkippedEntries()

Member Data Documentation

◆ s_canControlInput

◆ s_chain

◆ s_currentEntry

◆ s_doEventMerging

◆ s_eventNumbers

◆ s_nextEntry

◆ s_nextEvent

◆ s_nextExperiment

◆ s_nextRun

◆ s_skippedEntries

◆ s_steerRootInputModule