artdaq::ContainerFragmentLoader Class Reference

A Read-Write version of the ContainerFragment, used for filling ContainerFragment objects with other Fragment objects. More...

#include <artdaq-core/Data/ContainerFragmentLoader.hh>

Inheritance diagram for artdaq::ContainerFragmentLoader:
artdaq::ContainerFragment

List of all members.

Public Member Functions

 ContainerFragmentLoader (Fragment &f, Fragment::type_t expectedFragmentType)
 Constructs the ContainerFragmentLoader.
Metadatametadata ()
 Get the ContainerFragment metadata (includes information about the location of Fragment objects within the ContainerFragment).
void set_fragment_type (Fragment::type_t type)
 Sets the type of Fragment which this ContainerFragment should contain.
void set_missing_data (bool isDataMissing)
 Sets the missing_data flag.
void addFragment (artdaq::Fragment &frag)
 Add a Fragment to the ContainerFragment by reference.
void addFragment (artdaq::FragmentPtr &frag)
 Add a Fragment to the ContainerFragment by smart pointer.
void addFragments (artdaq::FragmentPtrs &frags)
 Add a collection of Fragment objects to the ContainerFragment.

Detailed Description

A Read-Write version of the ContainerFragment, used for filling ContainerFragment objects with other Fragment objects.

Definition at line 30 of file ContainerFragmentLoader.hh.


Constructor & Destructor Documentation

artdaq::ContainerFragmentLoader::ContainerFragmentLoader ( artdaq::Fragment f,
Fragment::type_t  expectedFragmentType = Fragment::EmptyFragmentType 
) [inline, explicit]

Constructs the ContainerFragmentLoader.

Parameters:
f A Fragment object containing a Fragment header.
expectedFragmentType The type of fragment which will be put into this ContainerFragment
Exceptions:
cet::exception if the Fragment input has inconsistent Header information

Definition at line 107 of file ContainerFragmentLoader.hh.


Member Function Documentation

void artdaq::ContainerFragmentLoader::addFragment ( artdaq::FragmentPtr frag  )  [inline]

Add a Fragment to the ContainerFragment by smart pointer.

Parameters:
frag A FragmentPtr to a Fragment to be added to the ContainerFragment

Definition at line 180 of file ContainerFragmentLoader.hh.

void artdaq::ContainerFragmentLoader::addFragment ( artdaq::Fragment frag  )  [inline]

Add a Fragment to the ContainerFragment by reference.

Parameters:
frag A Fragment object to be added to the ContainerFragment
Exceptions:
cet::exception If the Fragment to be added has a different type than expected

Definition at line 151 of file ContainerFragmentLoader.hh.

void artdaq::ContainerFragmentLoader::addFragments ( artdaq::FragmentPtrs frags  )  [inline]

Add a collection of Fragment objects to the ContainerFragment.

Parameters:
frags An artdaq::FragmentPtrs object containing Fragments to be added to the ContainerFragment

Definition at line 185 of file ContainerFragmentLoader.hh.

Metadata* artdaq::ContainerFragmentLoader::metadata (  )  [inline]

Get the ContainerFragment metadata (includes information about the location of Fragment objects within the ContainerFragment).

Returns:
The ContainerFragment metadata

Definition at line 48 of file ContainerFragmentLoader.hh.

void artdaq::ContainerFragmentLoader::set_fragment_type ( Fragment::type_t  type  )  [inline]

Sets the type of Fragment which this ContainerFragment should contain.

Parameters:
type The Fragment::type_t identifying the type of Fragment objects stored in this ContainerFragment

Definition at line 58 of file ContainerFragmentLoader.hh.

void artdaq::ContainerFragmentLoader::set_missing_data ( bool  isDataMissing  )  [inline]

Sets the missing_data flag.

Parameters:
isDataMissing The value of the missing_data flag

The ContainerFragment::Metadata::missing_data flag is used for FragmentGenerators to indicate that the fragment is incomplete, but the generator does not have the correct data to fill it. This happens for Window-mode FragmentGenerators when the window requested is before the start of the FragmentGenerator's buffers, for example.

Definition at line 71 of file ContainerFragmentLoader.hh.


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

Generated on 24 Sep 2018 for artdaq_core by  doxygen 1.6.1