NanoSlice.hh

Go to the documentation of this file.

#ifndef dune_artdaq_Overlays_NanoSlice_hh
#define dune_artdaq_Overlays_NanoSlice_hh

#include <stdint.h>

namespace dune {
  class NanoSlice;
}

class dune::NanoSlice {

public:

  struct Header {
    typedef uint32_t data_t;

    typedef uint16_t version_t;
    typedef uint16_t nanoslice_size_t;  
    typedef uint16_t channel_number_t;  
    typedef uint16_t sample_count_t;  

    // this structure is deliberately incomplete - it should be
    // improved to match what we want for the DUNE 35t detector

    data_t version        : 16;
    data_t nanoslice_size : 16;   // total size, data & header
    data_t channel_number : 16;
    data_t sample_count   : 16;
  };

  // This constructor accepts a memory buffer that contains an existing
  // nanoSlice and allows the the data inside it to be accessed
  NanoSlice(uint8_t* address);

  // Returns the size of the NanoSlice
  Header::nanoslice_size_t size() const;

  // Returns the channel number for the NanoSlice
  Header::channel_number_t channelNumber() const;

  // Returns the number of samples in this NanoSlice
  Header::sample_count_t sampleCount() const;

  // Fetches the value for the requested sample.  Returns true if
  // the requested value was found, false if not.
  bool sampleValue(uint32_t index, uint16_t& value) const;

protected:

  // returns a pointer to the header
  Header const* header_() const;

  // returns a pointer to the first sample value
  uint16_t const* data_() const;

  uint8_t* buffer_;
};

#endif /* dune_artdaq_Overlays_NanoSlice_hh */