group_monitor_core.h

Go to the documentation of this file.

/* * Copyright (c) 2016 Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
*
* 3. The names of its contributors may not be used to endorse or promote
*    products derived from this software without specific prior written
*    permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* *********************************************************************************************** *
* CARLsim
* created by: (MDR) Micah Richert, (JN) Jayram M. Nageswaran
* maintained by:
* (MA) Mike Avery <averym@uci.edu>
* (MB) Michael Beyeler <mbeyeler@uci.edu>,
* (KDC) Kristofor Carlson <kdcarlso@uci.edu>
* (TSC) Ting-Shuo Chou <tingshuc@uci.edu>
* (HK) Hirak J Kashyap <kashyaph@uci.edu>
*
* CARLsim v1.0: JM, MDR
* CARLsim v2.0/v2.1/v2.2: JM, MDR, MA, MB, KDC
* CARLsim3: MB, KDC, TSC
* CARLsim4: TSC, HK
* CARLsim5: HK, JX, KC
* CARLsim6: LN, JX, KC, KW
*
* CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
* Ver 12/31/2016
*/

#ifndef _GROUP_MON_CORE_H_
#define _GROUP_MON_CORE_H_


#include <carlsim_datastructures.h> // Neuromodulator
#include <stdio.h>                  // FILE
#include <vector>                   // std::vector

class SNN; // forward declaration of SNN class

class GroupMonitorCore {
public: 

    /*
     *  \brief 
     *
     * LN TODO backward compatibility  DA_MODE default
     * 
     */
    
    // 1>src\snn_manager.cpp(1099): error C2664: 'GroupMonitorCore::GroupMonitorCore(const GroupMonitorCore &)': cannot convert argument 4 from 'int' to 'GroupMonitorCore::mode_t'
    //enum mode_t {DA_MODE=0, ALL_MODE};  
    static const int DA_MODE = 0;
    static const int ALL_MODE = 1; 

    GroupMonitorCore(SNN* snn, int monitorId, int grpId, int mode = DA_MODE); 

    ~GroupMonitorCore();


    // +++++ PUBLIC METHODS: +++++++++++++++++++++++++++++++++++++++++++++++//

    int getGrpId() { return grpId_; }

    int getGrpNumNeurons() { return nNeurons_; }

    int getMonitorId() { return monitorId_; }

    bool getPersistentData() { return persistentData_; }

    int getRecordingTotalTime() { return totalTime_; }

    int getRecordingStartTime() { return startTime_; }

    int getRecordingLastStartTime() { return startTimeLast_; }

    int getRecordingStopTime() { return stopTime_; }

    bool isRecording() { return recordSet_; }

    bool isInAllMode() { return mode_ == ALL_MODE; }; 

    void pushData(int time, float data);

    void pushData(int time, float _DA, float _5HT, float _ACh, float _NE);


    void setPersistentData(bool persistentData) { persistentData_ = persistentData; }

    void startRecording();
    
    void stopRecording();


        
    std::vector<float> getDataVector();

    enum transmitter_t {_DA,_5HT,_ACh,_NE}; 
    std::vector<float> getDataVector(transmitter_t transmitter);   

    std::vector<int> getTimeVector();

    std::vector<float> getPeakValueVector();

    std::vector<int> getPeakTimeVector();

    std::vector<float> getSortedPeakValueVector();

    std::vector<int> getSortedPeakTimeVector();

    // +++++ PUBLIC METHODS THAT SHOULD NOT BE EXPOSED TO INTERFACE +++++++++//

    void clear();

    FILE* getGroupFileId() { return groupFileId_; }

    void setGroupFileId(FILE* groupFileId);
    
    int getLastUpdated() { return grpMonLastUpdated_; }

    void setLastUpdated(unsigned int lastUpdate) { grpMonLastUpdated_ = lastUpdate; }

private:
    void init();

    void writeGroupFileHeader();

    bool needToWriteFileHeader_;

    SNN* snn_;  
    int monitorId_; 
    int grpId_;     
    int nNeurons_;  
    int mode_;   

    FILE* groupFileId_; 
    int groupFileSignature_; 
    float groupFileVersion_; 

    std::vector<int> timeVector_;
    std::vector<float> dataVector_;  
    std::vector<float> data4Vector_[4];  

    bool recordSet_;            
    int startTime_;             
    int startTimeLast_;         
    int stopTime_;              
    int totalTime_;             
    int accumTime_;

    int grpMonLastUpdated_;     

    bool persistentData_;

    // file pointers for error logging
    const FILE* fpInf_;
    const FILE* fpErr_;
    const FILE* fpDeb_;
    const FILE* fpLog_;
};

#endif