tracing_node.h

/*
 * This file is part of SPORE.
 *
 * Copyright (C) 2016, the SPORE team (see AUTHORS).
 *
 * SPORE 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.
 *
 * SPORE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with SPORE.  If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information see: https://github.com/IGITUGraz/spore-nest-module
 *
 * File:   tracing_node.h
 * Author: Kappel
 *
 * Created on November 3, 2016, 2:07 PM
 */

#ifndef TRACING_NODE_H
#define TRACING_NODE_H

#include <vector>
#include <deque>

#include "nest.h"
#include "event.h"
#include "node.h"

#include "circular_buffer.h"
#include "connection_updater.h"


namespace spore
{

class TracingNode : public nest::Node
{
public:
    typedef CircularBuffer<double>::const_iterator const_iterator;
    typedef size_t trace_id;

    TracingNode();
    virtual ~TracingNode();

    virtual void get_status(DictionaryDatum& d) const;
    virtual void set_status(const DictionaryDatum& d);

    void get_trace_status(DictionaryDatum& d) const;

    inline
    const_iterator get_trace(nest::delay steps, trace_id id) const
    {
        assert(id < traces_.size());
        return traces_[id].get(steps);
    };

    inline
    const_iterator get_trace(nest::Time const& time, trace_id id) const
    {
        return get_trace(time.get_steps(), id);
    };

    inline
    size_t get_num_traces() const
    {
        return traces_.size();
    };

protected:
    void init_traces(size_t num_traces);

    void set_trace(nest::delay steps, double v, trace_id id = 0)
    {
        assert(id < traces_.size());
        traces_[id][steps] = v;
    }

private:
    std::vector< CircularBuffer<double> > traces_;
};

}

#endif