pseudo_recording_device.h

Go to the documentation of this file.

/*
 *  pseudo_recording_device.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef PSEUDO_RECORDING_DEVICE_H
#define PSEUDO_RECORDING_DEVICE_H

#include "nest.h"
#include "dictdatum.h"
#include "dictutils.h"
#include "lockptr.h"
#include "device.h"

#include <vector>
#include <fstream>

namespace nest {

  /*BeginDocumentation
    Name: PseudoRecordingDevice - Common properties of all pseudo-recording devices.
    Description:

    Pseudo recording devices are used to measure properties of or signals emitted
    by network nodes. In contrast to fully flegded recording devices, they only
    register data in memory, but do not write data to file or screen.

    Parameters:
    The following parameters are shared with all devices:
    /start  - Actication time, relative to origin.
    /stop   - Inactivation time, relative to origin. 
    /origin - Reference time for start and stop.
                                          
    SeeAlso: Device, StimulatingDevice, RecordingDevice
  */


  class PseudoRecordingDevice : public Device 
  {

  public:
    PseudoRecordingDevice();
    PseudoRecordingDevice(const PseudoRecordingDevice&);
    virtual ~PseudoRecordingDevice() {}

    bool is_active(Time const & T) const;
  };

  inline
  PseudoRecordingDevice::PseudoRecordingDevice()
    : Device()
  {}

  inline
  PseudoRecordingDevice::PseudoRecordingDevice(const PseudoRecordingDevice& prd)
    : Device(prd)
  {}

  inline
  bool PseudoRecordingDevice::is_active(Time const & T) const
  {
    const long_t stamp = T.get_steps();
  
    return get_t_min_() < stamp && stamp <= get_t_max_();
  }

} // namespace

#endif  // PSEUDO_RECORDING_DEVICE_H