packing::SingleSubsystemPacker Class Reference

This producer unpacks the data from the a single subsystem raw data file into a single buffer for a downstream processor to decode. More...

#include <SingleSubsystemPacker.h>

Public Member Functions
	SingleSubsystemPacker (const std::string &name, framework::Process &p)
	normal constructor
virtual	~SingleSubsystemPacker ()
	empty destructor
void	configure (framework::config::Parameters &ps) override
	Configure the unpacker and open the raw data file for IO.
void	analyze (const framework::Event &event) override
	Actually do the unpacking/decoding.
Public Member Functions inherited from framework::Analyzer
	Analyzer (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.
virtual void	onProcessEnd ()
	Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
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::string	input_name_
	buffer object name on event bus
std::string	input_pass_
	buffer object pass on event bus
utility::Writer	writer_
	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::Analyzer
static const int	CLASSTYPE {2}
	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 a single subsystem raw data file into a single buffer for a downstream processor to decode.

Definition at line 17 of file SingleSubsystemPacker.h.

Constructor & Destructor Documentation

SingleSubsystemPacker()

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

inline

normal constructor

Definition at line 20 of file SingleSubsystemPacker.h.

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

~SingleSubsystemPacker()

virtual packing::SingleSubsystemPacker::~SingleSubsystemPacker ( )

inlinevirtual

empty destructor

Definition at line 23 of file SingleSubsystemPacker.h.

{}

Member Function Documentation

analyze()

void packing::SingleSubsystemPacker::analyze ( const 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::Analyzer.

Definition at line 12 of file SingleSubsystemPacker.cxx.

                                                               {
  if (!writer_) abortEvent();
 
  auto buff{event.getCollection<uint8_t>(input_name_, input_pass_)};
  writer_ << buff;
}

References framework::EventProcessor::abortEvent(), input_name_, input_pass_, and writer_.

configure()

void packing::SingleSubsystemPacker::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 SingleSubsystemPacker.cxx.

                                                                   {
  writer_.open(ps.getParameter<std::string>("raw_file"));
  input_name_ = ps.getParameter<std::string>("input_name");
  input_pass_ = ps.getParameter<std::string>("input_pass");
}

References framework::config::Parameters::getParameter(), input_name_, input_pass_, packing::utility::Writer::open(), and writer_.

Member Data Documentation

input_name_

std::string packing::SingleSubsystemPacker::input_name_

private

buffer object name on event bus

Definition at line 41 of file SingleSubsystemPacker.h.

Referenced by analyze(), and configure().

input_pass_

std::string packing::SingleSubsystemPacker::input_pass_

private

buffer object pass on event bus

Definition at line 43 of file SingleSubsystemPacker.h.

Referenced by analyze(), and configure().

writer_

utility::Writer packing::SingleSubsystemPacker::writer_

private

raw data file we are reading

Definition at line 47 of file SingleSubsystemPacker.h.

Referenced by analyze(), and configure().

---

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

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