#include <FelixFragment.hh>

Inheritance diagram for dune::FelixFragmentBase:

Classes
struct	Metadata

struct	Old_Metadata

Public Member Functions
virtual uint8_t	sof (const unsigned &frame_ID=0) const =0

virtual uint8_t	version (const unsigned &frame_ID=0) const =0

virtual uint8_t	fiber_no (const unsigned &frame_ID=0) const =0

virtual uint8_t	slot_no (const unsigned &frame_ID=0) const =0

virtual uint8_t	crate_no (const unsigned &frame_ID=0) const =0

virtual uint8_t	mm (const unsigned &frame_ID=0) const =0

virtual uint8_t	oos (const unsigned &frame_ID=0) const =0

virtual uint16_t	wib_errors (const unsigned &frame_ID=0) const =0

virtual uint64_t	timestamp (const unsigned &frame_ID=0) const =0

virtual uint16_t	wib_counter (const unsigned &frame_ID=0) const =0

virtual uint8_t	s1_error (const unsigned &frame_ID, const uint8_t &block_num) const =0

virtual uint8_t	s2_error (const unsigned &frame_ID, const uint8_t &block_num) const =0

virtual uint16_t	checksum_a (const unsigned &frame_ID, const uint8_t &block_num) const =0

virtual uint16_t	checksum_b (const unsigned &frame_ID, const uint8_t &block_num) const =0

virtual uint16_t	coldata_convert_count (const unsigned &frame_ID, const uint8_t &block_num) const =0

virtual uint16_t	error_register (const unsigned &frame_ID, const uint8_t &block_num) const =0

virtual uint8_t	hdr (const unsigned &frame_ID, const uint8_t &block_num, const uint8_t &hdr_num) const =0

virtual adc_t	get_ADC (const unsigned &frame_ID, const uint8_t channel_ID) const =0

virtual void	print_timestamps () const =0

virtual void	print (const unsigned i) const =0

virtual void	print_frames () const =0

	FelixFragmentBase (const artdaq::Fragment &fragment)

virtual	~FelixFragmentBase ()

virtual size_t	total_words () const =0

virtual size_t	total_frames () const =0

virtual size_t	total_adc_values () const =0

virtual size_t	adc_range (int daq_adc_bits=12)

const uint8_t *	dataBeginBytes () const

size_t	dataSizeBytes () const

Protected Attributes
Metadata	meta_

const void *	artdaq_Fragment_

size_t	sizeBytes_

Detailed Description

Definition at line 35 of file FelixFragment.hh.

Constructor & Destructor Documentation

dune::FelixFragmentBase::FelixFragmentBase ( const artdaq::Fragment & fragment )

inline

Definition at line 121 of file FelixFragment.hh.

       : meta_(*(fragment.metadata<Metadata>())),
         artdaq_Fragment_(fragment.dataBeginBytes()),
         sizeBytes_(fragment.dataSizeBytes()) {
     // Check whether the metadata is of the old format.
     if (meta_.control_word != 0xabc &&
         !(meta_.num_frames == 6024 && meta_.offset_frames == 500 &&
           meta_.window_frames == 6000)) {
       // mf::LogInfo("dune::FelixFragment")
       //     << "Fragment has old metadata format. (Control word "
       //     << (unsigned)meta_.control_word << ")\n";
       const Old_Metadata* old_meta = fragment.metadata<Old_Metadata>();
       meta_ = {0,
                0,
                old_meta->reordered,
                old_meta->compressed,
                old_meta->num_frames,
                old_meta->offset_frames,
                old_meta->window_frames};
     }
 
     // Deal with very long fragments that overflow the frame counter.
     if (fragment.dataSizeBytes() > meta_.num_frames*sizeof(dune::FelixFrame)*3) {
       // Assume uncompressed data.
       meta_.reordered = 0;
       meta_.compressed = 0;
       meta_.num_frames = fragment.dataSizeBytes()/sizeof(dune::FelixFrame);
       // Assume the offset is 11 frames at most.
       meta_.window_frames = fragment.dataSizeBytes()/sizeof(dune::FelixFrame)-12;
     }
     // Check whether current metadata makes sense and guess the format
     // otherwise.
     else if (meta_.reordered > 1 || meta_.compressed > 1 ||
         meta_.num_frames < meta_.window_frames) {
       // Assume 6024 frames in a fragment if there is no meaningful metadata.
       meta_.num_frames = 6024;
       meta_.offset_frames = 500;
       meta_.window_frames = 6000;
       // Try to predict reordered/compressed from fragment size.
       unsigned sizeBytes = fragment.dataSizeBytes();
       if (sizeBytes == meta_.num_frames * 464) {
         meta_.reordered = 0;
         meta_.compressed = 0;
       } else if (sizeBytes > meta_.num_frames * 592) {
         // Assume compression factor > 1.
         meta_.reordered = 1;
         meta_.compressed = 0;
       } else {
         // Assume reordered if compressed.
         meta_.reordered = 1;
         meta_.compressed = 1;
       }
     }
   }

virtual dune::FelixFragmentBase::~FelixFragmentBase ( )

inlinevirtual

Definition at line 175 of file FelixFragment.hh.

175 {}

Member Function Documentation

virtual size_t dune::FelixFragmentBase::adc_range ( int daq_adc_bits = 12 )

inlinevirtual

Definition at line 184 of file FelixFragment.hh.

                                                   {
     return (1ul << daq_adc_bits);
   }

virtual uint16_t dune::FelixFragmentBase::checksum_a	(	const unsigned &	frame_ID,
		const uint8_t &	block_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint16_t dune::FelixFragmentBase::checksum_b	(	const unsigned &	frame_ID,
		const uint8_t &	block_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint16_t dune::FelixFragmentBase::coldata_convert_count	(	const unsigned &	frame_ID,
		const uint8_t &	block_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::crate_no ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

const uint8_t* dune::FelixFragmentBase::dataBeginBytes ( ) const

inline

Definition at line 189 of file FelixFragment.hh.

                                         {
     return reinterpret_cast<uint8_t const*>(artdaq_Fragment_);
   }

size_t dune::FelixFragmentBase::dataSizeBytes ( ) const

inline

Definition at line 192 of file FelixFragment.hh.

192 { return sizeBytes_; }

dune::FelixFragmentBase::sizeBytes_

size_t sizeBytes_

Definition: FelixFragment.hh:197

virtual uint16_t dune::FelixFragmentBase::error_register	(	const unsigned &	frame_ID,
		const uint8_t &	block_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::fiber_no ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual adc_t dune::FelixFragmentBase::get_ADC	(	const unsigned &	frame_ID,
		const uint8_t	channel_ID
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::hdr	(	const unsigned &	frame_ID,
		const uint8_t &	block_num,
		const uint8_t &	hdr_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::mm ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::oos ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual void dune::FelixFragmentBase::print ( const unsigned i ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual void dune::FelixFragmentBase::print_frames ( ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual void dune::FelixFragmentBase::print_timestamps ( ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::s1_error	(	const unsigned &	frame_ID,
		const uint8_t &	block_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::s2_error	(	const unsigned &	frame_ID,
		const uint8_t &	block_num
	)		const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::slot_no ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::sof ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint64_t dune::FelixFragmentBase::timestamp ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual size_t dune::FelixFragmentBase::total_adc_values ( ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual size_t dune::FelixFragmentBase::total_frames ( ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual size_t dune::FelixFragmentBase::total_words ( ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint8_t dune::FelixFragmentBase::version ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint16_t dune::FelixFragmentBase::wib_counter ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

virtual uint16_t dune::FelixFragmentBase::wib_errors ( const unsigned & frame_ID = 0 ) const

pure virtual

Implemented in dune::FelixFragment, dune::FelixFragmentCompressed, dune::FelixFragmentReordered, and dune::FelixFragmentUnordered.

Member Data Documentation

const void* dune::FelixFragmentBase::artdaq_Fragment_

protected

Definition at line 196 of file FelixFragment.hh.

Metadata dune::FelixFragmentBase::meta_

protected

Definition at line 195 of file FelixFragment.hh.

size_t dune::FelixFragmentBase::sizeBytes_

protected

Definition at line 197 of file FelixFragment.hh.

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

dune-raw-data/dune-raw-data/Overlays/FelixFragment.hh

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation