LtbTraits_v3_8.cc

Go to the documentation of this file.

/*
 *  LtbTraits_v3_8.cc
 *  LtbReadoutFormat
 *
 *  Created by Simon Patton on 7/21/10.
 *  Copyright 2010 DayaBay Collaboration. All rights reserved.
 *
 */
#include "LtbReadoutFormat/LtbTraits_v3_8.h"

#include <ctime>

#include "DaqReadoutFormat/BitsDefinition.h"
#include "DaqReadoutFormat/DaqBuffer.h"
#include "LtbReadoutFormat/LtbTime.h"

using DybDaq::DaqTraits;
using DybDaq::LtbTime;
using DybDaq::LtbTraits;
using DybDaq::LtbTraits_v3_8;
using std::string;

static const unsigned int m_indices[] = {
    0U, // kRawTriggerTotal
    0U, // kRawTriggersSaved
    0U, // kLtbStatus
    0U, // kLocalTriggerNumber
    0U, // kFrameNumber
    0U, // kReadoutType
    0U, // kTriggerMask
    0U, // kYear
    0U, // kMonth
    0U, // kDay
    1U, // kHour
    1U, // kMinutes
    1U, // kSeconds
    2U, // kTicks
    4U, // kHitSum
    4U, // kTotalEsum
    4U, // kHighEsum
    4U, // kLowEsum
    4U, // kEnergySum
    5U, // kCrossTriggerSource
    0U  // kFootDataLength
};

static const unsigned int m_shifts[] = {
    22U, // kRawTriggerTotal
    16U, // kRawTriggersSaved
    8U,  // kLtbStatus
    0U,  // kLocalTriggerNumber
    18U, // kFrameNumber
    16U, // kReadoutType
    0U,  // kTriggerMask
    16U, // kYear
    8U,  // kMonth
    0U,  // kDay
    16U, // kHour
    8U,  // kMinutes
    0U,  // kSeconds
    0U,  // kTicks
    16U, // kHitSum
    14U, // kTotalEsum
    13U, // kHighEsum
    12U, // kLowEsum
    0U,  // kEnergySum
    0U,  // kCrossTriggerSource
    0U   // kFootDataLength
};

static const unsigned int m_masks[] = {
    0x0000003fU, // kRawTriggerTotal
    0x0000003fU, // kRawTriggersSaved
    0x000000ffU, // kLtbStatus
    0x000000ffU, // kLocalTriggerNumber
    0x0000003fU, // kFrameNumber
    0x00000003U, // kReadoutType
    0x0000ffffU, // kTriggerMask
    0x000000ffU, // kYear
    0x000000ffU, // kMonth
    0x000000ffU, // kDay
    0x000000ffU, // kHour
    0x000000ffU, // kMinutes
    0x000000ffU, // kSeconds
    0x07ffffffU, // kTicks
    0x000001ffU, // kHitSum
    0x00000001U, // kTotalEsum
    0x00000001U, // kHighEsum
    0x00000001U, // kLowEsum
    0x000007ffU, // kEnergySum
    0x0000003fU, // kCrossTriggerSource
    0x000000ffU  // kFootDataLength
};

static const std::string m_description[] = {
    "LTB Raw Trigger Total",
    "Number Raw Triggers Saved",
    "LTB status",
    "Local Trigger Seq. Number",
    "Frame Number in LTB Package",
    "LTB Readout Type",
    "LTB Trigger Mask",
    "Trigger Time's Year",
    "Trigger Time's Month",
    "Trigger Time's Day",
    "Trigger Time's Hour",
    "Trigger Time's Minutes",
    "Trigger Time's Seconds",
    "Trigger Time's Ticks",
    "Sum of Hits in FEE",
    "Total Energy Sum Comparison",
    "High Energy Sum Comparison",
    "Low Energy Sum Comparison",
    "ESUM ADC",
    "Cross Trigger Source",
    "LTB Package Data Length"
};

static const unsigned int kLtbHeadElements[] = {
    0U, // kRawTriggerTotal
    1U, // kRawTriggersSaved
    2U, // kLtbStatus
    3U  // kLocalTriggerNumber
};

static const unsigned int kLtbFrameFrontElements[] = {
    4U,  // kFrameNumber
    5U,  // kReadoutType
    6U,  // kTriggerMask
};

static const unsigned int kLtbTimeElements[] = {
    7U,  // kYear
    8U,  // kMonth
    9U,  // kDay
    10U, // kHour
    11U, // kMinutes
    12U, // kSeconds
    13U  // kTicks
};

static const unsigned int kLtbFrameBackElements[] = {
    14U, // kHitSum
    15U, // kTotalEsum
    16U, // kHighEsum
    17U, // kLowEsum
    18U, // kEnergySum
    19U  // kCrossTriggerSource
};

static const unsigned int kLtbFootElements[] = {
    20U // kFootDataLength
};

static const unsigned int* m_componentFields[] = {
    kLtbHeadElements,       // LTB Head
    kLtbFrameFrontElements, // LTB Frame Part 1
    kLtbTimeElements,       // LTB Time
    kLtbFrameBackElements,  // LTB Frame Part 2
    kLtbFootElements        // LTB Foot
};

static const unsigned int m_componentFieldsEnd[] = {
    4U, // LTB Head
    3U, // LTB Frame Part 1
    7U, // LTB Time
    6U, // LTB Frame Part 2
    1U, // LTB Foot
};

static DaqTraits::Definitions* m_definitions[] = {
    0, // LTB Header
    0, // LTB Frame Part 1
    0, // LTB Time
    0, // LTB Frame Part 2
    0  // LTB Foot
};

static const char* m_triggerLines[] = {
    "MANUAL_TRIGGER",
    "CROSS_TRIGGER_IN",
    "PERIODIC_TRIGGER",
    0,
    0,
    0,
    0,
    0,
    "MULTIPLICITY_TRIGGER",
    "ESUM_ADC_TRG",
    "HIGH_ESUM_COMP_TRG",
    "LOW_ESUM_COMP_TRG",
    "ALL_ESUM_COMP_TRG"
};

static const unsigned int m_triggerBits[] = {
    0x0001U, // kManualTrigger
    0x0002U, // kCrossTrigger
    0x0004U, // kPeriodicTrigger
    0x0008U,
    0x0010U,
    0x0020U,
    0x0040U,
    0x0080U,
    0x0100U, // kMultiplicityTrigger
    0x0200U, // kEsumAdcTrg
    0x0400U, // kHighEsumCompTrg
    0x0800U, // kLowEsumCompTrg
    0x1000U  // kAllEsumCompTrg
};

const char* LtbTraits_v3_8::key() {
        return "LTB Format 3.8";
}

LtbTraits_v3_8::LtbTraits_v3_8() {
}

LtbTraits_v3_8::~LtbTraits_v3_8() {
}

unsigned int LtbTraits_v3_8::majorVersion() const {
        return 3U;
}

unsigned int LtbTraits_v3_8::minorVersion() const {
        return 8U;
}

const string LtbTraits_v3_8::versionString() const {
        return key();
}

unsigned int LtbTraits_v3_8::headSize() const {
    return 1U;
}

unsigned int LtbTraits_v3_8::frameSize() const {
    return 6U;
}

unsigned int LtbTraits_v3_8::timeSize() const {
    return 3U;
}

unsigned int LtbTraits_v3_8::footSize() const {
    return 1U;
}

void LtbTraits_v3_8::initializeHead(char* buffer) const {
    *((unsigned int*)buffer)       = 0x40000000U; // Head four bytes
}

void LtbTraits_v3_8::initializeFrame(char* buffer) const {
    for (unsigned int count = 0;
         count != frameSize();
         ++count) {
        *((unsigned int*)(buffer + (count * DaqBuffer::kBytesInInt))) = 0x00000000U; // Frame four bytes
    }
}

void LtbTraits_v3_8::initializeTime(char* buffer) const {
    for (unsigned int count = 0;
         count != timeSize();
         ++count) {
        *((unsigned int*)(buffer + (count * DaqBuffer::kBytesInInt))) = 0x00000000U; // Time four bytes
    }
}

void LtbTraits_v3_8::initializeFoot(char* buffer) const {
    *((unsigned int*)buffer)       = 0xa0000000U; // Foot four bytes
}

unsigned int LtbTraits_v3_8::timeOffset() const {
    return 1U;
}

unsigned int LtbTraits_v3_8::markersEnd() const {
    return 0U;
}

const unsigned int* LtbTraits_v3_8::markers() const {
    return 0;
}

unsigned int LtbTraits_v3_8::fieldsEnd() const {
        return kFootDataLength + 1;
}

const unsigned int* LtbTraits_v3_8::indices() const {
        return m_indices;
}

const unsigned int* LtbTraits_v3_8::shifts() const {
        return m_shifts;
}

const unsigned int* LtbTraits_v3_8::masks() const {
        return m_masks;
}

const std::string* LtbTraits_v3_8::descriptions() const {
    return m_description;
}

DaqTraits::Definitions* LtbTraits_v3_8::definitions(unsigned int component) const {
    return m_definitions[component];
}

void LtbTraits_v3_8::setDefinitions(DaqTraits::Definitions* definitions,
                                    unsigned int component) {
    m_definitions[component] = definitions;
}

const unsigned int* LtbTraits_v3_8::componentFields(unsigned int component) const {
    return m_componentFields[component];
}

const unsigned int LtbTraits_v3_8::componentFieldsEnd(unsigned int component) const {
    return m_componentFieldsEnd[component];
}

unsigned int LtbTraits_v3_8::triggerLineEnd() const {
    return 13U;
}

const char** LtbTraits_v3_8::triggerLineStrings() const {
    return m_triggerLines;
}

const unsigned int* LtbTraits_v3_8::triggerLineBits() const {
    return m_triggerBits;
}