HistoryManager.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* ngscopeclient                                                                                                        *
*                                                                                                                      *
* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef HistoryManager_h
#define HistoryManager_h
 
#include "Marker.h"
 
//Waveform history for a single instrument
typedef std::map<StreamDescriptor, WaveformBase*> WaveformHistory;
 
class HistoryPoint
{
public:
    HistoryPoint();
    ~HistoryPoint();
 
    bool IsInUse();
 
    TimePoint m_time;
 
    bool m_pinned;
 
    std::string m_nickname;
 
    std::map<std::shared_ptr<Oscilloscope>, WaveformHistory> m_history;
 
    void LoadHistoryToSession(Session& session);
};
 
class HistoryManager
{
public:
    HistoryManager(Session& session);
    ~HistoryManager();
 
    bool OnMemoryPressure(MemoryPressureLevel level, MemoryPressureType type, size_t requestedSize);
 
    void AddHistory(
        const std::vector<std::shared_ptr<Oscilloscope>>& scopes,
        bool deleteOld = true,
        bool pin = false,
        std::string nick = "",
        TimePoint refTimeIfNoWaveforms = TimePoint(0, 0));
 
    void LoadEmptyHistoryToSession(Session& session);
 
    bool empty();
 
    void SetMaxToCurrentDepth()
    { m_maxDepth = m_history.size(); }
 
    std::shared_ptr<HistoryPoint> GetHistory(TimePoint t);
 
    bool HasHistory(TimePoint t);
 
    TimePoint GetMostRecentPoint();
 
    void clear()
    { m_history.clear(); }
 
    std::list<std::shared_ptr<HistoryPoint>> m_history;
 
    int m_maxDepth;
 
protected:
    Session& m_session;
};
 
#endif