TRGTOPUnpackerModule Class Reference

TRG TOP Unpacker. More...

#include <trgtopUnpackerModule.h>

Inheritance diagram for TRGTOPUnpackerModule:

Public Types
enum	EModulePropFlags {   c_Input = 1 ,   c_Output = 2 ,   c_ParallelProcessingCertified = 4 ,   c_HistogramManager = 8 ,   c_InternalSerializer = 16 ,   c_TerminateInAllProcesses = 32 ,   c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...
typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	TRGTOPUnpackerModule ()
	Constructor: Sets the description, the properties and the parameters of the module.
virtual void	initialize () override
	Initialize the Module.
virtual void	beginRun () override
	Called when entering a new run.
virtual void	event () override
	This method is the core of the module.
virtual void	endRun () override
	This method is called if the current run ends.
virtual void	terminate () override
	This method is called at the end of the event processing.
std::string	version () const
	returns version of TRGGDLUnpackerModule.
virtual void	readDAQEvent (RawTRG *, int, int)
	Read data from TRG DAQ.
virtual void	unpackT0Decisions (int *, int)
	Unpacker main function.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T>
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Static Public Attributes
static constexpr double	clkTo1ns = 0.5 / 0.508877

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T>
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T>
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Protected Attributes
int	m_eventNumber
	Event number (according to L1/global)
int	m_trigType
	Trigger type.
int	m_nodeId
	Our read-out ID.
int	m_nWords
	N words in raw data.
bool	m_pciedata
	PCIe40 data or copper data.
bool	m_reportedAlreadyRun_1
bool	m_reportedAlreadyRun_2
bool	m_overrideControlBits

Private Member Functions
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
StoreArray< TRGTOPCombinedT0Decision >	m_TRGTOPCombinedT0DecisionArray
StoreArray< TRGTOPSlotTiming >	m_TRGTOPSlotTimingArray
std::string	m_name
	The name of the module, saved as a string (user-modifiable)
std::string	m_type
	The type of the module, saved as a string.
std::string	m_package
	Package this module is found in (may be empty).
std::string	m_description
	The description of the module.
unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with |) of EModulePropFlags.
LogConfig	m_logConfig
	The log system configuration of the module.
ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.
bool	m_hasReturnValue
	True, if the return value is set.
int	m_returnValue
	The return value.
std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Static Private Attributes
static constexpr int	revoToNS = 1280 * 8
	time period of revo strobe in "ns" (assuming the clock of "125MHz")

Detailed Description

TRG TOP Unpacker.

TOP trigger unpacker

Definition at line 38 of file trgtopUnpackerModule.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

TRGTOPUnpackerModule()

TRGTOPUnpackerModule

(

)

Constructor: Sets the description, the properties and the parameters of the module.

Definition at line 37 of file trgtopUnpackerModule.cc.

  : Module::Module(), m_eventNumber(0), m_trigType(0), m_nodeId(0), m_nWords(0), m_reportedAlreadyRun_1(false),
    m_reportedAlreadyRun_2(false)
{
  // Set module properties
 
 
  std::string desc = "TRGTOPUnpackerModule(" + version() + ")";
  setDescription(desc);
  setPropertyFlags(c_ParallelProcessingCertified);
 
  B2DEBUG(20, "TRGTOPUnpacker: Constructor done.");
 
 
  // Parameter definitions
  addParam("overrideControlBits", m_overrideControlBits,
           "Override control bits in data",
           true);
  //           false);
 
}

~TRGTOPUnpackerModule()

~TRGTOPUnpackerModule ( )

overridevirtual

Definition at line 59 of file trgtopUnpackerModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void )

overridevirtual

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 76 of file trgtopUnpackerModule.cc.

{
  m_reportedAlreadyRun_1 = false;
  m_reportedAlreadyRun_2 = false;
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

{ terminate(); }

endRun()

void endRun ( void )

overridevirtual

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 700 of file trgtopUnpackerModule.cc.

{
}

evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( void )

overridevirtual

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 82 of file trgtopUnpackerModule.cc.

{
 
  StoreArray<RawTRG> raw_trgarray;
 
  for (int i = 0; i < raw_trgarray.getEntries(); i++) {
 
    // Check PCIe40 data or Copper data
    if (raw_trgarray[i]->GetMaxNumOfCh(0) == 48) { m_pciedata = true; }
    else if (raw_trgarray[i]->GetMaxNumOfCh(0) == 4) { m_pciedata = false; }
    else { B2FATAL("TRGTOPUnpackerModule: Invalid value of GetMaxNumOfCh from raw data: " << LogVar("Number of ch: ", raw_trgarray[i]->GetMaxNumOfCh(0))); }
 
    int node_id = 0;
    int ch_id_1 = 0;
    int ch_id_2 = 1;
    if (m_pciedata) {
      node_id = 0x10000001;
      ch_id_1 = 23;
      ch_id_2 = 24;
    } else {
      node_id = 0x12000001;
      ch_id_1 = 0;
      ch_id_2 = 1;
    }
 
    for (int j = 0; j < raw_trgarray[i]->GetNumEntries(); j++) {
 
      m_nodeId = raw_trgarray[i]->GetNodeID(j);
 
      if (m_nodeId == node_id) {
 
        int numberOfChannels = raw_trgarray[i]->GetMaxNumOfCh(i);
 
        //  B2INFO("raw_trgarray.GetMaxNumOfCh() = " << numberOfChannels);
 
        for (int channel = 0; channel < numberOfChannels; channel++) {
 
          if (channel != ch_id_1 && channel != ch_id_2) continue;
 
          m_nWords       = raw_trgarray[i]->GetDetectorNwords(j, channel);
 
          //    B2INFO("raw_trgarray[" << i << "]->GetDetectorNwords(" << j << ", " << channel << ") = " << m_nWords);
 
          //        if ( m_nWords > 3 ) {                                         ////general header is 3 words long
          if (m_nWords > 0) {
 
            m_eventNumber  = raw_trgarray[i]->GetEveNo(j);
            m_trigType     = raw_trgarray[i]->GetTRGType(j);
 
            //          B2INFO("raw_trgarray.getEntries() = " << raw_trgarray.getEntries());
            //          B2INFO("raw_trgarray[i]->GetNumEntries() = " << raw_trgarray[i]->GetNumEntries());
            //          B2INFO("raw_trgarray[]->GetEveNo(j) = " << raw_trgarray[i]->GetEveNo(j));
            //          B2INFO("raw_trgarray[]->GetNodeID(j) = " << std::hex << raw_trgarray[i]->GetNodeID(j) << std::dec);
            //          B2INFO("raw_trgarray[]->GetDetectorNwords(j,0) = " << m_nWords);
 
            readDAQEvent(raw_trgarray[i], j, channel);
 
          }
        }
      }
    }
  }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional paths */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 313 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

{return m_description;}

getFileNames()

virtual std::vector< std::string > getFileNames ( bool outputFiles )

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

    {
      return std::vector<std::string>();
    }

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

{ return std::list<ModulePtr>(); }

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 186 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

{return m_package;}

getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 380 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 310 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 377 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

if_false()

void if_false ( const std::shared_ptr< Path > & path, EAfterConditionPath afterConditionPath = EAfterConditionPath::c_End )

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

if_true()

void if_true ( const std::shared_ptr< Path > & path, EAfterConditionPath afterConditionPath = EAfterConditionPath::c_End )

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

if_value()

void if_value ( const std::string & expression, const std::shared_ptr< Path > & path, EAfterConditionPath afterConditionPath = EAfterConditionPath::c_End )

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

initialize()

void initialize ( void )

overridevirtual

Initialize the Module.

This method is called once before the actual event processing starts. Use this method to initialize variables, open files etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 63 of file trgtopUnpackerModule.cc.

{
 
  m_TRGTOPCombinedT0DecisionArray.registerInDataStore();
  //  m_TRGTOPCombinedTimingArray.registerInDataStore();
  m_TRGTOPSlotTimingArray.registerInDataStore();
 
  //  m_TRGTOPCombinedTimingArray.registerRelationTo(m_TRGTOPSlotTimingArray);
  //  m_TRGTOPSlotTimingArray.registerRelationTo(m_TRGTOPCombinedTimingArray);
 
}

readDAQEvent()

void readDAQEvent ( RawTRG * raw_daq, int j, int channel )

virtual

Read data from TRG DAQ.

Definition at line 146 of file trgtopUnpackerModule.cc.

{
  //  if (raw_daq->GetDetectorNwords(j, channel) > 3) {                ///general header is 3 words long
  if (raw_daq->GetDetectorNwords(j, channel) > 0) {
    unpackT0Decisions(raw_daq->GetDetectorBuffer(j, channel), channel);
  }
}

setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int logLevel, unsigned int logInfo )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note

The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

void setParamPython ( const std::string & name, const boost::python::object & pyObj )

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

setParamPythonDict()

void setParamPythonDict ( const boost::python::dict & dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

terminate()

void terminate ( void )

overridevirtual

This method is called at the end of the event processing.

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 704 of file trgtopUnpackerModule.cc.

{
}

unpackT0Decisions()

void unpackT0Decisions ( int * rdat, int channel )

virtual

Unpacker main function.

L1 timestamp (11 bits)

20 LSBs of eventNumberL1 (sequential trigger number)

Definition at line 154 of file trgtopUnpackerModule.cc.

{
 
  //  B2INFO("channel, data size (32bit words) = " << channel << ", " << m_nWords);
 
  // Information for each data window
 
  // rvc from the header of the buffer
  int rvcL1 = rdat[2] & 0x7ff;  
 
  // L1 event number
  int eventNumberL1 = (rdat[2] >> 12) & 0xfffff; 
 
  //  B2INFO("l1_rvc from header = " << rvcL1);
  //  B2INFO("eventNumberL1 (evt) from buffer header = " << eventNumberL1);
 
  bool dataFormatKnown = false;
 
  int windowSize = -1;
  int numberOfWindows = -1;
 
  int dataFormatVersionExpected = -1;
  // cppcheck-suppress variableScope
  int revoClockDeltaExpected = 4;
  // cppcheck-suppress variableScope
  int cntr127DeltaExpected = 4;
 
  // 3 = 3:  header only
  // 1875 = 3 + 48*39: format used starting ~June 30 2019 and until Oct. 1, 2019 (until Receive FW version 0x02067301)
  // 771 = 3 + 24*32: format used starting ~Oct. 1, 2019 (Receive FW version 0x02067301 and newer)
  // 1539 = 3 + 48*32: format used starting ~Mar. 25, 2021 (Receive FW version 0x03020003 and newer)
  // 3075 = 3 + 96*32: format used starting ~Mar. 25, 2021 (Receive FW version 0x03020003 and newer)
 
  //   m_nWords==3 means only a header
  if (m_nWords == 3) {
    windowSize = 0;
    numberOfWindows = 0;
    dataFormatKnown = true;
    dataFormatVersionExpected = 0;
  } else if (m_nWords == 771) {
    windowSize = 32;
    numberOfWindows = 24;
    dataFormatKnown = true;
    dataFormatVersionExpected = 2;
  } else if (m_nWords == 1875) {
    windowSize = 39;
    numberOfWindows = 48;
    dataFormatKnown = true;
    dataFormatVersionExpected = 1;
  } else if (m_nWords == 1539) {
    windowSize = 32;
    numberOfWindows = 48;
    dataFormatKnown = true;
    dataFormatVersionExpected = 4;
  } else if (m_nWords == 3075) {
    windowSize = 32;
    numberOfWindows = 96;
    dataFormatKnown = true;
    dataFormatVersionExpected = 5;
  }
 
  if (!dataFormatKnown) {
    if (!m_reportedAlreadyRun_1) {
      B2INFO("Unknown data format / error / exiting. This condition is reported only once per run.");
      m_reportedAlreadyRun_1 = true;
    }
    return;
  }
 
  // FTSW / rvc / the difference is 1280 (expected)
  //  int revoClockDeltaJump1 = -92;
  //  int revoClockDeltaJump2 = 1188;
 
  // VME / 16bit counter
  //  int cntr127DeltaJump1 = -92;
  //  int cntr127DeltaJump2 = -65532;
 
  //  if ( dataFormatVersionExpected > 0 ) B2INFO("---------------------------------------------------------------------------------------------------------------");
 
  //  B2INFO("Data format version (as expected according to data size) = " << dataFormatVersionExpected);
 
  //  if ( numberOfWindows != 0 ) {
  //    B2INFO("Number of 32bit words in TOP L1 data buffer = " << m_nWords);
  //    B2INFO("Number of windows = " << numberOfWindows);
  //    B2INFO("Window size in 32bit words = " << windowSize);
  //  }
 
  // various test patterns will be used to check the data
  unsigned int testPattern;
 
  int revoClockLast = -1;
  int cntr127Last = -1;
 
  bool performBufferAnalysis = true;
  bool reportAllErrors = true;
  // bool reportSummaryErrors = true;
 
  // check if this event's buffer is a dummy buffer
  int counterDummyWindows = 0;
  unsigned int testPatternDummyEvent = 0xbbbb;
  for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
    int index = iWindow * windowSize + 3;
    testPattern = (rdat[index] >> 16) & 0xffff;
    if (testPattern == testPatternDummyEvent) {
      counterDummyWindows++;
    }
    // March 30, 2022: need to be able to override the settings in data
    if (!m_overrideControlBits) {
      // Oct. 31, 2020: three most significant bits are now used to control unpacker from FW
      // Note that setting either flag for any of the windows changes it for all windows here
      testPattern = (rdat[index + 2] >> 29) & 0x7;
      if (testPattern & 0x1) performBufferAnalysis = false;
      if (testPattern & 0x2) reportAllErrors = false;
      // if (testPattern & 0x4) reportSummaryErrors = false;
    }
  }
 
  // note that events with empty buffer have numberOfWindows=0
  if (counterDummyWindows == numberOfWindows) {
    performBufferAnalysis = false;
  } else {
    if (counterDummyWindows != 0) {
      if (reportAllErrors) B2ERROR("Corrupted data? numberOfWindows = " << numberOfWindows << ", counterDummyWindows = " <<
                                     counterDummyWindows);
      performBufferAnalysis = false;
    }
  }
 
  /*
  int numberRvcJumps = 0;
  int numberCntr127Jumps = 0;
  int windowRvcJumpFirst = -1;
  int windowCntr127JumpFirst = -1;
  int clocksRvcJumpFirst = -1;
  int clocksCntr127JumpFirst = -1;
 
  if (performBufferAnalysis) {
    for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
      int index = iWindow * windowSize + 3;
 
      // revoclk (comes from b2tt) has the range between 0 and 1279 @127MHz => 1279*7.8ns ~10us = 1 revolution (11bits are used)
      int revoClockNow = rdat[index] & 0x7ff;
      //    B2INFO("rvc now = " << revoClockNow);
      // first need to know max revoClock (1279)
      if (revoClockLast != -1)  {
        //      if (revoClockLast != -1 && revoClockNow > revoClockLast)  {
        int revoClockDeltaNow = revoClockNow - revoClockLast;
        if (revoClockDeltaNow != revoClockDeltaExpected) {
          // -1276 is simply going to the next cycle of rvc counting, but 1188 or -92 means that there was one frame missing in data / corrupted data
          if (revoClockDeltaNow != -1276) {
            if (reportAllErrors) B2INFO("rvc changed by an unexpected number of units (1): " << revoClockDeltaNow << ", last rvc = " <<
                                           revoClockLast <<
                                           ", current rvc = " << revoClockNow << ", window " << iWindow << ", index = " << index);
            numberRvcJumps++;
            if (windowRvcJumpFirst < 0) {
              windowRvcJumpFirst = iWindow;
              clocksRvcJumpFirst = revoClockDeltaNow;
            }
          }
        }
      }
      revoClockLast = revoClockNow;
 
      int cntr127Now = (rdat[index + 1] >> 16) & 0xffff;
      //    B2INFO("cntr127 now = " << cntr127Now);
      // first need to know max cntr127
      if (cntr127Last != -1)  {
        //      if (cntr127Last != -1 && cntr127Now > cntr127Last)  {
        int cntr127DeltaNow = cntr127Now - cntr127Last;
        if (cntr127DeltaNow != cntr127DeltaExpected) {
          // 65444 is the value of the difference in cntr127 (VME counter) because we use 16 bits of 64 bit-long counter
          if (cntr127DeltaNow != 65444) {
            if (reportAllErrors) B2INFO("cntr127 changed by an unexpected number of units (1): " << cntr127DeltaNow << ", cntr127 last = " <<
                                           cntr127Last <<
                                           ", cntr127 now = " << cntr127Now << ", window " << iWindow << ", index = " << index + 1);
            numberCntr127Jumps++;
            if (windowCntr127JumpFirst < 0) {
              windowCntr127JumpFirst = iWindow;
              clocksCntr127JumpFirst = cntr127DeltaNow;
            }
          }
        }
      }
      cntr127Last = cntr127Now;
    }
  }
  */
 
  /*
  if (numberRvcJumps > 0) {
    B2INFO("The number of rvc jumps = " << numberRvcJumps);
    B2INFO("The window of the first rvc jump = " << windowRvcJumpFirst);
    B2INFO("The number of clock cycles associated with the first rvc jump = " << clocksRvcJumpFirst);
  }
 
  if (numberCntr127Jumps > 0) {
    B2INFO("The number of cntr127 jumps = " << numberCntr127Jumps);
    B2INFO("The window of the first cntr127 jump = " << windowCntr127JumpFirst);
    B2INFO("The number of clock cycles associated with the first cntr127 jump = " << clocksCntr127JumpFirst);
  }
  */
 
  // debugging: report everything from every single window when we are seeing unexpected jumps in either of the two counters
  /*
  if (numberRvcJumps > 0 || numberCntr127Jumps > 0) {
    B2INFO("===========================================================================================================");
    B2INFO("l1_rvc from header = " << rvcL1);
    B2INFO("eventNumberL1 (evt) from buffer header = " << eventNumberL1);
    B2INFO("Reporting the entire data buffer");
    B2INFO("Header 0 = : " << std::hex << rdat[0] << std::dec);
    B2INFO("Header 1 = : " << std::hex << rdat[1] << std::dec);
    B2INFO("Header 2 = : " << std::hex << rdat[2] << std::dec);
    for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
      int index = iWindow * windowSize + 3;
 
      B2INFO("---------------------------------------------------------------------------------");
      int revoClockNow = rdat[index] & 0x7ff;
      B2INFO("w rvc ----------------------------     = " << iWindow << " " << revoClockNow);
 
      int cntr127Now = (rdat[index + 1] >> 16) & 0xffff;
      B2INFO("w cntr127 ---------------------------- = " << iWindow << " " << cntr127Now);
 
      for (int i = 0; i < 24; i++) {
  B2INFO("w i = : " << iWindow << " " << i << " " << std::hex << rdat[index+i] << std::dec);
      }
    }
  }
  */
 
  // reset "most recent" rvc and cntr127
  revoClockLast = -1;
  cntr127Last = -1;
 
  // events with no buffer (i.e. no payload), empty (i.e. dummy) windows and presumably corrupted events are NOT analyzed
  if (performBufferAnalysis) {
 
    int slotT0Last[8];
    int slotNHitLast[8];
    int slotSegmentLast[8];
 
    int otherInformationLast[8];
 
    int combinedT0Last;
    int combinedT0RVC2GDLLast;
 
    // Loop over windows in B2L buffer and locate all unique slot-level TOP L1 decisions
    for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
 
      //      B2INFO("REAL DEBUG:  window number = " << iWindow);
 
      int clockCycle = iWindow * 4;
 
      // error counters for possible data corruption in the current window
      unsigned int errorCountWindow = 0;
 
      // a pointer-like variable for accessing the data in the buffer sequentially
      int index = iWindow * windowSize + 3;
 
      unsigned int testPatternExpected = 0;
      if (dataFormatVersionExpected == 1) testPatternExpected = 0xbbba;
      else if (dataFormatVersionExpected >= 2) testPatternExpected = 0xdddd;
 
      testPattern = (rdat[index] >> 16) & 0xffff;
      //    B2INFO("testPattern = " << std::hex << testPattern << std::dec);
      if (testPattern != testPatternExpected) {
        if (reportAllErrors) B2ERROR("An unexpected test pattern: " << std::hex << testPattern << std::dec << ", window " << iWindow <<
                                       ", index = " << index);
        errorCountWindow++;
      }
 
      int dataFormatVersionNow = (rdat[index] >> 11) & 0x1f;
      //    B2INFO("dataFormatVersionNow = " << dataFormatVersionNow);
      if (dataFormatVersionNow == 3 && dataFormatVersionExpected == 2) {
        dataFormatVersionExpected = 3;
      }
      if (dataFormatVersionNow == 4 && dataFormatVersionExpected == 2) {
        dataFormatVersionExpected = 4;
      }
      if (dataFormatVersionNow == 5) {
        dataFormatVersionExpected = 5;
      }
 
      if (dataFormatVersionNow != dataFormatVersionExpected) {
        if (reportAllErrors) {
          if (!m_reportedAlreadyRun_2) {
            B2ERROR("An unexpected data format version: " << dataFormatVersionNow << ", window " << iWindow << ", index = " <<
                    index);
            m_reportedAlreadyRun_2 = true;
          }
        }
        errorCountWindow++;
      }
 
      // revoclk (comes from b2tt) has the range between 0 and 1279 @127MHz => 1279*7.8ns ~10us = 1 revolution (11bits are used)
      int revoClockNow = rdat[index] & 0x7ff;
      //      B2INFO("window = " << iWindow << ", rvc now = " << revoClockNow);
      // first need to know max revoClock (1279)
      if (revoClockLast != -1)  {
        //      if (revoClockLast != -1 && revoClockNow > revoClockLast)  {
        int revoClockDeltaNow = revoClockNow - revoClockLast;
        if (revoClockDeltaNow != revoClockDeltaExpected) {
          if (revoClockDeltaNow != -1276) {
            if (reportAllErrors) B2INFO("rvc changed by an unexpected number of units (2): " << revoClockDeltaNow << ", last rvc = " <<
                                          revoClockLast <<
                                          ", current rvc = " << revoClockNow << ", window " << iWindow << ", index = " << index);
            //            errorCountWindow++;
          }
        }
      }
      if (revoClockNow > 1279) {
        if (reportAllErrors) B2ERROR("An unexpected rvc value = " << revoClockNow << ", window " << iWindow << ", index = " << index);
        errorCountWindow++;
      }
      revoClockLast = revoClockNow;
 
      int cntr127Now = (rdat[index + 1] >> 16) & 0xffff;
      //    B2INFO("cntr127 now = " << cntr127Now);
      // first need to know max cntr127
      if (cntr127Last != -1) {
        //      if (cntr127Last != -1 && cntr127Now > cntr127Last)  {
        int cntr127DeltaNow = cntr127Now - cntr127Last;
        if (cntr127DeltaNow != cntr127DeltaExpected) {
          // 65444 is the value of the difference in cntr127 (VME counter) because we use 16 bits of 64 bit-long counter
          if (cntr127DeltaNow != 65444 && cntr127DeltaNow != -65532) {
            if (reportAllErrors) B2INFO("cntr127 changed by an unexpected number of units (2): " << cntr127DeltaNow << ", cntr127 last = " <<
                                          cntr127Last <<
                                          ", cntr127 now = " << cntr127Now << ", window " << iWindow << ", index = " << index + 1);
            errorCountWindow++;
          }
        }
      }
      cntr127Last = cntr127Now;
 
      //
 
      int slotT0[8];
      int slotNHit[8];
      int slotSegment[8];
 
      int otherInformation[8];
 
      //      int versionFW = rdat[index + 3];
 
      int combinedT0 = rdat[index + 2] & 0x3ffff;
      int combinedT0RVC2GDL = (rdat[index + 2] >> 18) & 0x7ff;
      int combinedT0ClockCycle = clockCycle;
 
      slotT0[0] = (rdat[index + 4] >> 16) & 0xffff;
      slotT0[1] = (rdat[index + 4]) & 0xffff;
      slotT0[2] = (rdat[index + 5] >> 16) & 0xffff;
      slotT0[3] = (rdat[index + 5]) & 0xffff;
      slotT0[4] = (rdat[index + 6] >> 16) & 0xffff;
      slotT0[5] = (rdat[index + 6]) & 0xffff;
      slotT0[6] = (rdat[index + 7] >> 16) & 0xffff;
      slotT0[7] = (rdat[index + 7]) & 0xffff;
 
      slotNHit[0] = (rdat[index + 8] >> 20) & 0x3ff;
      slotNHit[1] = (rdat[index + 8] >> 10) & 0x3ff;
      slotNHit[2] = (rdat[index + 8]) & 0x3ff;
 
      slotNHit[3] = (rdat[index + 9] >> 20) & 0x3ff;
      slotNHit[4] = (rdat[index + 9] >> 10) & 0x3ff;
      slotNHit[5] = (rdat[index + 9]) & 0x3ff;
 
      slotNHit[6] = (rdat[index + 10] >> 10) & 0x3ff;
      slotNHit[7] = (rdat[index + 10]) & 0x3ff;
 
      slotSegment[0] = (rdat[index + 11] >> 28) & 0xf;
      slotSegment[1] = (rdat[index + 11] >> 24) & 0xf;
      slotSegment[2] = (rdat[index + 11] >> 20) & 0xf;
      slotSegment[3] = (rdat[index + 11] >> 16) & 0xf;
      slotSegment[4] = (rdat[index + 11] >> 12) & 0xf;
      slotSegment[5] = (rdat[index + 11] >> 8) & 0xf;
      slotSegment[6] = (rdat[index + 11] >> 4) & 0xf;
      slotSegment[7] = (rdat[index + 11] >> 0) & 0xf;
 
      // the following information is board-dependent
      otherInformation[0] = (rdat[index + 12] >> 16) & 0xffff;
      otherInformation[1] = (rdat[index + 12]) & 0xffff;
      otherInformation[2] = (rdat[index + 13] >> 16) & 0xffff;
      otherInformation[3] = (rdat[index + 13]) & 0xffff;
      otherInformation[4] = (rdat[index + 14] >> 16) & 0xffff;
      otherInformation[5] = (rdat[index + 14]) & 0xffff;
      otherInformation[6] = (rdat[index + 15] >> 16) & 0xffff;
      otherInformation[7] = (rdat[index + 15]) & 0xffff;
 
      if (iWindow != 0) {
 
        // try to retrieve combined t0 decisions (limited info)
        if (channel == 0) {
          if (combinedT0 != combinedT0Last ||
              combinedT0RVC2GDL != combinedT0RVC2GDLLast
             ) {
 
            //      int toptrgT0_revoToNS = combinedT0%revoToNS;
            //      int rvcL1_NS = rvcL1 * 8;
            //      int deltaT0 = rvcL1_NS >= toptrgT0_revoToNS ? rvcL1_NS - toptrgT0_revoToNS : rvcL1_NS - toptrgT0_revoToNS + revoToNS;
            //      int latencyL12TOPTRG = revoClockNow >= rvcL1 ? revoClockNow - rvcL1 : revoClockNow - rvcL1 + 1280;
 
            TRGTOPCombinedT0Decision combinedT0Decision(combinedT0,
                                                        revoClockNow,
                                                        combinedT0ClockCycle,
                                                        combinedT0RVC2GDL,
                                                        eventNumberL1,
                                                        rvcL1
                                                       );
 
            m_TRGTOPCombinedT0DecisionArray.appendNew(combinedT0Decision);
 
            /*
            cout << "-DEBUG- new combined decision: t0 (2ns), eventNumberL1, rvc2GDL, clock cycle, rvcNOW, rvcL1, latency, deltaT0 (ns) = "
            << combinedT0/2 << ", "
            << eventNumberL1 << ", "
            << combinedT0RVC2GDL << ", "
            << combinedT0ClockCycle << ", "
            << revoClockNow << ", "
            << rvcL1 << ", "
            << latencyL12TOPTRG << ", "
            << deltaT0
            << endl;
            */
 
            combinedT0Last = combinedT0;
            combinedT0RVC2GDLLast = combinedT0RVC2GDL;
          }
 
          // retrieve slot-level decisions (limited info) for slots 1 through 8 as observed on the board used for slots 9 through 16
          for (int i = 0; i < 8; i++) {
 
            if (otherInformation[i] != otherInformationLast[i]) {
 
              int slotOther = i + 1;
 
              TRGTOPSlotTiming slotTiming(slotOther,
                                          2 * otherInformation[i],
                                          0,
                                          0,
                                          0,
                                          clockCycle,
                                          errorCountWindow,
                                          0,
                                          -1
                                         );
 
              //        auto* thisSlotTiming = m_TRGTOPSlotTimingArray.appendNew(slotTiming);
              m_TRGTOPSlotTimingArray.appendNew(slotTiming);
 
              otherInformationLast[i] = otherInformation[i];
 
            }
          }
        }
 
        // retrieve slot-level decisions (complete info) for the currently-processed readout board
 
        int slotNow = 1;
        if (channel == 0) slotNow = 9;
 
        for (int i = 0; i < 8; i++) {
 
          if (slotT0[i] != slotT0Last[i] ||
              slotNHit[i] != slotNHitLast[i] ||
              slotSegment[i] != slotSegmentLast[i]) {
 
            /*
            cout << "-DEBUG- slot, index, clockCycle = " << slotNow << ", " << index << ", " << clockCycle
            << ", combT0 = " << combT0
            <<",  rvcL1 from header = " << rvcL1
            << ", eventNumberL1 (evt) = " << eventNumberL1
            << ", FW version = " << std::hex << versionFW << std::dec
            << ", slot T0 = " << slotT0[i]
            << ", NHit = " << slotNHit[i]
            << ", Segment = " << slotSegment[i]
            << ", other information = " << otherInformation[i]
            << endl;
            */
 
            //      TRGTOPSlotTiming* thisSlotTiming(NULL);
 
            // logL is currently not available (use nHit in lieu of that), so set to 0
            // firstTS info is only available for slots 1 through 8 (channel == 1)
            // -1 for firstTS means no info
            // 1 as the next to the last parameter means "information from the board being read-out"
 
            if (channel == 1) {
 
              TRGTOPSlotTiming slotTiming(slotNow,
                                          2 * slotT0[i],
                                          slotSegment[i],
                                          slotNHit[i],
                                          0,
                                          clockCycle,
                                          errorCountWindow,
                                          1,
                                          otherInformation[i]
                                         );
              //        thisSlotTiming = m_TRGTOPSlotTimingArray.appendNew(slotTiming);
              m_TRGTOPSlotTimingArray.appendNew(slotTiming);
            } else {
 
              TRGTOPSlotTiming slotTiming(slotNow,
                                          2 * slotT0[i],
                                          slotSegment[i],
                                          slotNHit[i],
                                          0,
                                          clockCycle,
                                          errorCountWindow,
                                          1,
                                          -1
                                         );
              //        thisSlotTiming = m_TRGTOPSlotTimingArray.appendNew(slotTiming);
              m_TRGTOPSlotTimingArray.appendNew(slotTiming);
            }
 
            // slot-level decisions are not currently related to combined decisions
            //      thisSlotTiming->addRelationTo(thisCombinedTiming);
            //      thisCombinedTiming->addRelationTo(thisSlotTiming);
 
            slotT0Last[i] = slotT0[i];
            slotNHitLast[i] = slotNHit[i];
            slotSegmentLast[i] = slotSegment[i];
 
          }
 
          slotNow++;
 
        }
      } else {
 
        combinedT0Last = combinedT0;
        for (int i = 0; i < 8; i++) {
          slotT0Last[i] = slotT0[i];
          slotNHitLast[i] = slotNHit[i];
          slotSegmentLast[i] = slotSegment[i];
          otherInformationLast[i] = otherInformation[i];
 
          combinedT0Last = combinedT0;
          combinedT0RVC2GDLLast = combinedT0RVC2GDL;
        }
      }
    }
  }
 
}

version()

std::string version

(

)

const

returns version of TRGGDLUnpackerModule.

Definition at line 28 of file trgtopUnpackerModule.cc.

{
  return std::string("1.00");
}

Member Data Documentation

clkTo1ns

double clkTo1ns = 0.5 / 0.508877

staticconstexpr

Definition at line 42 of file trgtopUnpackerModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_eventNumber

int m_eventNumber

protected

Event number (according to L1/global)

Definition at line 78 of file trgtopUnpackerModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 507 of file Module.h.

m_nodeId

int m_nodeId

protected

Our read-out ID.

Definition at line 80 of file trgtopUnpackerModule.h.

m_nWords

int m_nWords

protected

N words in raw data.

Definition at line 81 of file trgtopUnpackerModule.h.

m_overrideControlBits

bool m_overrideControlBits

protected

Definition at line 87 of file trgtopUnpackerModule.h.

m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 509 of file Module.h.

m_pciedata

bool m_pciedata

protected

PCIe40 data or copper data.

Definition at line 82 of file trgtopUnpackerModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 511 of file Module.h.

m_reportedAlreadyRun_1

bool m_reportedAlreadyRun_1

protected

Definition at line 84 of file trgtopUnpackerModule.h.

m_reportedAlreadyRun_2

bool m_reportedAlreadyRun_2

protected

Definition at line 85 of file trgtopUnpackerModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

m_TRGTOPCombinedT0DecisionArray

StoreArray<TRGTOPCombinedT0Decision> m_TRGTOPCombinedT0DecisionArray

private

Definition at line 95 of file trgtopUnpackerModule.h.

m_TRGTOPSlotTimingArray

StoreArray<TRGTOPSlotTiming> m_TRGTOPSlotTimingArray

private

Definition at line 96 of file trgtopUnpackerModule.h.

m_trigType

int m_trigType

protected

Trigger type.

Definition at line 79 of file trgtopUnpackerModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

revoToNS

int revoToNS = 1280 * 8

staticconstexprprivate

time period of revo strobe in "ns" (assuming the clock of "125MHz")

Definition at line 92 of file trgtopUnpackerModule.h.

---

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

• trg/top/modules/trgtopUnpacker/include/trgtopUnpackerModule.h
• trg/top/modules/trgtopUnpacker/src/trgtopUnpackerModule.cc