GeNN  4.9.0
GPU enhanced Neuronal Networks (GeNN)
NeuronModels::SpikeSource Class Reference

Empty neuron which allows setting spikes from external sources. More...

#include <neuronModels.h>

Inheritance diagram for NeuronModels::SpikeSource:
NeuronModels::Base Models::Base Snippet::Base

Public Types

typedef Snippet::ValueBase< 0 > ParamValues
 
typedef Models::VarInitContainerBase< 0 > VarValues
 
typedef Models::VarInitContainerBase< 0 > PreVarValues
 
typedef Models::VarInitContainerBase< 0 > PostVarValues
 
- Public Types inherited from Models::Base
typedef std::vector< VarVarVec
 
typedef std::vector< VarRefVarRefVec
 
typedef std::vector< EGPRefEGPRefVec
 
- Public Types inherited from Snippet::Base
typedef std::vector< std::string > StringVec
 
typedef std::vector< EGPEGPVec
 
typedef std::vector< ParamValParamValVec
 
typedef std::vector< DerivedParamDerivedParamVec
 

Public Member Functions

virtual std::string getThresholdConditionCode () const override
 Gets code which defines the condition for a true spike in the described neuron model. More...
 
 SET_NEEDS_AUTO_REFRACTORY (false)
 
- Public Member Functions inherited from NeuronModels::Base
virtual std::string getSimCode () const
 Gets the code that defines the execution of one timestep of integration of the neuron model. More...
 
virtual std::string getResetCode () const
 Gets code that defines the reset action taken after a spike occurred. This can be empty. More...
 
virtual std::string getSupportCode () const
 Gets support code to be made available within the neuron kernel/funcion. More...
 
virtual Models::Base::ParamValVec getAdditionalInputVars () const
 
virtual bool isAutoRefractoryRequired () const
 Does this model require auto-refractory logic? More...
 
boost::uuids::detail::sha1::digest_type getHashDigest () const
 Update hash from model. More...
 
void validate () const
 Validate names of parameters etc. More...
 
- Public Member Functions inherited from Models::Base
virtual VarVec getVars () const
 Gets names and types (as strings) of model variables. More...
 
size_t getVarIndex (const std::string &varName) const
 Find the index of a named variable. More...
 
- Public Member Functions inherited from Snippet::Base
virtual ~Base ()
 
virtual StringVec getParamNames () const
 Gets names of of (independent) model parameters. More...
 
virtual DerivedParamVec getDerivedParams () const
 
virtual EGPVec getExtraGlobalParams () const
 
size_t getExtraGlobalParamIndex (const std::string &paramName) const
 Find the index of a named extra global parameter. More...
 

Static Public Member Functions

static const NeuronModels::SpikeSourcegetInstance ()
 

Additional Inherited Members

- Protected Member Functions inherited from Models::Base
void updateHash (boost::uuids::detail::sha1 &hash) const
 
void validate () const
 Validate names of parameters etc. More...
 
- Protected Member Functions inherited from Snippet::Base
void updateHash (boost::uuids::detail::sha1 &hash) const
 
void validate () const
 Validate names of parameters etc. More...
 
- Static Protected Member Functions inherited from Snippet::Base
template<typename T >
static size_t getNamedVecIndex (const std::string &name, const std::vector< T > &vec)
 

Detailed Description

Empty neuron which allows setting spikes from external sources.

This model does not contain any update code and can be used to implement the equivalent of a SpikeGeneratorGroup in Brian or a SpikeSourceArray in PyNN.

Member Typedef Documentation

◆ ParamValues

◆ PostVarValues

◆ PreVarValues

◆ VarValues

Member Function Documentation

◆ getInstance()

static const NeuronModels::SpikeSource* NeuronModels::SpikeSource::getInstance ( )
inlinestatic

◆ getThresholdConditionCode()

virtual std::string NeuronModels::SpikeSource::getThresholdConditionCode ( ) const
inlineoverridevirtual

Gets code which defines the condition for a true spike in the described neuron model.

This evaluates to a bool (e.g. "V > 20").

Reimplemented from NeuronModels::Base.

◆ SET_NEEDS_AUTO_REFRACTORY()

NeuronModels::SpikeSource::SET_NEEDS_AUTO_REFRACTORY ( false  )

The documentation for this class was generated from the following file: