CurrentSource Class Reference

#include <currentSource.h>

Public Member Functions
	CurrentSource (const std::string &name, const CurrentSourceModels::Base *currentSourceModel, const std::vector< double > &params, const std::vector< NewModels::VarInit > &varInitialisers)
	CurrentSource (const CurrentSource &)=delete
	CurrentSource ()=delete
void	setVarMode (const std::string &varName, VarMode mode)
	Set variable mode of neuron model state variable. More...
void	initDerivedParams (double dt)
const std::string &	getName () const
const CurrentSourceModels::Base *	getCurrentSourceModel () const
	Gets the current source model used by this group. More...
const std::vector< double > &	getParams () const
const std::vector< double > &	getDerivedParams () const
const std::vector< NewModels::VarInit > &	getVarInitialisers () const
VarMode	getVarMode (const std::string &varName) const
	Get variable mode used by current source model state variable. More...
VarMode	getVarMode (size_t index) const
	Get variable mode used by current source model state variable. More...
void	addExtraGlobalParams (std::map< std::string, std::string > &kernelParameters) const
bool	isInitCodeRequired () const
	Does this current source require any initialisation code to be run. More...
bool	isSimRNGRequired () const
	Does this current source require an RNG to simulate. More...
bool	isInitRNGRequired (VarInit varInitMode) const
	Does this current source group require an RNG for it's init code. More...
bool	isDeviceVarInitRequired () const
	Is device var init code required for any variables in this current source. More...
bool	canRunOnCPU () const
	Can this current source run on the CPU? More...

Constructor & Destructor Documentation

CurrentSource() [1/3]

CurrentSource::CurrentSource ( const std::string &  name, const CurrentSourceModels::Base *  currentSourceModel, const std::vector< double > &  params, const std::vector< NewModels::VarInit > &  varInitialisers  )

inline

CurrentSource() [2/3]

CurrentSource::CurrentSource ( const CurrentSource &  )

delete

CurrentSource() [3/3]

CurrentSource::CurrentSource ( )

delete

Member Function Documentation

addExtraGlobalParams()

void CurrentSource::addExtraGlobalParams

(

std::map< std::string, std::string > &

kernelParameters

)

const

canRunOnCPU()

bool CurrentSource::canRunOnCPU

(

)

const

Can this current source run on the CPU?

If we are running in CPU_ONLY mode this is always true, but some GPU functionality will prevent models being run on both CPU and GPU.

getCurrentSourceModel()

const CurrentSourceModels::Base* CurrentSource::getCurrentSourceModel ( ) const

inline

Gets the current source model used by this group.

getDerivedParams()

const std::vector<double>& CurrentSource::getDerivedParams ( ) const

inline

getName()

const std::string& CurrentSource::getName ( ) const

inline

getParams()

const std::vector<double>& CurrentSource::getParams ( ) const

inline

getVarInitialisers()

const std::vector<NewModels::VarInit>& CurrentSource::getVarInitialisers ( ) const

inline

getVarMode() [1/2]

VarMode CurrentSource::getVarMode

(

const std::string &

varName

)

const

Get variable mode used by current source model state variable.

getVarMode() [2/2]

VarMode CurrentSource::getVarMode ( size_t  index ) const

inline

Get variable mode used by current source model state variable.

initDerivedParams()

void CurrentSource::initDerivedParams

(

double

dt

)

isDeviceVarInitRequired()

bool CurrentSource::isDeviceVarInitRequired

(

)

const

Is device var init code required for any variables in this current source.

isInitCodeRequired()

bool CurrentSource::isInitCodeRequired

(

)

const

Does this current source require any initialisation code to be run.

isInitRNGRequired()

bool CurrentSource::isInitRNGRequired

(

VarInit

varInitMode

)

const

Does this current source group require an RNG for it's init code.

isSimRNGRequired()

bool CurrentSource::isSimRNGRequired

(

)

const

Does this current source require an RNG to simulate.

setVarMode()

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

Set variable mode of neuron model state variable.

This is ignored for CPU simulations

---

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

• currentSource.h
• currentSource.cc