class Cell

This object is a container for the compartments

Public Fields

int CellID
The identifier of the cell on this machine: 0
bool Empty
Flag to indicate if a cell is being used
int idx
This is index of definition in ARRAYS from which the object was created
int nCompartments
Number of compartments within this cell
Compartment** vCompartments
List of compartment pointers

Public Methods

Cell()
default constructor
Cell(unsigned int, int, int, int)
Additional Constructor
~Cell()
Destructor
void DoProcessCell(int)
During each time step, the cell performs actions
void AddMsgsToIncomingQ(Message * )
Messages given to the cell are put into a queue for distribution
void SendOutgoingMsgs(unsigned int)
Send out messages waiting in buffer
void ProcessIncomingMsgs()
Handle Messages waiting in incoming queue
void AddMsgsToOutgoingQ(Message * )
Puts message into outgoing queue
void GiveMsgToCompartment(Message *)
Pass messages to individual compartments
bool IsEmpty()
Indicates whether cell is empty
void SetEmpty(bool)
Set the empty flag on a cell to true or false
bool GetEmpty()
Retreive the status of the empty variable
void SaveSynapseUse()
Used to save only USE value to a file at end of run
Compartment* GetCompartment(int)
Return a pointer to compartment at the array index
void CellStateSave( FILE * )
Save Cell state to file
void CellLoad( FILE *, char *, int )
Load Cell state from file

Documentation

This object is a container for the compartments. Also provides access to the other cells. ALl cell to cell communication first goes thru the cell object, which then distributes it to the child compartments contained within. It is through the cell that the program must loop and it is because of the communications between cells that the neuronal modeling is based. The types of cells included here are: Excitatory (E), and Inhibitory (I) and the types of connections allowed are E->E, E->I, I->E, I->I
int CellID
The identifier of the cell on this machine: 0...nCells - 1. Node and CellID form a unique identifier for this cell

bool Empty
Flag to indicate if a cell is being used. Flag set to true when the cell is 1)not sending to any other cells, or 2)it is not receiving from any other cells

int idx
This is index of definition in ARRAYS from which the object was created

int nCompartments
Number of compartments within this cell

Compartment** vCompartments
List of compartment pointers

Cell()
default constructor

Cell(unsigned int, int, int, int)
Additional Constructor

~Cell()
Destructor

void DoProcessCell(int)
During each time step, the cell performs actions

void AddMsgsToIncomingQ(Message * )
Messages given to the cell are put into a queue for distribution

void SendOutgoingMsgs(unsigned int)
Send out messages waiting in buffer. Messages to be sent out are stored in a buffer and sent out once each timestep.

void ProcessIncomingMsgs()
Handle Messages waiting in incoming queue

void AddMsgsToOutgoingQ(Message * )
Puts message into outgoing queue

void GiveMsgToCompartment(Message *)
Pass messages to individual compartments

bool IsEmpty()
Indicates whether cell is empty. Empty cells are ignored.

void SetEmpty(bool)
Set the empty flag on a cell to true or false

bool GetEmpty()
Retreive the status of the empty variable

void SaveSynapseUse()
Used to save only USE value to a file at end of run. May not be used anymore. May not work, anyways.

Compartment* GetCompartment(int)
Return a pointer to compartment at the array index. Returns NULL if not found

void CellStateSave( FILE * )
Save Cell state to file. Recursively saves internal structures.

void CellLoad( FILE *, char *, int )
Load Cell state from file. Recursively loads internal structures.


This class has no child classes.

alphabetic index hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de