packing::RawIO Class Reference

This producer unpacks the data from the various subsystems into different branches for later decoding by the subsystem modules. More...

#include <RawIO.h>

Public Member Functions
	RawIO (const std::string &name, framework::Process &p)
	normal constructor
virtual	~RawIO ()
	empty destructor
void	configure (framework::config::Parameters &ps) override
	Configure the unpacker and open the raw data file for IO.
void	beforeNewRun (ldmx::RunHeader &header) override
	We are given a non-const reference to a new RunHeader so we can add parameters unpacked from the raw data.
void	produce (framework::Event &event) override
	Actually do the unpacking/decoding.
void	onProcessEnd () override
	Close up ROOT file with raw data in it.
Public Member Functions inherited from framework::Producer
	Producer (const std::string &name, Process &process)
	Class constructor.
Public Member Functions inherited from framework::EventProcessor
	EventProcessor (const std::string &name, Process &process)
	Class constructor.
virtual	~EventProcessor ()
	Class destructor.
virtual void	onNewRun (const ldmx::RunHeader &runHeader)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.
virtual void	onFileOpen (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
virtual void	onFileClose (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a event input ROOT file is closed.
virtual void	onProcessStart ()
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
template<class T >
const T &	getCondition (const std::string &condition_name)
	Access a conditions object for the current event.
TDirectory *	getHistoDirectory ()
	Access/create a directory in the histogram file for this event processor to create histograms and analysis tuples.
void	setStorageHint (framework::StorageControl::Hint hint)
	Mark the current event as having the given storage control hint from this module.
void	setStorageHint (framework::StorageControl::Hint hint, const std::string &purposeString)
	Mark the current event as having the given storage control hint from this module and the given purpose string.
int	getLogFrequency () const
	Get the current logging frequency from the process.
int	getRunNumber () const
	Get the run number from the process.
std::string	getName () const
	Get the processor name.
void	createHistograms (const std::vector< framework::config::Parameters > &histos)
	Internal function which is used to create histograms passed from the python configuration @parma histos vector of Parameters that configure histograms to create.

Private Attributes
std::unique_ptr< rawdatafile::File >	raw_file_
	raw data file we are reading

Additional Inherited Members
Static Public Member Functions inherited from framework::EventProcessor
static void	declare (const std::string &classname, int classtype, EventProcessorMaker *)
	Internal function which is part of the PluginFactory machinery.
Static Public Attributes inherited from framework::Producer
static const int	CLASSTYPE {1}
	Constant used to track EventProcessor types by the PluginFactory.
Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.
Protected Attributes inherited from framework::EventProcessor
HistogramHelper	histograms_
	Interface class for making and filling histograms.
NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.
logging::logger	theLog_
	The logger for this EventProcessor.

Detailed Description

This producer unpacks the data from the various subsystems into different branches for later decoding by the subsystem modules.

We essentially do no work here and are only interfacing with the RawDataFile submodule.

Definition at line 19 of file RawIO.h.

Constructor & Destructor Documentation

RawIO()

packing::RawIO::RawIO ( const std::string &  name, framework::Process &  p  )

inline

normal constructor

Definition at line 22 of file RawIO.h.

      : framework::Producer(name, p) {}

~RawIO()

virtual packing::RawIO::~RawIO ( )

inlinevirtual

empty destructor

Definition at line 25 of file RawIO.h.

{}

Member Function Documentation

beforeNewRun()

void packing::RawIO::beforeNewRun ( ldmx::RunHeader &  header )

overridevirtual

We are given a non-const reference to a new RunHeader so we can add parameters unpacked from the raw data.

Reimplemented from framework::Producer.

Definition at line 11 of file RawIO.cxx.

                                              {
  raw_file_->writeRunHeader(header);
}

References raw_file_.

configure()

void packing::RawIO::configure ( framework::config::Parameters &  ps )

overridevirtual

Configure the unpacker and open the raw data file for IO.

Parameters

[in]

ps

Parameters for configuration

Reimplemented from framework::EventProcessor.

Definition at line 6 of file RawIO.cxx.

                                                   {
  raw_file_ = std::make_unique<rawdatafile::File>(
      ps.getParameter<framework::config::Parameters>("raw_file"));
}

References framework::config::Parameters::getParameter(), and raw_file_.

onProcessEnd()

void packing::RawIO::onProcessEnd ( )

overridevirtual

Close up ROOT file with raw data in it.

Reimplemented from framework::EventProcessor.

Definition at line 22 of file RawIO.cxx.

{ raw_file_->close(); }

References raw_file_.

produce()

void packing::RawIO::produce ( framework::Event &  event )

overridevirtual

Actually do the unpacking/decoding.

Parameters

[in,out]

event

Event bus with raw data where we will put the digis

Implements framework::Producer.

Definition at line 15 of file RawIO.cxx.

                                         {
  raw_file_->connect(event);
  if (not raw_file_->nextEvent()) {
    abortEvent();
  }
}

References framework::EventProcessor::abortEvent(), and raw_file_.

Member Data Documentation

raw_file_

std::unique_ptr<rawdatafile::File> packing::RawIO::raw_file_

private

raw data file we are reading

Definition at line 54 of file RawIO.h.

Referenced by beforeNewRun(), configure(), onProcessEnd(), and produce().

---

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

• Packing/include/Packing/RawIO.h
• Packing/src/Packing/RawIO.cxx