group_monitor.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 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>
 *
 * CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
 * Ver 11/26/2014
 */

// paradigm shift: run this on spikes.

#ifndef _GROUP_MON_H_
#define _GROUP_MON_H_

#include <carlsim_datastructures.h>
#include <vector>                   // std::vector

class CpuSNN;           // forward declaration of CpuSNN class
class GroupMonitorCore; // forward declaration of implementation

class GroupMonitor {
 public:
    GroupMonitor(GroupMonitorCore* groupMonitorCorePtr);

    virtual ~GroupMonitor();


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

    bool isRecording();

    void startRecording();

    void stopRecording();

    int getRecordingTotalTime();

    int getRecordingLastStartTime();

    int getRecordingStartTime();

    int getRecordingStopTime();

    bool getPersistentData();

    void setPersistentData(bool persistentData);

    std::vector<float> getDataVector();

    std::vector<int> getTimeVector();

    std::vector<float> getPeakValueVector();

    std::vector<int> getPeakTimeVector();

    std::vector<float> getSortedPeakValueVector();

    std::vector<int> getSortedPeakTimeVector();

 private:
    GroupMonitorCore* groupMonitorCorePtr_;
};

#endif