Container to read the spike counter of a single neuron. More...

#include <neuron.h>

Classes
struct	Count
	Count of rate counter. More...

Public Types
typedef halco::hicann_dls::vx::SpikeCounterReadOnDLS	coordinate_type

typedef std::true_type	is_leaf_node

Public Member Functions
	SpikeCounterRead () SYMBOL_VISIBLE
	Default constructor. More...

template<typename WordT >
void	decode (std::array< WordT, read_config_size_in_words > const &data) SYMBOL_VISIBLE

template<typename WordT >
std::array< WordT, write_config_size_in_words >	encode () const SYMBOL_VISIBLE

Count	get_count () const SYMBOL_VISIBLE
	Get count, i.e. More...

bool	get_overflow () const SYMBOL_VISIBLE

bool	operator!= (SpikeCounterRead const &other) const SYMBOL_VISIBLE

bool	operator== (SpikeCounterRead const &other) const SYMBOL_VISIBLE

void	set_count (Count const cnt) SYMBOL_VISIBLE

void	set_overflow (bool const ovrflw) SYMBOL_VISIBLE

Static Public Member Functions
template<typename AddressT >
static std::array< AddressT, read_config_size_in_words >	read_addresses (coordinate_type const &neuron) SYMBOL_VISIBLE

template<typename AddressT >
static std::array< AddressT, write_config_size_in_words >	write_addresses (coordinate_type const &neuron) SYMBOL_VISIBLE

Static Public Attributes
static constexpr size_t	read_config_size_in_words = 1

static constexpr size_t	write_config_size_in_words = 0

Friends
class	cereal::access

std::ostream &	operator<< (std::ostream &os, SpikeCounterRead const &config) SYMBOL_VISIBLE

Detailed Description

Container to read the spike counter of a single neuron.

Definition at line 603 of file neuron.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::SpikeCounterReadOnDLS haldls::vx::SpikeCounterRead::coordinate_type

Definition at line 606 of file neuron.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::SpikeCounterRead::is_leaf_node

Definition at line 607 of file neuron.h.

Constructor & Destructor Documentation

◆ SpikeCounterRead()

haldls::vx::SpikeCounterRead::SpikeCounterRead ( )

Default constructor.

Member Function Documentation

◆ decode()

template<typename WordT >

void haldls::vx::SpikeCounterRead::decode ( std::array< WordT, read_config_size_in_words > const & data )

◆ encode()

template<typename WordT >

std::array<WordT, write_config_size_in_words> haldls::vx::SpikeCounterRead::encode ( ) const

◆ get_count()

Count haldls::vx::SpikeCounterRead::get_count ( ) const

Get count, i.e.

number of spikes since last reset.

Returns: Count

◆ get_overflow()

bool haldls::vx::SpikeCounterRead::get_overflow ( ) const

◆ operator!=()

bool haldls::vx::SpikeCounterRead::operator!= ( SpikeCounterRead const & other ) const

◆ operator==()

bool haldls::vx::SpikeCounterRead::operator== ( SpikeCounterRead const & other ) const

◆ read_addresses()

template<typename AddressT >

static std::array<AddressT, read_config_size_in_words> haldls::vx::SpikeCounterRead::read_addresses ( coordinate_type const & neuron )

static

◆ set_count()

void haldls::vx::SpikeCounterRead::set_count ( Count const cnt )

◆ set_overflow()

void haldls::vx::SpikeCounterRead::set_overflow ( bool const ovrflw )

◆ write_addresses()

template<typename AddressT >

static std::array<AddressT, write_config_size_in_words> haldls::vx::SpikeCounterRead::write_addresses ( coordinate_type const & neuron )

static

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access

friend

Definition at line 660 of file neuron.h.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		SpikeCounterRead const &	config
	)

friend

Member Data Documentation

◆ read_config_size_in_words

constexpr size_t haldls::vx::SpikeCounterRead::read_config_size_in_words = 1

staticconstexpr

Definition at line 642 of file neuron.h.

◆ write_config_size_in_words

constexpr size_t haldls::vx::SpikeCounterRead::write_config_size_in_words = 0