Report

class Report

Handles the gathering of data for a particular report into a buffer

Public Fields
Report* next: Pointer to next report object
Report* prev: Pointer to previous report object
void* RI: Info used by output code
int RptID: Unique identifier of report - same over all nodes
int ReportOn: Code for 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 first interval of a report period
int iTime: Currently active time interval
int nTimes: Number of time intervals
int* TStart: List of times at which reporting should start or restart if it has been stopped
int* TStop: List of times at which reporting should stop if it is currently active
int Freq: Report is done every Freq timesteps
int FreqCounter: Keeps track of when enough time has elapsed
int nThings: Number of things to report on that are on this node
int ThingSize: Size of things per ID in header
int* ThingIDs: List of IDs of things, for writing report headers
char** ThingList: List of pointers to things to report on
char* RptBuf: base of report buffer
char* RptPtr: where within RptBuf this node's data will be written

Public Methods
void (Report::*Func)(): Function pointer to the appropriate function which will be used when a report is made
Report(T_REPORT *, int, char *, Random *): Constructor used when making report object from input file
~Report(): Destructor
void MakeCmpHdr(T_REPORT *, Random *): Creates the file header for reports on compartments
void MakeChanHdr(T_REPORT *, int, Random *): Creates the file header for reports on channels
void MakeUSEHdr(T_REPORT *, Random *): Creates the file header for reports on synapse USE
bool DoReport(int): Executes the appropriate reporting function using the function pointer Func
void GetVoltage(): Function used for reporting compartment voltage
void GetNetCurrent(): Function used for reporting compartment net current
void GetStimCurrent(): Function used for reporting compartment stimulus current
void GetSynCurrent(): Function used for reporting compartment Synapse current
void GetLeakCurrent(): Function used for reporting compartment current Leak
void GetAdjCurrent(): Function used for reporting Adjacent compartment current
void GetChanCurrent(): Function used for reporting compartment channel current
void GetChanValues(): Function used for reporting channel values
void GetUSEValues(): Function used for reporting synapse USE values
void EmptyFunc(): Default function

Documentation

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. Note that the object must exist on the IONode, even if there are no reporting cells on that node.

Report* next