TrackerValueDesc.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Representation of a timeline of floats with their names and moments
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/fxheader.h>
#include <string>
#include <vector>
#include <utils/common/RGBColor.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/ValueRetriever.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class TrackerValueDesc : public ValueRetriever<double> {
public:
    TrackerValueDesc(const std::string& name, const RGBColor& col,
                     SUMOTime recordBegin,
                     double aggregationSeconds);
 
    ~TrackerValueDesc();
 
    double getRange() const;
 
    double getMin() const;
 
    double getMax() const;
 
    double getYCenter() const;
 
    const RGBColor& getColor() const;
 
    const std::vector<double>& getValues();
 
    const std::vector<double>& getAggregatedValues();
 
    const std::string& getName() const;
 
    void addValue(double value);
 
    void unlockValues();
 
    void setAggregationSpan(SUMOTime as);
 
    SUMOTime getAggregationSpan() const;
 
    SUMOTime getRecordingBegin() const;
 
 
private:
    std::string myName;
 
    RGBColor myActiveCol;
 
    RGBColor myInactiveCol;
 
    std::vector<double> myValues;
 
    std::vector<double> myAggregatedValues;
 
    double myMin, myMax;
 
    // Mutex to avoid parallel drawing and insertion of new items
    FXMutex myLock;
 
    int myAggregationInterval;
 
    double myInvalidValue;
 
    int myValidNo;
 
    SUMOTime myRecordingBegin;
 
    double myTmpLastAggValue;
 
};