art::ArtdaqInput< U > Class Template Reference

This template class provides a unified interface for reading data into art. More...

#include <artdaq/ArtModules/ArtdaqInput.hh>

List of all members.

Public Member Functions

 ArtdaqInput (const ArtdaqInput &)
 Copy Constructor is deleted.
ArtdaqInputoperator= (const ArtdaqInput &)
 Copy Assignment operator is deleted.
 ~ArtdaqInput ()
 ArtdaqInput Destructor.
 ArtdaqInput (const fhicl::ParameterSet &ps, art::ProductRegistryHelper &helper, art::SourceHelper const &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.

Detailed Description

template<typename U>
class art::ArtdaqInput< U >

This template class provides a unified interface for reading data into art.

Template Parameters:
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 77 of file ArtdaqInput.hh.


Constructor & Destructor Documentation

template<typename U >
art::ArtdaqInput< U >::ArtdaqInput ( const fhicl::ParameterSet &  ps,
art::ProductRegistryHelper &  helper,
art::SourceHelper const &  pm 
) [inline]

ArtdaqInput Constructor.

Parameters:
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 164 of file ArtdaqInput.hh.


Member Function Documentation

template<typename U >
bool art::ArtdaqInput< U >::hasMoreData (  )  const [inline]

Whether additional events are expected from the source.

Returns:
True if ArtdaqInput has not been shut down

Definition at line 312 of file ArtdaqInput.hh.

template<typename U >
ArtdaqInput& art::ArtdaqInput< U >::operator= ( const ArtdaqInput< U > &   ) 

Copy Assignment operator is deleted.

Returns:
ArtdaqInput copy
template<typename U >
void art::ArtdaqInput< U >::readFile ( const std::string &  ,
art::FileBlock *&  fb 
) [inline]

Emulate reading a file.

Parameters:
fb Output art::FileBlock object

Definition at line 299 of file ArtdaqInput.hh.

template<typename U >
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.

Parameters:
inR RunPrincipal input pointer
inSR SubRunPrincipal input pointer
outR RunPrincipal output pointer
outSR SubRunPrincipal output pointer
outE EventPrincipal output pointer
Returns:
Whether an event was successfully read from the communication wrapper

Definition at line 574 of file ArtdaqInput.hh.


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

Generated on 19 Feb 2018 for artdaq by  doxygen 1.6.1