CARLsim  5.0.0
CARLsim: a GPU-accelerated SNN simulator
group_monitor.cpp
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 *
46 * CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
47 * Ver 12/31/2016
48 */
49 #include <group_monitor.h>
50 
51 #include <group_monitor_core.h> // GroupMonitor private implementation
52 #include <user_errors.h> // fancy user error messages
53 
54 #include <sstream> // std::stringstream
55 
56 // we aren't using namespace std so pay attention!
58  // make sure the pointer is NULL
59  groupMonitorCorePtr_ = groupMonitorCorePtr;
60 }
61 
63  delete groupMonitorCorePtr_;
64 }
65 
66 // +++++ PUBLIC METHODS: +++++++++++++++++++++++++++++++++++++++++++++++//
67 
69  return groupMonitorCorePtr_->isRecording();
70 }
71 
73  std::string funcName = "startRecording()";
75 
76  groupMonitorCorePtr_->startRecording();
77 }
78 
80  std::string funcName = "stopRecording()";
82 
83  groupMonitorCorePtr_->stopRecording();
84 }
85 
87  std::string funcName = "getRecordingTotalTime()";
89 
90  return groupMonitorCorePtr_->getRecordingTotalTime();
91 }
92 
94  std::string funcName = "getRecordingLastStartTime()";
96 
97  return groupMonitorCorePtr_->getRecordingLastStartTime();
98 }
99 
101  std::string funcName = "getRecordingStartTime()";
102  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
103 
104  return groupMonitorCorePtr_->getRecordingStartTime();
105 }
106 
108  std::string funcName = "getRecordingStopTime()";
109  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
110 
111  return groupMonitorCorePtr_->getRecordingStopTime();
112 }
113 
115  return groupMonitorCorePtr_->getPersistentData();
116 }
117 
118 void GroupMonitor::setPersistentData(bool persistentData) {
119  groupMonitorCorePtr_->setPersistentData(persistentData);
120 }
121 
122 std::vector<float> GroupMonitor::getDataVector(){
123  std::string funcName = "getDataVector()";
124  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
125 
126  return groupMonitorCorePtr_->getDataVector();
127 }
128 
129 std::vector<int> GroupMonitor::getTimeVector(){
130  std::string funcName = "getTimeVector()";
131  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
132 
133  return groupMonitorCorePtr_->getTimeVector();
134 }
135 
137  std::string funcName = "getPeakTimeVector()";
138  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
139 
140  return groupMonitorCorePtr_->getPeakTimeVector();
141 }
142 
144  std::string funcName = "getSortedPeakTimeVector()";
145  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
146 
147  return groupMonitorCorePtr_->getSortedPeakTimeVector();
148 }
149 
150 std::vector<float> GroupMonitor::getPeakValueVector() {
151  std::string funcName = "getPeakValueVector()";
152  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
153 
154  return groupMonitorCorePtr_->getPeakValueVector();
155 }
156 
158  std::string funcName = "getSortedPeakValueVector()";
159  UserErrors::assertTrue(!isRecording(), UserErrors::CANNOT_BE_ON, funcName, "Recording");
160 
161  return groupMonitorCorePtr_->getSortedPeakValueVector();
162 }
UserErrors::CANNOT_BE_ON
@ CANNOT_BE_ON
parameter cannot be on
Definition: user_errors.h:38
user_errors.h
GroupMonitor::getRecordingStartTime
int getRecordingStartTime()
Returns the simulation time (ms) of the first call to startRecording()
Definition: group_monitor.cpp:100
GroupMonitor::GroupMonitor
GroupMonitor(GroupMonitorCore *groupMonitorCorePtr)
GroupMonitor constructor.
Definition: group_monitor.cpp:57
GroupMonitor::getTimeVector
std::vector< int > getTimeVector()
return a vector of the timestamps for group data
Definition: group_monitor.cpp:129
group_monitor_core.h
GroupMonitor::getRecordingStopTime
int getRecordingStopTime()
Returns the simulation time (ms) of the last call to stopRecording()
Definition: group_monitor.cpp:107
GroupMonitorCore::startRecording
void startRecording()
starts recording group data
Definition: group_monitor_core.cpp:180
GroupMonitorCore::getPeakTimeVector
std::vector< int > getPeakTimeVector()
get the timestamps for peak values
Definition: group_monitor_core.cpp:126
GroupMonitorCore::getPersistentData
bool getPersistentData()
returns status of PersistentData mode
Definition: group_monitor_core.h:85
UserErrors::MUST_BE_ON
@ MUST_BE_ON
parameter must be on
Definition: user_errors.h:52
GroupMonitorCore::getSortedPeakValueVector
std::vector< float > getSortedPeakValueVector()
get the sorted peak values of group data
Definition: group_monitor_core.cpp:165
GroupMonitorCore::getDataVector
std::vector< float > getDataVector()
get the group data
Definition: group_monitor_core.cpp:118
GroupMonitorCore::getRecordingStartTime
int getRecordingStartTime()
retunrs the timestamp of the first startRecording in ms
Definition: group_monitor_core.h:91
GroupMonitorCore
GroupMonitor private core implementation.
Definition: group_monitor_core.h:64
group_monitor.h
GroupMonitorCore::stopRecording
void stopRecording()
stops recording group data
Definition: group_monitor_core.cpp:207
GroupMonitor::~GroupMonitor
virtual ~GroupMonitor()
GroupMonitor destructor.
Definition: group_monitor.cpp:62
GroupMonitor::startRecording
void startRecording()
Starts a new recording period.
Definition: group_monitor.cpp:72
GroupMonitor::getDataVector
std::vector< float > getDataVector()
return the group data vector
Definition: group_monitor.cpp:122
GroupMonitor::getRecordingTotalTime
int getRecordingTotalTime()
Returns the total recording time (ms)
Definition: group_monitor.cpp:86
GroupMonitor::isRecording
bool isRecording()
Recording status (true=recording, false=not recording)
Definition: group_monitor.cpp:68
GroupMonitorCore::isRecording
bool isRecording()
returns recording status
Definition: group_monitor_core.h:100
GroupMonitorCore::getRecordingLastStartTime
int getRecordingLastStartTime()
returns the timestamp of the last startRecording in ms
Definition: group_monitor_core.h:94
GroupMonitorCore::getSortedPeakTimeVector
std::vector< int > getSortedPeakTimeVector()
get the sorted timestamps for peak values
Definition: group_monitor_core.cpp:138
GroupMonitor::stopRecording
void stopRecording()
Ends a recording period.
Definition: group_monitor.cpp:79
GroupMonitor::setPersistentData
void setPersistentData(bool persistentData)
Sets PersistentMode either on (true) or off (false)
Definition: group_monitor.cpp:118
GroupMonitorCore::getRecordingTotalTime
int getRecordingTotalTime()
returns the total recorded time in ms
Definition: group_monitor_core.h:88
GroupMonitor::getRecordingLastStartTime
int getRecordingLastStartTime()
Returns the simulation time (ms) of the last call to startRecording()
Definition: group_monitor.cpp:93
GroupMonitor::getPeakValueVector
std::vector< float > getPeakValueVector()
return a vector of peak values in group data
Definition: group_monitor.cpp:150
GroupMonitorCore::setPersistentData
void setPersistentData(bool persistentData)
sets status of PersistentData mode
Definition: group_monitor_core.h:106
GroupMonitorCore::getTimeVector
std::vector< int > getTimeVector()
get the timestamps for group data
Definition: group_monitor_core.cpp:122
GroupMonitorCore::getPeakValueVector
std::vector< float > getPeakValueVector()
get the peak values of group data
Definition: group_monitor_core.cpp:153
UserErrors::assertTrue
static void assertTrue(bool statement, errorType errorIfAssertionFails, std::string errorFunc, std::string errorMsgPrefix="", std::string errorMsgSuffix="")
simple wrapper for assert statement
Definition: user_errors.cpp:15
GroupMonitorCore::getRecordingStopTime
int getRecordingStopTime()
returns the timestamp of stopRecording
Definition: group_monitor_core.h:97
GroupMonitor::getSortedPeakTimeVector
std::vector< int > getSortedPeakTimeVector()
return a vector of the timestamps for peak values in group data (sorted in decending order)
Definition: group_monitor.cpp:143
GroupMonitor::getPersistentData
bool getPersistentData()
Returns a flag that indicates whether PersistentMode is on (true) or off (false)
Definition: group_monitor.cpp:114
GroupMonitor::getSortedPeakValueVector
std::vector< float > getSortedPeakValueVector()
return a vector of peak values in group data (sorted in decending order)
Definition: group_monitor.cpp:157
GroupMonitor::getPeakTimeVector
std::vector< int > getPeakTimeVector()
return a vector of the timestamps for peak values in group data
Definition: group_monitor.cpp:136