CARLsim  6.1.0
CARLsim: a GPU-accelerated SNN simulator
group_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 12/31/2016
49 */
50 
51 // paradigm shift: run this on spikes.
52 
53 #ifndef _GROUP_MON_H_
54 #define _GROUP_MON_H_
55 
56 #include "carlsim_api.h"
57 
58 #include <carlsim_datastructures.h>
59 #include <vector> // std::vector
60 
61 class SNN; // forward declaration of SNN class
62 class GroupMonitorCore; // forward declaration of implementation
63 
108  public:
115  GroupMonitor(GroupMonitorCore* groupMonitorCorePtr);
116 
123  virtual ~GroupMonitor();
124 
125 
126  // +++++ PUBLIC METHODS: +++++++++++++++++++++++++++++++++++++++++++++++//
127 
134  bool isRecording();
135 
149  void startRecording();
150 
158  void stopRecording();
159 
170  int getRecordingTotalTime();
171 
179  int getRecordingLastStartTime();
180 
188  int getRecordingStartTime();
189 
196  int getRecordingStopTime();
197 
206  bool getPersistentData();
207 
217  void setPersistentData(bool persistentData);
218 
228  std::vector<float> getDataVector();
229 
230  std::vector<float> getDataVector(int nm);
231 
241  std::vector<int> getTimeVector();
242 
252  std::vector<float> getPeakValueVector();
253 
263  std::vector<int> getPeakTimeVector();
264 
275  std::vector<float> getSortedPeakValueVector();
276 
287  std::vector<int> getSortedPeakTimeVector();
288 
289  private:
291  GroupMonitorCore* groupMonitorCorePtr_;
292 };
293 
294 #endif
#define CARLSIM_API
Definition: carlsim_api.h:14
Class GroupMonitor.
Contains all of CARLsim&#39;s core functionality.
Definition: snn.h:138
GroupMonitor private core implementation.