class NeuronGroup¶
Overview¶
#include <neuronGroup.h> class NeuronGroup { public: // methods NeuronGroup(const NeuronGroup&); NeuronGroup(); void setSpikeLocation(VarLocation loc); void setSpikeEventLocation(VarLocation loc); void setSpikeTimeLocation(VarLocation loc); void setVarLocation(const std::string& varName, VarLocation loc); void setExtraGlobalParamLocation(const std::string& paramName, VarLocation loc); const std::string& getName() const; unsigned int getNumNeurons() const; const NeuronModels::Base* getNeuronModel() const; const std::vector<double>& getParams() const; const std::vector<Models::VarInit>& getVarInitialisers() const; int getClusterHostID() const; bool isSpikeTimeRequired() const; bool isTrueSpikeRequired() const; bool isSpikeEventRequired() const; unsigned int getNumDelaySlots() const; bool isDelayRequired() const; bool isZeroCopyEnabled() const; VarLocation getSpikeLocation() const; VarLocation getSpikeEventLocation() const; VarLocation getSpikeTimeLocation() 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; bool isSimRNGRequired() const; bool isInitRNGRequired() const; bool hasOutputToHost(int targetHostID) const; }; // direct descendants class NeuronGroupInternal;
Detailed Documentation¶
Methods¶
void setSpikeLocation(VarLocation loc)
Set location of this neuron group’s output spikes.
This is ignored for simulations on hardware with a single memory space
void setSpikeEventLocation(VarLocation loc)
Set location of this neuron group’s output spike events.
This is ignored for simulations on hardware with a single memory space
void setSpikeTimeLocation(VarLocation loc)
Set location of this neuron group’s output spike times.
This is ignored for simulations on hardware with a single memory space
void setVarLocation(const std::string& varName, VarLocation loc)
Set variable location of neuron model state variable.
This is ignored for simulations on hardware with a single memory space
void setExtraGlobalParamLocation(const std::string& paramName, VarLocation loc)
Set location of neuron model 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.
unsigned int getNumNeurons() const
Gets number of neurons in group.
const NeuronModels::Base* getNeuronModel() const
Gets the neuron model used by this group.
VarLocation getSpikeLocation() const
Get location of this neuron group’s output spikes.
VarLocation getSpikeEventLocation() const
Get location of this neuron group’s output spike events.
VarLocation getSpikeTimeLocation() const
Get location of this neuron group’s output spike times.
VarLocation getVarLocation(const std::string& varName) const
Get location of neuron model state variable by name.
VarLocation getVarLocation(size_t index) const
Get location of neuron model state variable by index.
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
bool isSimRNGRequired() const
Does this neuron group require an RNG to simulate?
bool isInitRNGRequired() const
Does this neuron group require an RNG for it’s init code?
bool hasOutputToHost(int targetHostID) const
Does this neuron group have outgoing connections specified host id?