This template class provides a unified interface for reading data into art. More...
#include <artdaq/ArtModules/ArtdaqInput.hh>
Public Member Functions | |
ArtdaqInput (const ArtdaqInput &) | |
Copy Constructor is deleted. | |
ArtdaqInput & | operator= (const ArtdaqInput &) |
Copy Assignment operator is deleted. | |
~ArtdaqInput () | |
ArtdaqInput Destructor. | |
ArtdaqInput (const fhicl::ParameterSet &ps, art::ProductRegistryHelper &helper, const art::SourceHelper &pm) | |
ArtdaqInput Constructor. | |
void | closeCurrentFile () |
Called by art to close the input source. No-Op. | |
void | readFile (const std::string &, art::FileBlock *&fb) |
Emulate reading a file. | |
bool | hasMoreData () const |
Whether additional events are expected from the source. | |
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. |
This template class provides a unified interface for reading data into art.
U | The class responsible for delivering data |
JCF, May-27-2016 ArtdaqInput 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 74 of file ArtdaqInput.hh.
art::ArtdaqInput< U >::ArtdaqInput | ( | const fhicl::ParameterSet & | ps, | |
art::ProductRegistryHelper & | helper, | |||
const art::SourceHelper & | pm | |||
) | [inline] |
ArtdaqInput 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 161 of file ArtdaqInput.hh.
bool art::ArtdaqInput< U >::hasMoreData | ( | ) | const [inline] |
Whether additional events are expected from the source.
Definition at line 310 of file ArtdaqInput.hh.
ArtdaqInput& art::ArtdaqInput< U >::operator= | ( | const ArtdaqInput< U > & | ) |
Copy Assignment operator is deleted.
void art::ArtdaqInput< U >::readFile | ( | const std::string & | , | |
art::FileBlock *& | fb | |||
) | [inline] |
Emulate reading a file.
fb | Output art::FileBlock object |
Definition at line 297 of file ArtdaqInput.hh.
bool art::ArtdaqInput< U >::readNext | ( | art::RunPrincipal *const | inR, | |
art::SubRunPrincipal *const | inSR, | |||
art::RunPrincipal *& | outR, | |||
art::SubRunPrincipal *& | outSR, | |||
art::EventPrincipal *& | outE | |||
) | [inline] |
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 596 of file ArtdaqInput.hh.