class Report

This module handles the gathering of data for a particular report into a buffer.

Public Fields

int idx

Index into ARRAYS struct where this report is defined

Report* next

Linked list pointer to next Report object

Report* prev

Linked list pointer to previous Report object

Output* Out

Pointer to Output Object used to handle the actual writing of data

int ReportOn

Integer Code indicating what this report reports

int family

A sub-code for Channel Reports

bool Opened

True if the report file has been opened

bool Started

True if not start first interval of a report period

int iTime

Index of the active Report time interval (ie.

int nTimes

Number of time intervals

int* TStart

Array of report start times

int* TStop

Array of report stop times

int Freq

A report is made every Freq timesteps

int FreqCounter

Helper variable to keep track of how many timesteps are left until next report

int nThings

Number of things to report on that are on this node

int ThingSize

Size of things per ID in header

void** ThingList

List of pointers to things to report on

void* RptBuf

buffer to which data is copied for output

bool Dynamic

True if the user wants the ability to dynamically add new start/stop times to this report

int currentTime

For synapse Augmentation reports so that if Augmentation has not been updated This timestep, it will update and produce an accurate look at the growth and decay of Augmentation

int* synapseCounts

Array to store the number of synapses each cell owns.

int reportFlag

Options activated by the user.

double spikeMax

The maximum value in a compartment's spikeshape.

Public Methods

void (Report::*Func)()

Pointer to appropriate reporting function

void AllocateBuffer()

This function allocates the buffer where reported data is stored until it is ready to be output into a file.

void GetFireCount()

Go through list of reporting cells, counting the number that have reached the peak of the spikeshape.

Documentation

This module handles the gathering of data for a particular report into a buffer. The buffer is then passed to functions in Output.cpp, which take care of collecting the data from all the nodes, and outputting it to the proper destination. See explanation at end of .cpp file.

int idx

Index into ARRAYS struct where this report is defined

Report* next

Linked list pointer to next Report object

Report* prev

Linked list pointer to previous Report object

Output* Out

Pointer to Output Object used to handle the actual writing of data

int ReportOn

Integer Code indicating what this report reports

int family

A sub-code for Channel Reports

bool Opened

True if the report file has been opened

bool Started

True if not start first interval of a report period

int iTime

Index of the active Report time interval (ie. location within TStart/TStop arrays)

int nTimes

Number of time intervals

int* TStart

Array of report start times

int* TStop

Array of report stop times

int Freq

A report is made every Freq timesteps

int FreqCounter

Helper variable to keep track of how many timesteps are left until next report

int nThings

Number of things to report on that are on this node

int ThingSize

Size of things per ID in header

void** ThingList

List of pointers to things to report on

void* RptBuf

buffer to which data is copied for output

void (Report::*Func)()

Pointer to appropriate reporting function

bool Dynamic

True if the user wants the ability to dynamically add new start/stop times to this report

int currentTime

For synapse Augmentation reports so that if Augmentation has not been updated This timestep, it will update and produce an accurate look at the growth and decay of Augmentation

int* synapseCounts

Array to store the number of synapses each cell owns. When performing synapse reports, users may wish to average each cell's synapses into one value per cell. This array will keep track of how many elements from the ThingList need to be summed and averaged per cell.

int reportFlag

Options activated by the user. A copy of this is stored in the Output object. Current options include: e-notation for ascii reports (1), averaging synapses (2)

double spikeMax

The maximum value in a compartment's spikeshape. For use in Fire Count reports, this is the peak of the spike which indeicates a compartment has fired.

void AllocateBuffer()

This function allocates the buffer where reported data is stored until it is ready to be output into a file. Special cases are handled here where the number of elements in the buffer are not equal to the number of reported objects. For example, channel reports have more values than the cell count, and fire reports reduce down to one value.

void GetFireCount()

Go through list of reporting cells, counting the number that have reached the peak of the spikeshape. Return only that count.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java