artdaq  v3_07_02
art::RootNetOutput Class Reference

An art::OutputModule which sends events using DataSenderManager. This module is designed for transporting Fragment-wrapped art::Events after they have been read into art, for example between the EventBuilder and the Aggregator. More...

Inheritance diagram for art::RootNetOutput:
art::ArtdaqOutput

Classes

struct  Config
 Allowed Configuration parameters of NetMonTransportService. May be used for configuration validation More...
 

Public Types

using Parameters = fhicl::WrappedTable< Config >
 Used for ParameterSet validation (if desired)
 

Public Member Functions

 RootNetOutput (fhicl::ParameterSet const &ps)
 RootNetOutput Constructor. More...
 
 RootNetOutput (Parameters const &ps)
 RootNetOutput Constructor. More...
 
 ~RootNetOutput ()
 RootNetOutput Destructor.
 
size_t dataReceiverCount () const
 Get the number of data receivers. More...
 
- Public Member Functions inherited from art::ArtdaqOutput
 ArtdaqOutput (fhicl::ParameterSet const &ps)
 ArtdaqOutput Constructor More...
 
virtual ~ArtdaqOutput ()=default
 Destructor More...
 

Protected Member Functions

virtual void SendMessage (artdaq::FragmentPtr &fragment)
 Send a message using DataSenderManager More...
 
- Protected Member Functions inherited from art::ArtdaqOutput
virtual void openFile (FileBlock const &)
 Perform actions necessary for opening files. No-op, but derived classes may override More...
 
virtual void closeFile ()
 Perform actions necessary for closing files. No-op, but derived classes may override More...
 
virtual void respondToCloseInputFile (FileBlock const &)
 Perform actions nesessary after closing the input file. No-op, but derived classes may override More...
 
virtual void respondToCloseOutputFiles (FileBlock const &)
 Perform actions necessary after closing the output file(s). No-op, but derived classes may override More...
 
virtual void endJob ()
 Perform End-of-Job actions. No-op, but derived classes may override More...
 
virtual void beginRun (RunPrincipal const &rp) final
 Perform Begin Run actions. Derived classes should implement beginRun_ instead. More...
 
virtual void beginRun_ (RunPrincipal const &)
 Perform Begin Run actions. No-op, but derived classes may override More...
 
virtual void beginSubRun (SubRunPrincipal const &srp) final
 Perform Begin SubRun actions. Derived classes should implement beginSubRun_ instead. More...
 
virtual void beginSubRun_ (SubRunPrincipal const &)
 Perform Begin SubRun actions. No-op, but derived classes may override More...
 
virtual void event (EventPrincipal const &ep) final
 Perform actions for each event. Derived classes should implement event_ instead. More...
 
virtual void event_ (EventPrincipal const &)
 Perform actions for each event. No-op, but derived classes may override More...
 
virtual void write (EventPrincipal &ep) final
 Write an EventPrincipal to TBufferFile and send More...
 
virtual void writeRun (RunPrincipal &rp) final
 Write a RunPrincipal to TBufferFile and send More...
 
virtual void writeSubRun (SubRunPrincipal &srp) final
 Write a SubRunPrincipal to TBufferFile and send More...
 
void writeDataProducts (std::unique_ptr< TBufferFile > &msg, const Principal &principal, std::vector< BranchKey * > &bkv)
 Extract the data products from a Principal and write them to the TBufferFile More...
 
void extractProducts_ (Principal const &principal)
 Extract the list of Products from the given Principal More...
 
void send_init_message (History const &history)
 Send an init message downstream. Use the given History for initializing downstream art processes. More...
 

Detailed Description

An art::OutputModule which sends events using DataSenderManager. This module is designed for transporting Fragment-wrapped art::Events after they have been read into art, for example between the EventBuilder and the Aggregator.

Definition at line 23 of file RootNetOutput_module.cc.

Constructor & Destructor Documentation

art::RootNetOutput::RootNetOutput ( fhicl::ParameterSet const &  ps)
explicit

RootNetOutput Constructor.

Parameters
psParameterSet used to configure RootNetOutput

RootNetOutput accepts no Parameters beyond those which art::OutputModule takes. See the art::OutputModule documentation for more details on those Parameters.

Definition at line 85 of file RootNetOutput_module.cc.

art::RootNetOutput::RootNetOutput ( Parameters const &  ps)
explicit

RootNetOutput Constructor.

Parameters
psParameterSet used to configure RootNetOutput (Checked using Config struct defined above)

RootNetOutput accepts no Parameters beyond those which art::OutputModule takes. See the art::OutputModule documentation for more details on those Parameters.

Definition at line 98 of file RootNetOutput_module.cc.

Member Function Documentation

size_t art::RootNetOutput::dataReceiverCount ( ) const
inline

Get the number of data receivers.

Returns
The number of data receivers

Definition at line 65 of file RootNetOutput_module.cc.

void art::RootNetOutput::SendMessage ( artdaq::FragmentPtr &  fragment)
protectedvirtual

Send a message using DataSenderManager

Parameters
sequence_idSequence ID of message
messageTypeType of message
msgContents of message

Implements art::ArtdaqOutput.

Definition at line 109 of file RootNetOutput_module.cc.


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