LtbTraits.cc

Go to the documentation of this file.

/*
 *  LtbTraits.cc
 *  LtbReadoutFormat
 *
 *  Created by Simon Patton on 7/21/10.
 *  Copyright 2010 DayaBay Collaboration. All rights reserved.
 *
 */

#include <map>

#include "LtbReadoutFormat/LtbTraits_v3_8.h"
#include "LtbReadoutFormat/LtbTraits_v4_1.h"
#include "LtbReadoutFormat/LtbTraits_v4_3.h"
#include "LtbReadoutFormat/LtbTraits_v4_6.h"

#include "LtbReadoutFormat/LtbTime.h"
#include "LtbReadoutFormat/LtbTraits.h"

using DybDaq::LtbTime;
using DybDaq::LtbTraits;
using DybDaq::LtbTraits_v3_8;
using DybDaq::LtbTraits_v4_1;
using DybDaq::LtbTraits_v4_3;
using DybDaq::LtbTraits_v4_6;
using std::string;

// Components in this format
const unsigned int LtbTraits::kHead = 0;
const unsigned int LtbTraits::kFrameFront = LtbTraits::kHead + 1;
const unsigned int LtbTraits::kTime = LtbTraits::kFrameFront + 1;
const unsigned int LtbTraits::kFrameBack = LtbTraits::kTime + 1;
const unsigned int LtbTraits::kFoot = LtbTraits::kFrameBack + 1;
const unsigned int LtbTraits::kUnixTime = LtbTraits::kFoot + 1;
const unsigned int LtbTraits::kGpsTime = LtbTraits::kUnixTime + 1;

// Known triggers
const unsigned int LtbTraits::kManualTrigger = 0;
const unsigned int LtbTraits::kCrossTrigger = LtbTraits::kManualTrigger + 1;
const unsigned int LtbTraits::kPeriodicTrigger = LtbTraits::kCrossTrigger + 1;
const unsigned int LtbTraits::kPedestalTrigger = LtbTraits::kPeriodicTrigger + 1;
const unsigned int LtbTraits::kCalibTrigger = LtbTraits::kPedestalTrigger + 1;
const unsigned int LtbTraits::kRandomTrigger = LtbTraits::kCalibTrigger + 1;
const unsigned int LtbTraits::kMultiplicityTrigger = LtbTraits::kRandomTrigger + 3;
const unsigned int LtbTraits::kEsumAdcTrg = LtbTraits::kMultiplicityTrigger + 1;
const unsigned int LtbTraits::kHighEsumCompTrg = LtbTraits::kEsumAdcTrg + 1;
const unsigned int LtbTraits::kLowEsumCompTrg = LtbTraits::kHighEsumCompTrg + 1;
const unsigned int LtbTraits::kAllEsumCompTrg = LtbTraits::kLowEsumCompTrg + 1;
const unsigned int LtbTraits::kNHitLowTrigger = LtbTraits::kAllEsumCompTrg + 1;
const unsigned int LtbTraits::kNHitHighTrigger = LtbTraits::kNHitLowTrigger + 1;

// Head
const unsigned int LtbTraits::kRawTriggerTotal = 0;
const unsigned int LtbTraits::kRawTriggersSaved = LtbTraits::kRawTriggerTotal + 1;
const unsigned int LtbTraits::kLtbStatus = LtbTraits::kRawTriggersSaved + 1;
const unsigned int LtbTraits::kLocalTriggerNumber = LtbTraits::kLtbStatus + 1;

// Frame
const unsigned int LtbTraits::kFrameNumber = LtbTraits::kLocalTriggerNumber + 1;
const unsigned int LtbTraits::kReadoutType = LtbTraits::kFrameNumber + 1;
const unsigned int LtbTraits::kTriggerMask = LtbTraits::kReadoutType + 1;
const unsigned int LtbTraits::kYear = LtbTraits::kTriggerMask + 1;
const unsigned int LtbTraits::kMonth = LtbTraits::kYear + 1;
const unsigned int LtbTraits::kDay = LtbTraits::kMonth + 1;
const unsigned int LtbTraits::kHour = LtbTraits::kDay + 1;
const unsigned int LtbTraits::kMinutes = LtbTraits::kHour + 1;
const unsigned int LtbTraits::kSeconds = LtbTraits::kMinutes + 1;
const unsigned int LtbTraits::kTicks = LtbTraits::kSeconds + 1;
const unsigned int LtbTraits::kHitSum = LtbTraits::kTicks + 1;
const unsigned int LtbTraits::kTotalEsum = LtbTraits::kHitSum + 1;
const unsigned int LtbTraits::kHighEsum = LtbTraits::kTotalEsum + 1;
const unsigned int LtbTraits::kLowEsum = LtbTraits::kHighEsum + 1;
const unsigned int LtbTraits::kEnergySum = LtbTraits::kLowEsum + 1;
const unsigned int LtbTraits::kCrossTriggerSource = LtbTraits::kEnergySum + 1;

// Foot
const unsigned int LtbTraits::kFootDataLength = LtbTraits::kCrossTriggerSource + 1;

// New in 4.1

// Head
const unsigned int LtbTraits::kClockError = LtbTraits::kFootDataLength + 1;
const unsigned int LtbTraits::kVersion = LtbTraits::kClockError + 1;

// Frame
const unsigned int LtbTraits::kAccumulationStatus = LtbTraits::kVersion + 1;
const unsigned int LtbTraits::kValidGps = LtbTraits::kAccumulationStatus + 1;
const unsigned int LtbTraits::kUsingUtc = LtbTraits::kValidGps + 1;
const unsigned int LtbTraits::kValidClockSystem = LtbTraits::kUsingUtc + 1;
const unsigned int LtbTraits::kHighNanoseconds = LtbTraits::kValidClockSystem + 1;
const unsigned int LtbTraits::kLowNanoseconds = LtbTraits::kHighNanoseconds + 1;
const unsigned int LtbTraits::kHighUnixTime = LtbTraits::kLowNanoseconds + 1;
const unsigned int LtbTraits::kLowUnixTime = LtbTraits::kHighUnixTime + 1;
const unsigned int LtbTraits::kHighAccumulation = LtbTraits::kLowUnixTime + 1;
const unsigned int LtbTraits::kLowAccumulation = LtbTraits::kHighAccumulation + 1;
const unsigned int LtbTraits::kFeeBufferFull = LtbTraits::kLowAccumulation + 1;
const unsigned int LtbTraits::kLtbBufferFull = LtbTraits::kFeeBufferFull + 1;
const unsigned int LtbTraits::kBlockedTriggerCount = LtbTraits::kLtbBufferFull + 1;

// New in 4.6

// Frame
const unsigned int LtbTraits::kHighCrossTrigger = LtbTraits::kBlockedTriggerCount + 1;
const unsigned int LtbTraits::kLowCrossTrigger = LtbTraits::kHighCrossTrigger + 1;

static const unsigned int kLengthOfDataTime = 21;

static std::map<const char*, LtbTraits*> m_allTraits;

LtbTraits::LtbTraits() {
}

LtbTraits::~LtbTraits() {
}

const LtbTraits& LtbTraits::defaultTraits() {
    if (0 == m_allTraits.size()) {
        m_allTraits.insert(std::pair<const char*, LtbTraits*>(LtbTraits_v3_8::key(),new LtbTraits_v3_8()));
        m_allTraits.insert(std::pair<const char*, LtbTraits*>(LtbTraits_v4_1::key(),new LtbTraits_v4_1()));
        m_allTraits.insert(std::pair<const char*, LtbTraits*>(LtbTraits_v4_3::key(),new LtbTraits_v4_3()));
        m_allTraits.insert(std::pair<const char*, LtbTraits*>(LtbTraits_v4_6::key(),new LtbTraits_v4_6()));
    }
    return *m_allTraits[LtbTraits_v4_6::key()];
}

const LtbTraits* LtbTraits::readTraits(const char*& buffer) {
    const unsigned int vers = readUnsignedInt(buffer,
                                            defaultTraits(),
                                            LtbTraits::kVersion);
    unsigned int major = 0;
    unsigned int minor = 0;
    if (0x0 == vers) {
        major = 3;
        minor = 8;
    } else if (0x2 == vers) {
        major = 4;
        minor = 1;
    } else if (0x3 == vers) {
        major = 4;
        minor = 3;
    } else if (0x4 == vers) {
        major = 4;
        minor = 6;
    }

    const LtbTraits* result = 0;
    if (4 > major) {
        result = m_allTraits[LtbTraits_v3_8::key()];
    } else if (4U == major && 1U == minor) {
        result = m_allTraits[LtbTraits_v4_1::key()];
    } else if (4U == major && 3U == minor) {
        result = m_allTraits[LtbTraits_v4_3::key()];
    } else if (4U == major && 6U == minor) {
        result = m_allTraits[LtbTraits_v4_6::key()];
    }        
    return result;
}

unsigned int LtbTraits::illegalMarker() const {
    return 0xffffffffU;
}

unsigned int LtbTraits::illegalField() const {
    return 0xffffffffU;
}

const LtbTraits::TriggerLines* LtbTraits::triggerLines(const unsigned int mask) const {
    TriggerLines* result = new TriggerLines();
    unsigned int bit = 1;
    for (unsigned int line = 0; line != triggerLineEnd(); ++ line) {
        if (mask & bit) {
            const char* name = triggerLineAsString(line);
            if (0 != name) {
                result->push_back(name);
            }
        }
        bit = bit << 1;
    }
    return result;
}

const char* LtbTraits::triggerLineAsString(unsigned int line) const {
    return triggerLineStrings()[line];
}

unsigned int LtbTraits::triggerLineBit(const unsigned int line) const {
    return triggerLineBits()[line];
}

const string LtbTraits::dateTimeAsString(const LtbTraits::LtbDateTime& time) const {
    const time_t unixTime = time.unixTime();
    struct tm* tmStruct = gmtime(&unixTime);
    
    char* dateTime = new char[kLengthOfDataTime];
    if (0 == strftime(dateTime,
                      kLengthOfDataTime,
                      "%Y-%m-%dT%H:%M:%SZ",
                      tmStruct)) {
        return "0000-00-00T00:00:00Z";
    };
    dateTime[kLengthOfDataTime - 1] = 0;
    string result(dateTime);
    delete dateTime;
    return result;
}

const LtbTraits::LtbDateTime* LtbTraits::makeDateTime(const time_t& time) const {
    return new LtbDateTime(time,
                           0,
                           0,
                           *this);
}