class CurrentSource

Overview

#include <currentSource.h>

class CurrentSource
{
public:
    // methods

    CurrentSource(const CurrentSource&);
    CurrentSource();
    void setVarLocation(const std::string& varName, VarLocation loc);
    void setExtraGlobalParamLocation(const std::string& paramName, VarLocation loc);
    const std::string& getName() const;
    const CurrentSourceModels::Base* getCurrentSourceModel() const;
    const std::vector<double>& getParams() const;
    const std::vector<Models::VarInit>& getVarInitialisers() const;
    VarLocation getVarLocation(const std::string& varName) const;
    VarLocation getVarLocation(size_t index) const;
    VarLocation getExtraGlobalParamLocation(const std::string& paramName) const;
    VarLocation getExtraGlobalParamLocation(size_t index) const;
};

// direct descendants

class CurrentSourceInternal;

Detailed Documentation

Methods

void setVarLocation(const std::string& varName, VarLocation loc)

Set location of current source state variable.

void setExtraGlobalParamLocation(const std::string& paramName, VarLocation loc)

Set location of extra global parameter.

This is ignored for simulations on hardware with a single memory space and only applies to extra global parameters which are pointers.

const CurrentSourceModels::Base* getCurrentSourceModel() const

Gets the current source model used by this group.

VarLocation getVarLocation(const std::string& varName) const

Get variable location for current source model state variable.

VarLocation getVarLocation(size_t index) const

Get variable location for current source model state variable.

VarLocation getExtraGlobalParamLocation(const std::string& paramName) const

Get location of neuron model extra global parameter by name.

This is only used by extra global parameters which are pointers

VarLocation getExtraGlobalParamLocation(size_t index) const

Get location of neuron model extra global parameter by omdex.

This is only used by extra global parameters which are pointers