Abstract base class for all Device, Stimulator, etc objects. More...

#include <Device.h>

Inheritance diagram for auryn::Device:

Collaboration diagram for auryn::Device:

Public Member Functions
	Device ()
	Standard constructor. More...

void	set_name (std::string s)
	Set device name. More...

std::string	get_name ()
	Get device name. More...

int	get_id ()
	Get numeric device id. More...

virtual void	flush ()
	Flush to file. More...

virtual	~Device ()
	Standard destructor. More...

virtual void	evolve ()

virtual void	execute ()

Public Attributes
bool	active
	Standard active switch. More...

Protected Member Functions
void	init ()
	Standard initializer to be called by the constructor. More...

virtual void	virtual_serialize (boost::archive::binary_oarchive &ar, const unsigned int version)

virtual void	virtual_serialize (boost::archive::binary_iarchive &ar, const unsigned int version)

Protected Attributes
std::string	device_name
	Identifying name for device. More...

Friends
class	boost::serialization::access

Detailed Description

Abstract base class for all Device, Stimulator, etc objects.

Devices are executed after SpikingGroups and Connection objects in the Auryn duty cycle. Most commonly a Device will be a Monitor, but it could be a stimulator or something else too.

Constructor & Destructor Documentation

◆ Device()

Device::Device ( )

Standard constructor.

 {
         init();
 }

Here is the call graph for this function:

◆ ~Device()

Device::~Device ( )

virtual

Standard destructor.

47 {

48 }

Member Function Documentation

◆ evolve()

virtual void auryn::Device::evolve ( )

inlinevirtual

Virtual evolve function to be called in central simulation loop in System

99 { };

◆ execute()

virtual void auryn::Device::execute ( )

inlinevirtual

Virtual execute function to be called at the end of central simulation loop in System

Reimplemented in auryn::StateMonitor, auryn::WeightMonitor, auryn::BinaryStateMonitor, auryn::PoissonStimulator, auryn::CurrentInjector, auryn::NormalStimulator, auryn::SpikeMonitor, auryn::PatternMonitor, auryn::BurstRateMonitor, auryn::RateMonitor, auryn::WeightPatternMonitor, auryn::PopulationRateMonitor, auryn::RealTimeMonitor, auryn::BinarySpikeMonitor, auryn::VoltageClampMonitor, auryn::DelayedSpikeMonitor, auryn::VoltageMonitor, auryn::WeightStatsMonitor, auryn::WeightSumMonitor, and auryn::WeightMatrixMonitor.

102 { };

◆ flush()

void Device::flush ( )

virtual

Flush to file.

Reimplemented in auryn::Monitor, and auryn::BinarySpikeMonitor.

59 {

60 }

◆ get_id()

int Device::get_id ( )

Get numeric device id.

 {
         return device_id;
 }

◆ get_name()

std::string Device::get_name ( )

Get device name.

 {
         return device_name;
 }

◆ init()

void Device::init ( )

protected

Standard initializer to be called by the constructor.

 {
         device_id  = device_id_count++;
         std::stringstream default_name;
         default_name << "Device" << get_id();
         set_name(default_name.str());
         active = true;
 }

Here is the call graph for this function:

◆ set_name()

void Device::set_name ( std::string s )

Set device name.

 {
         device_name = str;
 }

◆ virtual_serialize() [1/2]

void Device::virtual_serialize	(	boost::archive::binary_oarchive &	ar,
		const unsigned int	version
	)

protectedvirtual

Reimplemented in auryn::Monitor, auryn::BurstRateMonitor, auryn::PatternMonitor, and auryn::PopulationRateMonitor.

51 {

52 }

◆ virtual_serialize() [2/2]

void Device::virtual_serialize	(	boost::archive::binary_iarchive &	ar,
		const unsigned int	version
	)

protectedvirtual

Reimplemented in auryn::Monitor, auryn::BurstRateMonitor, auryn::PatternMonitor, and auryn::PopulationRateMonitor.

55 {

56 }

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Functions necesssary for serialization and loading saving to netstate files.

Member Data Documentation

◆ active

bool auryn::Device::active

Standard active switch.

◆ device_name

std::string auryn::Device::device_name