Skip to content

mechanism

This document describes the "mechanism" C++ class. This class describes objects that are mechanisms, and can be used to represent any sort of mechanism or dynamical system that affects compartments, conductances or synapses, or even other mechanisms.

Abstract can contain contained in
yes nothing compartment

Methods

integrate

Function Signature

void integrate() 

Description

This virtual method is a placeholder method of mechanism that does nothing except throw an error. If your mechanism is properly written, this will not be run (and therefore the error will not be thrown) because your mechanism will define a "integrate" method, which will be used instead of this.

Code

Click here to view this method's code


connect

Function Signature

void connect(compartment* comp_) 

Description

This virtual method is a placeholder method of mechanism that does nothing except throw an error. If your mechanism is properly written, this will not be run (and therefore the error will not be thrown) because your mechanism will define a "connect" method, which will be used instead of this.

Code

Click here to view this method's code


connect

Function Signature

void connect(conductance* cond_) 

Description

This virtual method is a placeholder method of mechanism that does nothing except throw an error. If your mechanism is properly written, this will not be run (and therefore the error will not be thrown) because your mechanism will define a "connect" method, which will be used instead of this.

Code

Click here to view this method's code


connect

Function Signature

void connect(synapse* syn_) 

Description

This virtual method is a placeholder method of mechanism that does nothing except throw an error. If your mechanism is properly written, this will not be run (and therefore the error will not be thrown) because your mechanism will define a "connect" method, which will be used instead of this.

Code

Click here to view this method's code


integrateMS

Function Signature

void integrateMS(int k, double V, double Ca) 

Description

This virtual method is a placeholder method of mechanism that does nothing except throw an error. If your mechanism is properly written, this will not be run (and therefore the error will not be thrown) because your mechanism will define a "integrateMS" method, which will be used instead of this.

Code

Click here to view this method's code


init

Function Signature

void init() 

Description

This virtual method is a placeholder initialization method. Initialization methods are called after the model has been constructed, and all components have been connected, but before the model starts the simulation. This is a good place to put code that you need to run once before the simulation.

Code

Click here to view this method's code