Basic Electrophysiology Relacs Plugins  0.9.8
Public Member Functions | List of all members
Stimulus Class Reference

#include <spikingneuron.h>

Inheritance diagram for Stimulus:
Inheritance graph
[legend]
Collaboration diagram for Stimulus:
Collaboration graph
[legend]

Public Member Functions

 Stimulus (void)
 
virtual string name (void) const
 
virtual int dimension (void) const
 
virtual void variables (vector< string > &varnames) const
 
virtual void units (vector< string > &u) const
 
virtual void operator() (double t, double s, double *x, double *dxdt, int n)
 
virtual void init (double *x) const
 
- Public Member Functions inherited from SpikingNeuron
 SpikingNeuron (void)
 
virtual ~SpikingNeuron (void)
 
virtual void conductances (vector< string > &conductancenames) const
 
virtual void conductances (double *g) const
 
virtual string conductanceUnit (void) const
 
virtual void currents (vector< string > &currentnames) const
 
virtual void currents (double *c) const
 
virtual string currentUnit (void) const
 
virtual string inputUnit (void) const
 
virtual void add (void)
 
virtual void notify (void)
 
double gain (void) const
 
double offset (void) const
 
- Public Member Functions inherited from ConfigClass
 ConfigClass (const string &ident, int group=0, int mode=0xffff, int selectmask=0)
 
 ConfigClass (const ConfigClass &C)
 
virtual ~ConfigClass (void)
 
const string & configIdent (void) const
 
void setConfigIdent (const string &ident)
 
int configGroup (void) const
 
void setConfigGroup (int group)
 
int configMode (void) const
 
void setConfigMode (int mode)
 
void addConfigMode (int mode)
 
void delConfigMode (int mode)
 
int configSelectMask (void) const
 
void setConfigSelectMask (int mask)
 
void addConfig (void)
 
void readConfig (void)
 
virtual void readConfig (StrQueue &sq)
 
virtual void saveConfig (ofstream &str)
 
virtual int configSize (void) const
 
virtual void config (void)
 
virtual void preConfig (void)
 

Additional Inherited Members

- Public Types inherited from ConfigClass
enum  Action
 
- Static Public Member Functions inherited from ConfigClass
static void setConfigureClasses (ConfigureClasses *cfg)
 
- Static Public Attributes inherited from SpikingNeuron
static const int ScalingFlag = 16
 
static const int ModelFlag = 32
 
static const int DescriptionFlag = 64
 
- Protected Attributes inherited from SpikingNeuron
double Gain
 
double Offset
 

Detailed Description

[ModelLib] Implementation of SpikingNeuron that just returns the stimulus

Author
Jan Benda

Constructor & Destructor Documentation

Stimulus ( void  )

Member Function Documentation

string name ( void  ) const
virtual

Returns
the name of the model.

Reimplemented from SpikingNeuron.

int dimension ( void  ) const
virtual

Returns
the dimension of the system.
See Also
variables(), operator()()

Implements SpikingNeuron.

Referenced by Stimulus::units(), and Stimulus::variables().

void variables ( vector< string > &  varnames) const
virtual

Parameters
[out]varnamesthe names of each of the dimension() variables. Gating variables (ranging between 0 and 1) should be a single lower-case character, potentials and equivalent potentials a single upper-case character, and concentrations should be in brackets (e.g. [Ca]).
See Also
dimension(), units(), operator()()

Implements SpikingNeuron.

References Stimulus::dimension().

void units ( vector< string > &  u) const
virtual

Parameters
[out]uthe units of the variables returned by variables().
See Also
dimension(), operator()()

Implements SpikingNeuron.

References Stimulus::dimension().

void operator() ( double  t,
double  s,
double *  x,
double *  dxdt,
int  n 
)
virtual

Simply sets the first variable to the stimulus s

x[0] = s;
dxdt[0] = 0.0;

Implements SpikingNeuron.

void init ( double *  x) const
virtual

Initialize the first variable with zero.

Implements SpikingNeuron.


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