In This Package:

RtmReadout.h

Go to the documentation of this file.

#ifndef RTMREADOUTFORMAT_RTMREADOUT_H
#define RTMREADOUTFORMAT_RTMREADOUT_H

#include "DaqReadoutFormat/RomData.h"
#include "DaqReadoutFormat/DaqContainer.h"

#include <vector>

// pre-declaration
namespace DybDaq {
   class RtmData;
   class RtmTraits;
}


namespace DybDaq {

class RtmReadout : public DaqContainer, public RomData {
public :

   typedef std::vector<const RtmData*> RtmDataPtrList;

   // Constructor for writing
   RtmReadout(const RtmTraits& traits);

   // Constructor for reading
   RtmReadout(const ByteBuffer& byteBuffer,
              const unsigned int length,
              const unsigned int verFormat = 0);

   // Destructor
   virtual ~RtmReadout();

   // Returns the DaqTraits for parsing
   virtual const DaqTraits& daqTraits() const;

   // Get the list of RtmData
   const RtmDataPtrList& rtmDataList() const;

   // Returns the total size, in 4-bytes, of all the buffers for this object's components.
   virtual unsigned int romSize() const;

   // Adds to the supplied line the OutputBuffers that contain the DAQ format
   // of this objects content returning the total number of bytes in the added buffers.
   virtual unsigned int gatherRom(OutputBufferList& outputBuffers) const;

   // Adds to the supplied list the DaqBuffer::Bytes that contains inspections of this
   // object's objects.
   virtual unsigned int inspectRom(DaqBuffer::Bytes& inspectors) const;
    
   // Returns the size, in 4-bytes, of this ojbect's contents in the buffer.
   virtual unsigned int bufferSize() const;


   // Add RTM data to this CBLT readout
   const RtmData& addRtmData(const unsigned int rpcCFId,
                             const bool transErr,
                             const bool romAlmostFull,
                             const bool rtmAlmostFull,
                             const bool fullFlag,
                             const bool validGPS,
                             const bool validCLK,
                             const bool usingUTC,
                             const unsigned int second,
                             const unsigned int nanoSecond,
                             const unsigned int accumulation,
                             const unsigned int triggerRot,
                             const unsigned int triggerMap);


protected :

    // Gathers the DAQ formatted bytes for this object's components.
    virtual unsigned int gatherComponents(OutputBufferList& outputBuffers) const;

    //Inspects the DAQ formatted bytes for this object's components.
    virtual unsigned int inspectComponents(DaqBuffer::Bytes& inspectors) const;
    
    // Tells this object that its contents has expanded by the specified number of bytes.
    virtual void expanded(const unsigned int size);

    // Associates the supplied DaqExpandable with this object if it is not already associated with
    // one. It returns true if the association is successful, false otherwise.
    virtual bool setRomExpandable(DaqExpandable& expandable);


private :

    // Following interfaces are suppressed by default
    RtmReadout();
    RtmReadout(const RtmReadout&);
    RtmReadout& operator=(const RtmReadout&);

    // Returns the RtmTraits for parsing
    const RtmTraits& rtmTraits() const;

    // Add a RpcRtmData to this CBLT readout
    const RtmData& add(const RtmData* rtmData);


    // The list of RtmData
    mutable RtmDataPtrList* m_rtmList;

    // The version of RTM data format
    unsigned int m_verFormat;

    // The RtmTraits pointer
    mutable const RtmTraits* m_rtmTraits;
};

}

#endif

---