In This Package:

FileTraits.cc

Go to the documentation of this file.

/*
 *  FileTraits.cc
 *  RawFileReading
 *
 *  Created by Simon Patton on 7/19/10.
 *  Copyright 2010 DayaBay Collaboration. All rights reserved.
 *
 */
#include "FileReadoutFormat/FileTraits.h"

#include <map>

#include "FileReadoutFormat/FileTraits_v0_6.h"
#include "FileReadoutFormat/FileTraits_v0_7.h"
#include "FileReadoutFormat/FileTraits_v0_8.h"
#include "FileReadoutFormat/FileTraits_v0_9.h"

using DybDaq::FileTraits;
using std::string;

const unsigned int FileTraits::kIllegalRecord = 0xffffffffU;
const unsigned int FileTraits::kFileStartRecord = 0;
const unsigned int FileTraits::kFileNameStrings = FileTraits::kFileStartRecord + 1;
const unsigned int FileTraits::kMetadataStrings = FileTraits::kFileNameStrings + 1;
const unsigned int FileTraits::kRunParametersRecord = FileTraits::kMetadataStrings + 1;
const unsigned int FileTraits::kCalibrationParametersRecord = FileTraits::kRunParametersRecord + 1;
const unsigned int FileTraits::kDataSeparatorRecord = FileTraits::kCalibrationParametersRecord + 1;
const unsigned int FileTraits::kFileEndRecord = FileTraits::kDataSeparatorRecord + 1;
const unsigned int FileTraits::kFileEndMarker = FileTraits::kFileEndRecord + 1;

//

const unsigned int FileTraits::kIllegalField = 0xffffffffU;
const unsigned int FileTraits::kMarker = 0;
const unsigned int FileTraits::kRecordSize = FileTraits::kMarker + 1;

//

const unsigned int FileTraits::kMajorVersion = FileTraits::kRecordSize + 1;
const unsigned int FileTraits::kMinorVersion = FileTraits::kMajorVersion + 1;
const unsigned int FileTraits::kFileNumber = FileTraits::kMinorVersion + 1;
const unsigned int FileTraits::kFileOpenDate = FileTraits::kFileNumber + 1;
const unsigned int FileTraits::kFileOpenTime = FileTraits::kFileOpenDate + 1;
const unsigned int FileTraits::kDataBlockLimit = FileTraits::kFileOpenTime + 1;
const unsigned int FileTraits::kMegabyteLimit = FileTraits::kDataBlockLimit + 1;
//
const unsigned int FileTraits::kFirstNameLength = FileTraits::kMegabyteLimit + 1;
//
const unsigned int FileTraits::kMetadataCount = FileTraits::kFirstNameLength + 1;
const unsigned int FileTraits::kFirstMetadataLength = FileTraits::kMetadataCount + 1;
//
const unsigned int FileTraits::kFileRunNumber = FileTraits::kFirstMetadataLength + 1;
const unsigned int FileTraits::kRecordEnabled = FileTraits::kFileRunNumber + 1;
const unsigned int FileTraits::kRunTriggerType = FileTraits::kRecordEnabled + 1;
const unsigned int FileTraits::kRunDetectorMask = FileTraits::kRunTriggerType + 1;
//
const unsigned int FileTraits::kCalibrationDetectorId = FileTraits::kRunDetectorMask + 1;
const unsigned int FileTraits::kCalibrationAxis = FileTraits::kCalibrationDetectorId + 1;
const unsigned int FileTraits::kCalibrationSourceId = FileTraits::kCalibrationAxis + 1;
const unsigned int FileTraits::kCalibrationZPosition = FileTraits::kCalibrationSourceId + 1;
const unsigned int FileTraits::kCalibrationDuration = FileTraits::kCalibrationZPosition + 1;
const unsigned int FileTraits::kCalibrationLedFrequency = FileTraits::kCalibrationDuration + 1;
const unsigned int FileTraits::kCalibrationLtbMode = FileTraits::kCalibrationLedFrequency + 1;
//
const unsigned int FileTraits::kBlockNumber = FileTraits::kCalibrationLtbMode + 1;
const unsigned int FileTraits::kBlockLength = FileTraits::kBlockNumber + 1;
//
const unsigned int FileTraits::kFileCloseDate = FileTraits::kBlockLength + 1;
const unsigned int FileTraits::kFileCloseTime = FileTraits::kFileCloseDate + 1;
const unsigned int FileTraits::kFileEventCount = FileTraits::kFileCloseTime + 1;
const unsigned int FileTraits::kFilePayloadSize = FileTraits::kFileEventCount + 1;
const unsigned int FileTraits::kRunEventCount = FileTraits::kFilePayloadSize + 1;
const unsigned int FileTraits::kRunPayloadSize = FileTraits::kRunEventCount + 1;
const unsigned int FileTraits::kFileEndStatus = FileTraits::kRunPayloadSize + 1;
const unsigned int FileTraits::kEndFileMarker = FileTraits::kFileEndStatus + 1;

// New in v0_7

const unsigned int FileTraits::kCalibrationAdNumber = FileTraits::kEndFileMarker + 1;
const unsigned int FileTraits::kCalibrationLedNumber1 = FileTraits::kCalibrationAdNumber + 1;
const unsigned int FileTraits::kCalibrationLedNumber2 = FileTraits::kCalibrationLedNumber1 + 1;
const unsigned int FileTraits::kCalibrationLedVoltage1 = FileTraits::kCalibrationLedNumber2 + 1;
const unsigned int FileTraits::kCalibrationLedVoltage2 = FileTraits::kCalibrationLedVoltage1 + 1;
const unsigned int FileTraits::kCalibrationLedPulseSeparation = FileTraits::kCalibrationLedVoltage2 + 1;

// New in v0_8

const unsigned int FileTraits::kCalibrationSourceIdA = FileTraits::kCalibrationLedPulseSeparation + 1;
const unsigned int FileTraits::kCalibrationZPositionA = FileTraits::kCalibrationSourceIdA + 1;
const unsigned int FileTraits::kCalibrationSourceIdB = FileTraits::kCalibrationZPositionA + 1;
const unsigned int FileTraits::kCalibrationZPositionB = FileTraits::kCalibrationSourceIdB + 1;
const unsigned int FileTraits::kCalibrationSourceIdC = FileTraits::kCalibrationZPositionB + 1;
const unsigned int FileTraits::kCalibrationZPositionC = FileTraits::kCalibrationSourceIdC + 1;
const unsigned int FileTraits::kCalibrationMotorPower = FileTraits::kCalibrationZPositionC + 1;
const unsigned int FileTraits::kCalibrationCameraPower = FileTraits::kCalibrationMotorPower + 1;
const unsigned int FileTraits::kCalibrationLedFlashing = FileTraits::kCalibrationCameraPower + 1;

// New in v0_9

const unsigned int FileTraits::kCalibrationHomeA = FileTraits::kCalibrationCameraPower + 1;
const unsigned int FileTraits::kCalibrationHomeB = FileTraits::kCalibrationHomeA + 1;
const unsigned int FileTraits::kCalibrationHomeC = FileTraits::kCalibrationHomeB + 1;

static const unsigned int kLengthOfDateTime = 25;
static std::map<const char*, FileTraits*> m_allTraits;

FileTraits::FileTraits() {
}

FileTraits::~FileTraits() {
}

const FileTraits& FileTraits::defaultTraits() {
    if (0 == m_allTraits.size()) {
        m_allTraits.insert(std::pair<const char*, FileTraits*>(FileTraits_v0_6::key(),new FileTraits_v0_6()));
        m_allTraits.insert(std::pair<const char*, FileTraits*>(FileTraits_v0_7::key(),new FileTraits_v0_7()));
        m_allTraits.insert(std::pair<const char*, FileTraits*>(FileTraits_v0_8::key(),new FileTraits_v0_8()));
        m_allTraits.insert(std::pair<const char*, FileTraits*>(FileTraits_v0_9::key(),new FileTraits_v0_9()));
    }
    return *m_allTraits[FileTraits_v0_9::key()];
}

const FileTraits* FileTraits::readTraits(const char*& buffer) {
    const FileTraits& traits = defaultTraits(); 
    const unsigned int major = readUnsignedInt(buffer,
                                               traits,
                                               kMajorVersion);
    const unsigned int minor = readUnsignedInt(buffer,
                                               traits,
                                               kMinorVersion);
    const FileTraits* result = 0;
    if (0U == major && 6U == minor) {
        result = m_allTraits[FileTraits_v0_6::key()];
    } else if (0U == major && 7U == minor) {
        result = m_allTraits[FileTraits_v0_7::key()];
    } else if (0U == major && 8U == minor) {
        result = m_allTraits[FileTraits_v0_8::key()];
    } else if (0U == major && 9U == minor) {
        result = m_allTraits[FileTraits_v0_9::key()];
    }
    return result;
}

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

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

unsigned int FileTraits::recordSize(unsigned int marker) const {
        if (marker >= markersEnd()) {
                return 0U;
        }
        return recordSizes()[marker];
}

const FileTraits::DetectorList* FileTraits::detectorList(const unsigned int mask) const {
    DetectorList* result = new DetectorList();
    unsigned int bit = 1;
    for (unsigned int line = 0; line != detectorListEnd(); ++ line) {
        if (mask & bit) {
            result->push_back(detectorAsString(line));
        }
        bit = bit << 1;
    }
    return result;
}

const char* FileTraits::detectorAsString(unsigned int line) const {
        if (line >= detectorListEnd()) {
                return "Unknown";
        }
    return detectorStrings()[line];
}

const string FileTraits::dateTimeAsString(const FileDateTime& time) const {
    char* dateTime = new char[kLengthOfDateTime];
    if (0 == strftime(dateTime,
                      kLengthOfDateTime,
                      "%Y-%m-%dT%H:%M:%S+0800",
                      &time)) {
        return "0000-00-00T00:00:00+0800";
    };
    dateTime[kLengthOfDateTime - 1] = 0;
    string result(dateTime);
    delete dateTime;
    return result;
}

const FileTraits::FileDateTime* FileTraits::makeDateTime(const time_t& time) const {
    FileDateTime* result = new FileDateTime(*(gmtime(&time)));
    return result;
}

unsigned int FileTraits::firstNameLengthOffset() const {
    return index(FileTraits::kFirstNameLength);
}

unsigned int FileTraits::firstMetadataLengthOffset() const {
    return index(FileTraits::kFirstMetadataLength);
}

---