struct T_REPORT

Intermediate Report object

int idx
Unique ID for Report Object
char* name
Pointer to object string name
long Seed
Seed to be used for random number generator
int Column
Index (ID) of the Column being reported on
int Layer
Index (ID) of the Layer being reported on
int Cell
Index (ID) of the Cell type being reported on
int Cmp
Index (ID) of the Compartment being reported on
int Synapse
Index (ID) of the Synapse being reported on
char* FileName
Destination File
int ReportOn
Type of report
int ASCII
Flag to designate destination file's data encoding method
int Port
Number of the socket port to send data to
double Probability
The probability of a cell(?) contributing data to the report
unsigned int Frequency
The frequency of reporting in timesteps(?)
int nTimes
The number of separate reporting spans
int* Time_Start
Array of start times for the report with length = nTimes
int* Time_Stop
Array of stop time for the report with length = nTimes

Documentation

Intermediate Report object. Created from temporary report objects made from parsing the input file. Used during final brain creation stage to generate the final report objects used during the simulation. Reports gather information during a simulation on a particular column, layer, cell, compartment combination.
int idx
Unique ID for Report Object

char* name
Pointer to object string name. Assigned to the original report object created during the input file parse stage.

long Seed
Seed to be used for random number generator

int Column
Index (ID) of the Column being reported on. Index refers to the T_COLUMN array inside the Arrays object.

int Layer
Index (ID) of the Layer being reported on. Index refers to the T_LAYER array inside the Arrays object.

int Cell
Index (ID) of the Cell type being reported on. Index refers to the T_CELL array inside the Arrays object.

int Cmp
Index (ID) of the Compartment being reported on. Index refers to the T_COMPART array inside the Arrays object.

int Synapse
Index (ID) of the Synapse being reported on. Index refers to the T_SYNAPSE array inside the Arrays object.

char* FileName
Destination File. The report should write data gathered during the simulation to the file name specified.

int ReportOn
Type of report. This report will collect data on a particular parameter of the simulation such as Compartment Voltage. This parameter will be what is written to the report file.

int ASCII
Flag to designate destination file's data encoding method. Reports can write the data gathered to files in either ASCII or binary format.

int Port
Number of the socket port to send data to. Reports can write the data gathered to a socket connection at the port number specified.

double Probability
The probability of a cell(?) contributing data to the report. Greater probability results in more cells(?) being a part of the report. A probability of one (1) means that all cells will be included in the report.

unsigned int Frequency
The frequency of reporting in timesteps(?). Data can be gathered at a specific interval rather than at every timestep. If frequency is set to 1, data is gathered at every timestep. If frequency is set to 2, data is gathered at every other timestep. etc.

int nTimes
The number of separate reporting spans. Reports may start and stop gathering data at various times during the simulation.

int* Time_Start
Array of start times for the report with length = nTimes. A report may start gathering data at various times during the simulation. Start times are expected to be sequential.

int* Time_Stop
Array of stop time for the report with length = nTimes. A report may stop gathering data at various times during a simuluation. Stop times are expected to be sequential.

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