CARLsim  6.1.0
CARLsim: a GPU-accelerated SNN simulator
neuron_monitor.h
Go to the documentation of this file.
1 /* * Copyright (c) 2016 Regents of the University of California. All rights reserved.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions
5 * are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * 3. The names of its contributors may not be used to endorse or promote
15 * products derived from this software without specific prior written
16 * permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
26 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * *********************************************************************************************** *
31 * CARLsim
32 * created by: (MDR) Micah Richert, (JN) Jayram M. Nageswaran
33 * maintained by:
34 * (MA) Mike Avery <averym@uci.edu>
35 * (MB) Michael Beyeler <mbeyeler@uci.edu>,
36 * (KDC) Kristofor Carlson <kdcarlso@uci.edu>
37 * (TSC) Ting-Shuo Chou <tingshuc@uci.edu>
38 * (HK) Hirak J Kashyap <kashyaph@uci.edu>
39 *
40 * CARLsim v1.0: JM, MDR
41 * CARLsim v2.0/v2.1/v2.2: JM, MDR, MA, MB, KDC
42 * CARLsim3: MB, KDC, TSC
43 * CARLsim4: TSC, HK
44 * CARLsim5: HK, JX, KC
45 * CARLsim6: LN, JX, KC, KW
46 *
47 * CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
48 * Ver 05/24/2017
49 */
50 
51 #ifndef _NEURON_MON_H_
52 #define _NEURON_MON_H_
53 
54 #include "carlsim_api.h"
55 
56 #include <carlsim_datastructures.h> // NeuronMonMode
57 #include <vector> // std::vector
58 
59 class SNN; // forward declaration of SNN class
60 class NeuronMonitorCore; // forward declaration of implementation
61 
63  public:
70  NeuronMonitor(NeuronMonitorCore* neuronMonitorCorePtr);
71 
78  ~NeuronMonitor();
79 
80  void clear();
81  bool isRecording();
82  void startRecording();
83  void stopRecording();
84  void setLogFile(const std::string& logFileName);
85  void print(bool meanOnly = false);
86 
87  //{ LN20201118 extensions
88 
97  bool getPersistentData();
98 
108  void setPersistentData(bool persistentData);
109 
116  int getLastUpdated();
117 
119  std::vector<std::vector<float> > getVectorV();
120  std::vector<std::vector<float> > getVectorU();
121  std::vector<std::vector<float> > getVectorI();
122 
123  //}
124 
125  private:
127  NeuronMonitorCore* neuronMonitorCorePtr_;
128 
129 };
130 #endif
#define CARLSIM_API
Definition: carlsim_api.h:14
Contains all of CARLsim&#39;s core functionality.
Definition: snn.h:138