FairWriteoutBuffer.cxx

Go to the documentation of this file.

/********************************************************************************
 *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/
/*
 * FairWriteoutBuffer.cpp
 *
 *  Created on: Jul 30, 2010
 *      Author: stockman
 */

#include "FairWriteoutBuffer.h"

#include "FairLogger.h"        // for FairLogger
#include "FairRootManager.h"   // for FairRootManager

#include <iostream>   // for operator<<, ostream, cout, etc
#include <iterator>   // for reverse_iterator

FairWriteoutBuffer::FairWriteoutBuffer(TString branchName, TString className, TString folderName, Bool_t persistance)
    : TObject()
    , fStartTime_map()
    , fDeadTime_map()
    , fBranchName(branchName)
    , fClassName(className)
    , fTreeSave(true)
    , fActivateBuffering(kTRUE)
    , fVerbose(0)
    , fLogger(FairLogger::GetLogger())
{
    FairRootManager::Instance()->Register(branchName, className, folderName, persistance);
    if (fBranchName == "" || fClassName == "") {
        fTreeSave = false;
    } else {
        fTreeSave = true;
    }
}

void FairWriteoutBuffer::WriteOutData(double time)
{
    if (fActivateBuffering) {
        if (fVerbose > 0) {
            std::cout << "Before removing: ";
            PrintStartTimeMap();
            PrintDeadTimeMap();
        }

        MoveDataFromStartTimeMapToDeadTimeMap(time);

        if (fVerbose > 0) {
            std::cout << "After removing: ";
            PrintStartTimeMap();
            PrintDeadTimeMap();
        }

        WriteOutDataDeadTimeMap(time);

        if (fVerbose > 0) {
            std::cout << "DeadTime map after readout time: " << time << std::endl;
            PrintDeadTimeMap();
        }

    } else {
        FairRootManager::Instance()->GetTClonesArray(fBranchName);
    }
}

void FairWriteoutBuffer::WriteOutDataDeadTimeMap(double time)
{
    FairRootManager* ioman = FairRootManager::Instance();
    std::vector<FairTimeStamp*> data;
    if (fActivateBuffering) {
        if (fVerbose > 0) {
            std::cout << "-I- FairWriteoutBuffer::WriteOutData for time: " << time << std::endl;
        }
        data = GetRemoveOldData(time);
        if (fTreeSave && data.size() > 0) {
            TClonesArray* myArray = ioman->GetTClonesArray(fBranchName);
            if (!myArray) {
                std::cout << "-E- FairWriteoutBuffer::WriteOutData " << fBranchName << " array is not available!"
                          << std::endl;
            }
            if (fVerbose > 0) {
                std::cout << "-I- FairWriteoutBuffer::WriteOutData size: " << data.size() << std::endl;
            }
            for (unsigned int i = 0; i < data.size(); i++) {
                AddNewDataToTClonesArray(data[i]);
                if (fVerbose > 1) {
                    std::cout << i << " : ";
                    data[i]->Print();
                    std::cout << std::endl;
                }
                delete data[i];
            }
        }
    } else {
        ioman->GetTClonesArray(fBranchName);
    }
}

void FairWriteoutBuffer::WriteOutAllData()
{
    double ultimateTime = 0;

    if (fStartTime_map.size() > 0) {
        ultimateTime = fStartTime_map.rbegin()->first + 1;
        MoveDataFromStartTimeMapToDeadTimeMap(ultimateTime);
    }

    if (fDeadTime_map.size() > 0) {
        if (fDeadTime_map.rbegin()->first > ultimateTime) {
            ultimateTime = fDeadTime_map.rbegin()->first + 1;
        }
    }

    if (ultimateTime > 0) {
        WriteOutData(ultimateTime);
    }
}

std::vector<FairTimeStamp*> FairWriteoutBuffer::GetRemoveOldData(double time)
{
    typedef std::multimap<double, FairTimeStamp*>::iterator DTMapIter;
    std::vector<FairTimeStamp*> result;
    for (DTMapIter it = fDeadTime_map.begin(); it != fDeadTime_map.lower_bound(time); ++it) {
        if (fVerbose > 1) {
            std::cout << "-I- GetRemoveOldData: DeadTime: " << it->first << " Data: " << it->second << std::endl;
        }
        result.push_back(it->second);
        EraseDataFromDataMap(it->second);
    }
    fDeadTime_map.erase(fDeadTime_map.begin(), fDeadTime_map.lower_bound(time));
    return result;
}

std::vector<FairTimeStamp*> FairWriteoutBuffer::GetAllData()
{
    return GetRemoveOldData(fDeadTime_map.rbegin()->first + 1);
}

void FairWriteoutBuffer::FillNewData(FairTimeStamp* data, double startTime, double activeTime)
{
    FairTimeStamp* dataClone = static_cast<FairTimeStamp*>(data->Clone());

    if (fActivateBuffering) {
        if (fVerbose > 0) {
            std::cout << "StartTime: " << startTime << std::endl;
        }
        std::pair<double, FairTimeStamp*> timeData(activeTime, dataClone);
        fStartTime_map.insert(std::pair<double, std::pair<double, FairTimeStamp*>>(startTime, timeData));
    } else {
        AddNewDataToTClonesArray(dataClone);
        delete dataClone;
    }
}

void FairWriteoutBuffer::FillDataToDeadTimeMap(FairTimeStamp* data, double activeTime, double startTime)
{
    if (fActivateBuffering) {
        typedef std::multimap<double, FairTimeStamp*>::iterator DTMapIter;
        //    typedef  std::map<FairTimeStamp, double>::iterator DataMapIter;
        if (activeTime < 0)
            activeTime = 0;   // to avoid errors due to wrong (negative) returnvalues of overwritten modify function by
                              // subdetector groups. A negative (-1) aktiveTime already indicate empty data maps!
        double timeOfOldData = FindTimeForData(data);
        // PrintDeadTimeMap();
        if (timeOfOldData > -1) {   // if an older active data object is already present
            if (fVerbose > 1) {
                std::cout << " OldData found! " << timeOfOldData << std::endl;
            }
            if (fVerbose > 1) {
                std::cout << "New Data: " << activeTime << " : " << data << std::endl;
            }
            double currentdeadtime = timeOfOldData;
            FairTimeStamp* oldData;
            bool dataFound = false;

            // PrintDeadTimeMap();
            for (DTMapIter it = fDeadTime_map.lower_bound(currentdeadtime);
                 it != fDeadTime_map.upper_bound(currentdeadtime);
                 ++it) {
                oldData = it->second;
                if (fVerbose > 1) {
                    std::cout << "Check Data: " << it->first << " : " << oldData << std::endl;
                }
                if (oldData->equal(data)) {
                    if (fVerbose > 1) {
                        std::cout << " oldData == data " << std::endl;
                    }
                    if (fVerbose > 1) {
                        std::cout << it->first << " : " << it->second << std::endl;
                    }
                    fDeadTime_map.erase(it);
                    EraseDataFromDataMap(oldData);
                    dataFound = true;
                    break;
                }
            }

            if (dataFound == true) {
                if (timeOfOldData
                    > startTime) {   // if older active data can interference with the new data call modify function
                    std::vector<std::pair<double, FairTimeStamp*>> modifiedData =
                        Modify(std::pair<double, FairTimeStamp*>(currentdeadtime, oldData),
                               std::pair<double, FairTimeStamp*>(activeTime, data));
                    for (unsigned int i = 0; i < modifiedData.size(); i++) {
                        FillDataToDeadTimeMap(modifiedData[i].second,
                                              modifiedData[i].first,
                                              0);   // startTime  = 0 since the Maps are already empty and the startTime
                                                    // therefore doesn't matter anymore
                        if (fVerbose > 1) {
                            std::cout << i << " :Modified Data: " << modifiedData[i].first << " : "
                                      << modifiedData[i].second << std::endl;
                        }
                    }
                } else {                                 // no interference can happen between old hit and new hit
                    AddNewDataToTClonesArray(oldData);   // therefore the old hit is written out
                    fDeadTime_map.insert(
                        std::pair<double, FairTimeStamp*>(activeTime, data));   // and the new hit is stored
                    FillDataMap(data, activeTime);
                }
            } else {
                std::cout << "-E- FairWriteoutBuffer::FillDataToDeadTimeMap: old data present in dataMap but not in "
                             "deadTimeMap!"
                          << std::endl;
            }

        } else {
            if (fVerbose > 1) {
                std::cout << "-I- FairWriteoutBuffer::FillDataToDeadTimeMap Data Inserted: " << activeTime << " : ";
                data->Print();
                std::cout << std::endl;
            }
            fDeadTime_map.insert(std::pair<double, FairTimeStamp*>(activeTime, data));
            FillDataMap(data, activeTime);
        }
    } else {
        AddNewDataToTClonesArray(data);
        delete data;
    }
}

void FairWriteoutBuffer::MoveDataFromStartTimeMapToDeadTimeMap(double time)
{
    typedef std::multimap<double, std::pair<double, FairTimeStamp*>>::iterator startTimeMapIter;

    startTimeMapIter stopTime = fStartTime_map.lower_bound(time);
    for (startTimeMapIter iter = fStartTime_map.begin(); iter != stopTime; ++iter) {
        std::pair<double, FairTimeStamp*> data = iter->second;
        double startTime = iter->first;
        FillDataToDeadTimeMap(data.second, data.first, startTime);
    }
    fStartTime_map.erase(fStartTime_map.begin(), stopTime);
}

void FairWriteoutBuffer::PrintStartTimeMap()
{
    typedef std::multimap<double, std::pair<double, FairTimeStamp*>>::iterator startTimeMapIter;
    std::cout << "StartTimeMap: " << std::endl;
    for (startTimeMapIter iter = fStartTime_map.begin(); iter != fStartTime_map.end(); ++iter) {
        FairTimeStamp* data = iter->second.second;
        std::cout << " | " << iter->first << "/" << data->GetTimeStamp();
    }
    std::cout << " |" << std::endl;
}

void FairWriteoutBuffer::PrintDeadTimeMap()
{
    typedef std::multimap<double, FairTimeStamp*>::iterator DTMapIter;
    std::cout << "DeadTimeMap: " << std::endl;
    for (DTMapIter it = fDeadTime_map.begin(); it != fDeadTime_map.end(); ++it) {
        std::cout << it->first << " / ";
        PrintData(it->second);
        std::cout << std::endl;
    }
    std::cout << std::endl;
}

ClassImp(FairWriteoutBuffer);