Cypress  1.0
C++ Spiking Neural Network Simulation Framework
Public Types | Public Member Functions | Public Attributes | List of all members
cypress::NeuronTypeBase< Parameters_, Signals_ > Class Template Reference

#include <neurons_base.hpp>

Inheritance diagram for cypress::NeuronTypeBase< Parameters_, Signals_ >:
Inheritance graph
[legend]
Collaboration diagram for cypress::NeuronTypeBase< Parameters_, Signals_ >:
Collaboration graph
[legend]

Public Types

using Parameters = Parameters_
 
using Signals = Signals_
 

Public Member Functions

Optional< size_t > parameter_index (const std::string &name) const
 
Optional< size_t > signal_index (const std::string &name) const
 

Public Attributes

const std::string name
 
const std::vector< std::string > parameter_names
 
const std::vector< std::string > parameter_units
 
const std::vector< Realparameter_defaults
 
const std::vector< std::string > signal_names
 
const std::vector< std::string > signal_units
 
const bool conductance_based
 
const bool spike_source
 

Detailed Description

template<typename Parameters_, typename Signals_>
class cypress::NeuronTypeBase< Parameters_, Signals_ >

Templated class allowing to conveniently build a new neuron type.

Member Typedef Documentation

template<typename Parameters_, typename Signals_>
using cypress::NeuronTypeBase< Parameters_, Signals_ >::Parameters = Parameters_
template<typename Parameters_, typename Signals_>
using cypress::NeuronTypeBase< Parameters_, Signals_ >::Signals = Signals_

Member Function Documentation

Optional<size_t> cypress::NeuronType::parameter_index ( const std::string &  name) const
inherited

Resolves the given parameter name into a parameter index.

Optional<size_t> cypress::NeuronType::signal_index ( const std::string &  name) const
inherited

Resolves the given signal name into a signel index.

Member Data Documentation

const bool cypress::NeuronType::conductance_based
inherited

True if this is a conductance based neuron.

const std::string cypress::NeuronType::name
inherited

Name of the neuron type.

const std::vector<Real> cypress::NeuronType::parameter_defaults
inherited

Contains default values for the neuron parameters.

const std::vector<std::string> cypress::NeuronType::parameter_names
inherited

Name of all neuron parameters.

const std::vector<std::string> cypress::NeuronType::parameter_units
inherited

Units of all neuron parameters.

const std::vector<std::string> cypress::NeuronType::signal_names
inherited

Names of the signals that can be recorded from this neuron.

const std::vector<std::string> cypress::NeuronType::signal_units
inherited

Units of the signals listed in the signal_names vector.

const bool cypress::NeuronType::spike_source
inherited

True if this neuron type represents a spike source.


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