nest::PseudoRecordingDevice Class Reference

Common properties of all pseudo-recording devices. More...

#include <pseudo_recording_device.h>

Inheritance diagram for nest::PseudoRecordingDevice:

Collaboration diagram for nest::PseudoRecordingDevice:

Public Member Functions
	PseudoRecordingDevice ()
	PseudoRecordingDevice (const PseudoRecordingDevice &)
	~PseudoRecordingDevice () override
bool	is_active (Time const &T) const override
	Indicate if recording device is active.
Public Member Functions inherited from nest::Device
	Device ()
	Device (const Device &n)
virtual	~Device ()
virtual void	init_state ()
	Reset dynamic state to that of model.
virtual void	init_buffers ()
	Reset buffers.
virtual void	pre_run_hook ()
	Set internal variables before calls to SimulationManager::run()
virtual void	get_status (Dictionary &) const
virtual void	set_status (const Dictionary &)
long	get_t_min_ () const
	Return lower limit in steps.
long	get_t_max_ () const
	Return upper limit in steps.
Time const &	get_origin () const
Time const &	get_start () const
Time const &	get_stop () const

Detailed Description

Common properties of all pseudo-recording devices.

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

Parameters

start	Activation time, relative to origin.
stop	Inactivation time, relative to origin.
origin	Reference time for start and stop.

See also

Device, StimulationDevice, RecordingDevice Base class for all pseudo recording devices.

Pseudo-recording devices collect data. The data is only collected in memory an only available through GetStatus.

If the device is configured to record from start to stop, this is interpreted as (start, stop], i.e., the earliest recorded event will have time stamp start+1, as it was generated during the update step (start, start+1].

Note

The sole purpose of this class is to provide an implementation of is_active().

Author

HEP 2002-07-22, 2008-03-21, 2008-07-01

Constructor & Destructor Documentation

PseudoRecordingDevice() [1/2]

nest::PseudoRecordingDevice::PseudoRecordingDevice ( )

inline

PseudoRecordingDevice() [2/2]

nest::PseudoRecordingDevice::PseudoRecordingDevice ( const PseudoRecordingDevice &  prd )

inline

~PseudoRecordingDevice()

nest::PseudoRecordingDevice::~PseudoRecordingDevice ( )

inlineoverride

Member Function Documentation

is_active()

bool nest::PseudoRecordingDevice::is_active ( Time const &  T ) const

inlineoverridevirtual

Indicate if recording device is active.

The argument is the time stamp of the event, and the device is active if start_ < T <= stop_.

Implements nest::Device.

References nest::Time::get_steps(), nest::Device::get_t_max_(), and nest::Device::get_t_min_().

Referenced by nest::correlation_detector::handle(), nest::correlomatrix_detector::handle(), and nest::correlospinmatrix_detector::handle().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• pseudo_recording_device.h