muadata.hpp

// ---------------------------------------------------------------------
// This file is part of falcon-core.
//
// Copyright (C) 2015, 2016, 2017 Neuro-Electronics Research Flanders
//
// Falcon-server 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 3 of the License, or
// (at your option) any later version.
//
// Falcon-server 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 falcon-core. If not, see <http://www.gnu.org/licenses/>.
// ---------------------------------------------------------------------
 
#pragma once
 
#include <string>
 
#include "idata.hpp"
 
namespace nsMUAType {
 
using ParentType = AnyType;
 
struct Parameters {
    Parameters(double bin = 0) : bin_size(bin) {}
    double bin_size;
};
 
class Data : public IData<Data, ParentType> {
   public:
    using BaseClass = IData<Data, ParentType>;
    Data(double bin_size);
    Data(const Parameters& parameters);
 
    static const std::string static_datatype() { return "mua"; }
    static const std::string static_dataname() { return "mua"; }
 
    Parameters parameters() const { return Parameters(bin_size_); }
 
    void ClearData();
    void set_n_spikes(unsigned int n_spikes);
    double mua() const;
    void set_bin_size(double bin_size);
    double bin_size() const;
    unsigned int n_spikes();
 
    void SerializeBinary(std::ostream& stream,
                         Serialization::Format format = Serialization::Format::FULL) const;
 
    void SerializeYAML(YAML::Node& node,
                       Serialization::Format format = Serialization::Format::FULL) const;
 
    void YAMLDescription(YAML::Node& node,
                         Serialization::Format format = Serialization::Format::FULL) const;
 
    void SerializeFlatBuffer(flexbuffers::Builder& flex_builder);
 
   protected:
    double bin_size_;  // in ms
    unsigned int n_spikes_;
};
 
using Capabilities = ParentType::Capabilities;
 
}  // namespace nsMUAType
 
using MUAType =
    DefineType<nsMUAType::Data, AnyType, true, nsMUAType::Capabilities, nsMUAType::Parameters>;