In This Package:

DaqToOStream.h

Go to the documentation of this file.

#ifndef FILEREADOUTFORMAT_DAQTOOSTREAM_H
#define FILEREADOUTFORMAT_DAQTOOSTREAM_H

/*
 *  DaqToOStream.h
 *  FileReadoutFormat
 *
 *  Created by Simon Patton on 2/25/11.
 *  Copyright 2011 DayaBay Collaboration. All rights reserved.
 *
 */
#include <ostream>
#include <string>

#include "DaqReadoutFormat/DaqBuffer.h"
#include "FileReadoutFormat/FileTraits.h"
#include "FileReadoutFormat/MetadataStrings.h"

namespace DybDaq {
    class CalibrationParametersRecord;
    class DataSeparatorRecord;
    class EventReadout;
    class FileBuffer;
    class FileEndRecord;
    class FileNameStrings;
    class FileStartRecord;
    class MetadataStrings;
    class RunParametersRecord;
}

namespace DybDaq {
    
    class DaqToOStream {
        
    public:
        
        virtual ~DaqToOStream();
        
        bool openSequence(const std::string& fileBase,
                          const FileStartRecord& record);
        
        const FileStartRecord* openSequence(const std::string& fileBase,
                                            const FileTraits::FileDateTime& dateTime,
                                            const unsigned int dataBlockLimit,
                                            const unsigned int megabyteLimit);
        
        bool open(const FileStartRecord& record);
        
        const FileStartRecord* openNext(const FileTraits::FileDateTime& dateTime);
        
        bool saveFileNameStrings(const FileNameStrings& record);
        
        const FileNameStrings* saveFileNameStrings(const std::string& application,
                                                   const std::string& fileBase = "");
        
        bool saveMetadataStrings(const MetadataStrings& record);
        
        const MetadataStrings* saveMetadataStrings(const MetadataStrings::MetadataStringPtrList& metadataStrings);
        
        bool saveRunParametersRecord(const RunParametersRecord& record);
        
        const RunParametersRecord* saveRunParametersRecord(const unsigned int runNumber,
                                                           const bool recordEnabled,
                                                           const unsigned int triggerType,
                                                           const unsigned int detectorMask);
        
        bool saveCalibrationParametersRecord(const CalibrationParametersRecord& record);
        
        const CalibrationParametersRecord* saveCalibrationParametersRecord(const unsigned int detector,
                                                                           const unsigned int adNumber,
                                                                           const unsigned int sourceA,
                                                                           const unsigned int zPositionA,
                                                                           const unsigned int sourceB,
                                                                           const unsigned int zPositionB,
                                                                           const unsigned int sourceC,
                                                                           const unsigned int zPositionC,
                                                                           const unsigned int led1,
                                                                           const unsigned int led2,
                                                                           const unsigned int led1Voltage,
                                                                           const unsigned int led2Voltage,
                                                                           const unsigned int duration,
                                                                           const unsigned int ledFrequency,
                                                                           const unsigned int ledPulseSeparation,
                                                                           const unsigned int ltbMode,
                                                                           const unsigned int motorPower,
                                                                           const unsigned int cameraPower,
                                                                           const unsigned int ledFlashing);
        
        bool saveDataSeparatorRecord(const DataSeparatorRecord& record);
        
        const DataSeparatorRecord* saveEvent(const EventReadout& event);
        
        bool close(const FileEndRecord& record) ;
        
        const FileEndRecord* close(const FileTraits::FileDateTime& dateTime);
        
        const FileEndRecord* close(const FileTraits::FileDateTime& dateTime,
                                   const unsigned int blockCountBeforeFile,
                                   const unsigned long payloadLengthBeforeFile,
                                   const unsigned int status);
        
    protected:
        
        DaqToOStream(const FileTraits& traits);
        
        const FileStartRecord* openElement(const unsigned int fileNumber,
                                           const FileTraits::FileDateTime& dateTime,
                                           const unsigned int dataBlockLimit,
                                           const unsigned int megabyteLimit);
        
        virtual std::ostream* openStream() = 0;

        virtual void prepareNext() = 0;
        
        virtual void closeStream(std::ostream& stream) = 0;
        
        void splitStream();

        void eventSaved(unsigned int bytesSaved);
        
        const std::string& getFileBase() const;
        
        unsigned int getFileBlockCount() const;

        unsigned int getFileCount() const;
        
        unsigned int getLastRecord() const;
        
        bool hasFileBase() const;
        
        bool hasOStream() const;
        
        void saveBuffer(const FileBuffer& daqBuffer);
        
    private:
        
        DaqToOStream();
        
        DaqToOStream(DaqToOStream& rhs);
        
        DaqToOStream& operator=(DaqToOStream& rhs);
        
        void setFileBase(const std::string& fileBase);
        
        const FileTraits* m_traits;
        
        std::ostream* m_ostream;
        
        DaqBuffer::OutputBufferList* m_buffers;
        
        std::string* m_fileBase;
        
        unsigned long m_filePayloadLength;
        
        unsigned long m_payloadLengthTotal;
        
        unsigned int m_lastRecord;
        
        unsigned int m_dataBlockLimit;
        
        unsigned int m_megabyteLimit;
        
        unsigned int m_fileCount;
        
        unsigned int m_sequenceBlockCount;
        
        unsigned int m_fileBlockCount;
        
        unsigned int m_blockCountTotal;
    };
    
}

#endif // FILEREADOUTFORMAT_DAQTOOSTREAM_H

---