LtbTraits.h

Go to the documentation of this file.

#ifndef LTBREADOUTFORMAT_LTBTRAITS_H
#define LTBREADOUTFORMAT_LTBTRAITS_H

/*
 *  LtbTraits.h
 *  LtbReadoutFormat
 *
 *  Created by Simon Patton on 7/21/10.
 *  Copyright 2010 DayaBay Collaboration. All rights reserved.
 *
 */
#include <vector>
#include <ctime>

#include "DaqReadoutFormat/DaqTraits.h"

namespace DybDaq {
    class LtbTime;
}

namespace DybDaq {

class LtbTraits : public DaqTraits {

public:

    typedef std::vector<const char*> TriggerLines;

    typedef LtbTime LtbDateTime;

    static const unsigned int kHead;
    
    static const unsigned int kFrameFront;
    
    static const unsigned int kTime;
    
    static const unsigned int kFrameBack;
    
    static const unsigned int kFoot;
    
    static const unsigned int kUnixTime;

    static const unsigned int kGpsTime;
    
    // Fields

    static const unsigned int kRawTriggerTotal;

    static const unsigned int kRawTriggersSaved;

    static const unsigned int kLtbStatus;

    static const unsigned int kLocalTriggerNumber;

    static const unsigned int kFrameNumber;

    static const unsigned int kReadoutType;

    static const unsigned int kTriggerMask;

    static const unsigned int kYear;

    static const unsigned int kMonth;

    static const unsigned int kDay;

    static const unsigned int kHour;

    static const unsigned int kMinutes;

    static const unsigned int kSeconds;

    static const unsigned int kTicks;

    static const unsigned int kHitSum;

    static const unsigned int kTotalEsum;

    static const unsigned int kHighEsum;

    static const unsigned int kLowEsum;

    static const unsigned int kEnergySum;

    static const unsigned int kCrossTriggerSource;

    static const unsigned int kFootDataLength;

    static const unsigned int kClockError;

    static const unsigned int kVersion;

    static const unsigned int kAccumulationStatus;

    static const unsigned int kValidGps;

    static const unsigned int kUsingUtc;

    /* Added v4.1 */
    static const unsigned int kValidClockSystem;

    static const unsigned int kHighNanoseconds;

    static const unsigned int kLowNanoseconds;

    static const unsigned int kHighUnixTime;

    static const unsigned int kLowUnixTime;

    static const unsigned int kHighAccumulation;

    static const unsigned int kLowAccumulation;

    static const unsigned int kFeeBufferFull;

    static const unsigned int kLtbBufferFull;

    static const unsigned int kBlockedTriggerCount;

    /* Added v4.6 */
    static const unsigned int kHighCrossTrigger;

    static const unsigned int kLowCrossTrigger;

    // Known trigger lines

    static const unsigned int kManualTrigger;

    static const unsigned int kCrossTrigger;

    static const unsigned int kPeriodicTrigger;

    static const unsigned int kPedestalTrigger;

    static const unsigned int kCalibTrigger;

    static const unsigned int kRandomTrigger;

    static const unsigned int kMultiplicityTrigger;

    static const unsigned int kEsumAdcTrg;

    static const unsigned int kHighEsumCompTrg;

    static const unsigned int kLowEsumCompTrg;

    static const unsigned int kAllEsumCompTrg;

    static const unsigned int kNHitLowTrigger;

    static const unsigned int kNHitHighTrigger;

    static const LtbTraits& defaultTraits();

    static const LtbTraits* readTraits(const char*& buffer);

    virtual ~LtbTraits();

    virtual unsigned int illegalMarker() const;

    virtual unsigned int illegalField() const;

    const std::string dateTimeAsString(const LtbDateTime& time) const;

    const LtbDateTime* makeDateTime(const time_t& time) const;

    virtual const TriggerLines* triggerLines(const unsigned int mask) const;

    virtual const char* triggerLineAsString(unsigned int line) const;

    virtual unsigned int triggerLineBit(const unsigned int line) const;

    virtual unsigned int headSize() const = 0;

    virtual unsigned int frameSize() const = 0;

    virtual unsigned int timeSize() const = 0;

    virtual unsigned int footSize() const = 0;

    virtual void initializeHead(char* buffer) const = 0;

    virtual void initializeFrame(char* buffer) const = 0;

    virtual void initializeTime(char* buffer) const = 0;

    virtual void initializeFoot(char* buffer) const = 0;

    virtual unsigned int timeOffset() const = 0;

protected:

    LtbTraits();

    virtual unsigned int triggerLineEnd() const = 0;

    virtual const char** triggerLineStrings() const = 0;

    virtual const unsigned int* triggerLineBits() const = 0;

private:

    LtbTraits(LtbTraits& rhs);

    LtbTraits& operator=(LtbTraits& rhs);
};

}

#endif // LTBREADOUTFORMAT_LTBTRAITS_H