cypress::NeuronType Class Reference

#include <neurons_base.hpp>

Inheritance diagram for cypress::NeuronType:

Collaboration diagram for cypress::NeuronType:

Public Member Functions
	NeuronType (const NeuronType &)=delete
	NeuronType (NeuronType &&)=delete
NeuronType &	operator= (const NeuronType &)=delete
NeuronType &	operator= (NeuronType &&)=delete
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< Real >	parameter_defaults
const std::vector< std::string >	signal_names
const std::vector< std::string >	signal_units
const bool	conductance_based
const bool	spike_source

Protected Member Functions
	NeuronType (const std::string &name, const std::vector< std::string > &parameter_names, const std::vector< std::string > &parameter_units, const std::vector< Real > &parameter_defaults, const std::vector< std::string > &signal_names, const std::vector< std::string > &signal_units, bool conductance_based, bool spike_source)

Detailed Description

The NeuronType class contains data describing an individual neuron type and its parameters.

Constructor & Destructor Documentation

cypress::NeuronType::NeuronType ( const std::string &  name, const std::vector< std::string > &  parameter_names, const std::vector< std::string > &  parameter_units, const std::vector< Real > &  parameter_defaults, const std::vector< std::string > &  signal_names, const std::vector< std::string > &  signal_units, bool  conductance_based, bool  spike_source  )

inlineprotected

Constructor of the NeuronTypeDescriptor structure.

cypress::NeuronType::NeuronType ( const NeuronType &  )

delete

cypress::NeuronType::NeuronType ( NeuronType &&  )

delete

Member Function Documentation

NeuronType& cypress::NeuronType::operator= ( const NeuronType &  )

delete

NeuronType& cypress::NeuronType::operator= ( NeuronType &&  )

delete

Optional<size_t> cypress::NeuronType::parameter_index

(

const std::string &

name

)

const

Resolves the given parameter name into a parameter index.

Optional<size_t> cypress::NeuronType::signal_index

(

const std::string &

name

)

const

Resolves the given signal name into a signel index.

Member Data Documentation

const bool cypress::NeuronType::conductance_based

True if this is a conductance based neuron.

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

Name of the neuron type.

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

Contains default values for the neuron parameters.

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

Name of all neuron parameters.

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

Units of all neuron parameters.

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

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

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

Units of the signals listed in the signal_names vector.

const bool cypress::NeuronType::spike_source

True if this neuron type represents a spike source.

---

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

• cypress/core/neurons_base.hpp