TrackerValueDesc.h

Go to the documentation of this file.

/****************************************************************************/
// Representation of a timeline of floats with their names and moments
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef TrackerValueDesc_h
#define TrackerValueDesc_h
// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <fx.h>
#include <string>
#include <vector>
#include <utils/foxtools/MFXMutex.h>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/ValueRetriever.h>


// ===========================================================================
// class definitions
// ===========================================================================
class TrackerValueDesc : public ValueRetriever<SUMOReal> {
public:
    TrackerValueDesc(const std::string& name, const RGBColor& col,
                     SUMOTime recordBegin);

    ~TrackerValueDesc();

    SUMOReal getRange() const;

    SUMOReal getMin() const;

    SUMOReal getMax() const;

    SUMOReal getYCenter() const;

    const RGBColor& getColor() const;

    const std::vector<SUMOReal> &getValues();

    const std::vector<SUMOReal> &getAggregatedValues();

    const std::string& getName() const;

    void addValue(SUMOReal value);

    void unlockValues();

    void setAggregationSpan(SUMOTime as);

    SUMOTime getAggregationSpan() const;

    SUMOTime getRecordingBegin() const;


private:
    std::string myName;

    RGBColor myActiveCol;

    RGBColor myInactiveCol;

    std::vector<SUMOReal> myValues;

    std::vector<SUMOReal> myAggregatedValues;

    SUMOReal myMin, myMax;

    // Mutex to avoid parallel drawing and insertion of new items
    MFXMutex myLock;

    int myAggregationInterval;

    SUMOReal myInvalidValue;

    size_t myValidNo;

    SUMOTime myRecordingBegin;

    SUMOReal myTmpLastAggValue;

};


#endif

/****************************************************************************/