In This Package:

LtbTraits_v4_3.cc

Go to the documentation of this file.

/*
 *  LtbTraits_v4_3.cc
 *  LtbReadoutFormat
 *
 *  Created by Simon Patton on 7/21/10.
 *  Copyright 2010 DayaBay Collaboration. All rights reserved.
 *
 */
#include "LtbReadoutFormat/LtbTraits_v4_3.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_v4_3;
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
    0U, // kHour
    1U, // kMinutes
    1U, // kSeconds
    0U, // kTicks
    5U, // kHitSum
    5U, // kTotalEsum
    5U, // kHighEsum
    5U, // kLowEsum
    5U, // kEnergySum
    6U, // kCrossTriggerSource
    0U, // kFootDataLength
    
    0U, // kClockError
    0U, // kVersion
    0U, // kAccumulationStatus
    0U, // kValidGps
    0U, // kUsingUtc
    0U, // kValidClockSystem
    2U, // kHighNanoseconds
    1U, // kLowNanoseconds
    0U, // kHighUnixTime
    1U, // kLowUnixTime
    3U, // kHighAccumulation
    1U, // kLowAccumulation
    6U, // kFeeBufferFull
    6U, // kLtbBufferFull    
    6U  // kBlockedTriggerCount    
};

static const unsigned int m_shifts[] = {
    22U, // kRawTriggerTotal
    16U, // kRawTriggersSaved
    0U,  // kLtbStatus
    0U,  // kLocalTriggerNumber
    18U, // kFrameNumber
    16U, // kReadoutType
    0U,  // kTriggerMask
    0U,  // kYear
    0U,  // kMonth
    6U,  // kDay
    0U,  // kHour
    7U,  // kMinutes
    0U,  // kSeconds
    0U,  // kTicks
    16U, // kHitSum
    14U, // kTotalEsum
    13U, // kHighEsum
    12U, // kLowEsum
    0U,  // kEnergySum
    0U,  // kCrossTriggerSource
    0U,  // kFootDataLength
    
    0U,  // kClockError
    8U,  // kVersion
    27U, // kAccumulationStatus
    26U, // kValidGps
    25U, // kUsingUtc
    24U, // kValidClockSystem
    0U,  // kHighNanoseconds
    16U, // kLowNanoseconds
    0U,  // kHighUnixTime
    0U,  // kLowUnixTime
    0U,  // kHighAccumulation
    20U, // kLowAccumulation
    27U, // kFeeBufferFull
    26U, // kLtbBufferFull
    16U  // kBlockedTriggerCount
};

static const unsigned int m_masks[] = {
    0x0000003fU, // kRawTriggerTotal
    0x0000003fU, // kRawTriggersSaved
    0x00000000U, // kLtbStatus
    0x000000ffU, // kLocalTriggerNumber
    0x0000003fU, // kFrameNumber
    0x00000003U, // kReadoutType
    0x0000ffffU, // kTriggerMask
    0x00000000U, // kYear
    0x00000000U, // kMonth
    0x000003ffU, // kDay
    0x0000003fU, // kHour
    0x0000007fU, // kMinutes
    0x0000007fU, // kSeconds
    0x00000000U, // kTicks
    0x000001ffU, // kHitSum
    0x00000001U, // kTotalEsum
    0x00000001U, // kHighEsum
    0x00000001U, // kLowEsum
    0x00000fffU, // kEnergySum
    0x000003ffU, // kCrossTriggerSource
    0x000000ffU, // kFootDataLength
    
    0x00008000U, // kClockError
    0x0000000fU, // kVersion
    0x00000001U, // kAccumulationStatus
    0x00000001U, // kValidGps
    0x00000001U, // kUsingUtc
    0x00000001U, // kValidClockSystem
    0x0fffffffU, // kHighNanoseconds
    0x0000000fU, // kLowNanoseconds
    0x0000ffffU, // kHighUnixTime
    0x0000ffffU, // kLowUnixTime
    0x0fffffffU, // kHighAccumulation
    0x0000000fU, // kLowAccumulation
    0x00000001U, // kFeeBufferFull
    0x00000001U, // kLtbBufferFull
    0x00003fffU  // kBlockedTriggerCount
};

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",
    
    "LTB Clock Error",
    "LTB Format Stamp",
    "LTB Accumulaiton Status",
    "LTB Has Valid GPS",
    "LTB Using UTC",
    "LTB Has Valid Clock",
    "LTB High Bits of Nanoseconds",
    "LTB Low Bits of Nanoseconds",
    "LTB High Bits of Unix Time",
    "LTB Low Bits of Unix Time",
    "LTB High Bits of Accumulation",
    "LTB Low Bits of Accumulation",
    "LTB FEE Buffer Full",
    "LTB Buffer Full",
    "LTB Number Blocked Triggers"
};

static const unsigned int kLtbHeadElements[] = {
    0U,  // kRawTriggerTotal
    1U,  // kRawTriggersSaved
    21U, // kClockError
    22U, // kVersion
    3U   // kLocalTriggerNumber
};

static const unsigned int kLtbFrameFrontElements[] = {
    23U, // kAccumulationStatus
    24U, // kValidGps
    25U, // kUsingUtc
    26U, // kValidClockSystem
    4U,  // kFrameNumber
    5U,  // kReadoutType
    6U   // kTriggerMask
};

static const unsigned int kLtbTimeElements[] = {
    29U, // kHighUnixTime
    32U, // kLowAccumulation
    28U, // kLowNanoseconds
    30U, // kLowUnixTime
    27U, // kHighNanoseconds
    31U  // kHighAccumulation
};

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

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

static const unsigned int kLtbUnixTimeElements[] = {
    29U, // kHighUnixTime
    32U, // kLowAccumulation
    28U, // kLowNanoseconds
    30U, // kLowUnixTime
    27U, // kHighNanoseconds
    31U  // kHighAccumulation
};

static const unsigned int kLtbGpsTimeElements[] = {
    9U,  // kDay
    10U, // kHour
    32U, // kLowAccumulation
    28U, // kLowNanoseconds
    11U, // kMinutes
    12U, // kSeconds
    27U, // kHighNanoseconds
    31U  // kHighAccumulation
};

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
    kLtbUnixTimeElements,   // LTB Unix Time
    kLtbGpsTimeElements,    // LTB GPS Time
};

static const unsigned int m_componentFieldsEnd[] = {
    5U, // LTB Head
    7U, // LTB Frame Part 1
    6U, // LTB Time
    9U, // LTB Frame Part 2
    1U, // LTB Foot
    6U, // LTB Unix Time
    8U  // LTB GPS Time
    
};

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

static const char* m_triggerLines[] = {
    "MANUAL_TRIGGER",
    "CROSS_TRIGGER_IN",
    "PERIODIC_TRIGGER",
    "PEDESTAL_TRIGGER",
    "CALIB_TRIGGER",
    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, // kPedestalTrigger
    0x0010U, // kCalibTrigger
    0x0020U,
    0x0040U,
    0x0080U,
    0x0100U, // kMultiplicityTrigger
    0x0200U, // kEsumAdcTrg
    0x0400U, // kHighEsumCompTrg
    0x0800U, // kLowEsumCompTrg
    0x1000U  // kAllEsumCompTrg
};

const char* LtbTraits_v4_3::key() {
        return "LTB Format 4.3";
}

LtbTraits_v4_3::LtbTraits_v4_3() {
}

LtbTraits_v4_3::~LtbTraits_v4_3() {
}

unsigned int LtbTraits_v4_3::majorVersion() const {
        return 4U;
}

unsigned int LtbTraits_v4_3::minorVersion() const {
        return 1U;
}

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

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

unsigned int LtbTraits_v4_3::frameSize() const {
    return 7U;
}

unsigned int LtbTraits_v4_3::timeSize() const {
    return 4U;
}

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

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

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

void LtbTraits_v4_3::initializeTime(char* buffer) const {
    for (unsigned int count = 0;
         count != timeSize();
         ++count) {
        *((unsigned int*)(buffer + (count * DaqBuffer::kBytesInInt))) = 0x00000000U; // Time four bytes
    }
    // TODO: DAQ_ERROR, Fix this, dry-run has bit 16 set in the first time 4-bytes.
    *((unsigned int*)buffer) = 0x00a10000U;
}

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

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

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

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

unsigned int LtbTraits_v4_3::fieldsEnd() const {
        return kBlockedTriggerCount + 1;
}

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

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

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

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

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

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

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

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

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

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

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

---