|
artdaq
v3_09_05
|
This template class provides a unified interface for reading data into art. More...
#include <artdaq/ArtModules/ArtdaqInputHelper.hh>
Public Member Functions | |
| ArtdaqInputHelper (const ArtdaqInputHelper &)=delete | |
| Copy Constructor is deleted. | |
| ArtdaqInputHelper & | operator= (const ArtdaqInputHelper &)=delete |
| Copy Assignment operator is deleted. More... | |
| ~ArtdaqInputHelper () | |
| ArtdaqInputHelper Destructor. | |
| ArtdaqInputHelper (const fhicl::ParameterSet &ps, art::ProductRegistryHelper &helper, art::SourceHelper const &pm) | |
| ArtdaqInputHelper Constructor. More... | |
| void | closeCurrentFile () |
| Called by art to close the input source. No-Op. | |
| void | readFile (const std::string &, art::FileBlock *&fb) |
| Emulate reading a file. More... | |
| bool | hasMoreData () const |
| Whether additional events are expected from the source. More... | |
| bool | readNext (art::RunPrincipal *const inR, art::SubRunPrincipal *const inSR, art::RunPrincipal *&outR, art::SubRunPrincipal *&outSR, art::EventPrincipal *&outE) |
| Read the next event from the communication wrapper. More... | |
This template class provides a unified interface for reading data into art.
| U | The class responsible for delivering data |
JCF, May-27-2016 ArtdaqInputHelper is a template class which takes, as a parameter, a class which it uses to receive data; the instance of this class is called "communicationWrapper_". As of this writing, this wrapper class is implemented by NetMonWrapper (for reading data into the aggregator from the eventbuilder) and TransferWrapper (for reading data into an art process). This class presents a unified approach to handling art provenance, regardless of the communication protocol used to read data in.
Definition at line 73 of file ArtdaqInputHelper.hh.
| art::ArtdaqInputHelper< U >::ArtdaqInputHelper | ( | const fhicl::ParameterSet & | ps, |
| art::ProductRegistryHelper & | helper, | ||
| art::SourceHelper const & | pm | ||
| ) |
ArtdaqInputHelper Constructor.
| ps | ParameterSet used to confiugre communication wrapper class |
| helper | An art::ProductRegistryHelper for registering products |
| pm | An art::SourceHelper for handling provenance |
Definition at line 186 of file ArtdaqInputHelper.hh.
| bool art::ArtdaqInputHelper< U >::hasMoreData | ( | ) | const |
Whether additional events are expected from the source.
Definition at line 440 of file ArtdaqInputHelper.hh.
|
delete |
Copy Assignment operator is deleted.
| void art::ArtdaqInputHelper< U >::readFile | ( | const std::string & | , |
| art::FileBlock *& | fb | ||
| ) |
Emulate reading a file.
| fb | Output art::FileBlock object |
Definition at line 430 of file ArtdaqInputHelper.hh.
| bool art::ArtdaqInputHelper< U >::readNext | ( | art::RunPrincipal *const | inR, |
| art::SubRunPrincipal *const | inSR, | ||
| art::RunPrincipal *& | outR, | ||
| art::SubRunPrincipal *& | outSR, | ||
| art::EventPrincipal *& | outE | ||
| ) |
Read the next event from the communication wrapper.
| inR | RunPrincipal input pointer |
| inSR | SubRunPrincipal input pointer |
| outR | RunPrincipal output pointer |
| outSR | SubRunPrincipal output pointer |
| outE | EventPrincipal output pointer |
Definition at line 903 of file ArtdaqInputHelper.hh.