currentSource.h

Go to the documentation of this file.

#pragma once

// Standard includes
#include <map>
#include <set>
#include <string>
#include <vector>

// GeNN includes
#include "global.h"
#include "currentSourceModels.h"
#include "variableMode.h"

//------------------------------------------------------------------------
// CurrentSource
//------------------------------------------------------------------------
class CurrentSource
{
public:
    CurrentSource(const std::string &name, const CurrentSourceModels::Base *currentSourceModel,
                const std::vector<double> &params, const std::vector<NewModels::VarInit> &varInitialisers) :
        m_Name(name),
        m_CurrentSourceModel(currentSourceModel), m_Params(params), m_VarInitialisers(varInitialisers),
        m_VarMode(varInitialisers.size(), GENN_PREFERENCES::defaultVarMode)
    {
    }
    CurrentSource(const CurrentSource&) = delete;
    CurrentSource() = delete;

    //------------------------------------------------------------------------
    // Public methods
    //------------------------------------------------------------------------


    void setVarMode(const std::string &varName, VarMode mode);

    void initDerivedParams(double dt);

    //------------------------------------------------------------------------
    // Public const methods
    //------------------------------------------------------------------------
    const std::string &getName() const{ return m_Name; }

    const CurrentSourceModels::Base *getCurrentSourceModel() const{ return m_CurrentSourceModel; }

    const std::vector<double> &getParams() const{ return m_Params; }
    const std::vector<double> &getDerivedParams() const{ return m_DerivedParams; }
    const std::vector<NewModels::VarInit> &getVarInitialisers() const{ return m_VarInitialisers; }

    VarMode getVarMode(const std::string &varName) const;

    VarMode getVarMode(size_t index) const{ return m_VarMode[index]; }

    void addExtraGlobalParams(std::map<std::string, std::string> &kernelParameters) const;

    bool isInitCodeRequired() const;

    bool isSimRNGRequired() const;

    bool isInitRNGRequired(VarInit varInitMode) const;

    bool isDeviceVarInitRequired() const;


    bool canRunOnCPU() const;

private:
    //------------------------------------------------------------------------
    // Members
    //------------------------------------------------------------------------
    std::string m_Name;

    const CurrentSourceModels::Base *m_CurrentSourceModel;
    std::vector<double> m_Params;
    std::vector<double> m_DerivedParams;
    std::vector<NewModels::VarInit> m_VarInitialisers;

    std::vector<VarMode> m_VarMode;
};