haldls::vx::CommonSTPConfig Class Reference

Common STP configuration shared by synapse drivers per vertical half. More...

#include <padi.h>

Inheritance diagram for haldls::vx::CommonSTPConfig:

Collaboration diagram for haldls::vx::CommonSTPConfig:

Classes
struct	RecoveryClockSpeed

Public Types
typedef halco::hicann_dls::vx::CommonSTPConfigOnDLS	coordinate_type
typedef std::true_type	is_leaf_node

Public Member Functions
	CommonSTPConfig () SYMBOL_VISIBLE
template<typename WordT >
void	decode (std::array< WordT, config_size_in_words > const &data) SYMBOL_VISIBLE
template<typename WordT >
std::array< WordT, config_size_in_words >	encode () const SYMBOL_VISIBLE
bool	get_enable_recovery_clock () const SYMBOL_VISIBLE
	Enable recovery clock for the STP circuit. More...
RecoveryClockSpeed	get_recovery_clock_speed () const SYMBOL_VISIBLE
	Set the scaler for the recovery clock. More...
bool	operator!= (CommonSTPConfig const &other) const SYMBOL_VISIBLE
bool	operator== (CommonSTPConfig const &other) const SYMBOL_VISIBLE
void	set_enable_recovery_clock (bool const value) SYMBOL_VISIBLE
void	set_recovery_clock_speed (RecoveryClockSpeed const value) SYMBOL_VISIBLE

Static Public Member Functions
template<typename AddressT >
static std::array< AddressT, config_size_in_words >	addresses (coordinate_type const &coord) SYMBOL_VISIBLE

Static Public Attributes
static constexpr size_t	config_size_in_words = 1
constexpr static auto	unsupported_read_targets

Friends
class	cereal::access
std::ostream &	operator<< (std::ostream &os, CommonSTPConfig const &event) SYMBOL_VISIBLE

Detailed Description

Common STP configuration shared by synapse drivers per vertical half.

It allows to enable/disable and set the speed for the recovery clock.

Definition at line 261 of file padi.h.

Member Typedef Documentation

coordinate_type

typedef halco::hicann_dls::vx::CommonSTPConfigOnDLS haldls::vx::CommonSTPConfig::coordinate_type

Definition at line 264 of file padi.h.

is_leaf_node

typedef std::true_type haldls::vx::CommonSTPConfig::is_leaf_node

Definition at line 265 of file padi.h.

Constructor & Destructor Documentation

CommonSTPConfig()

haldls::vx::CommonSTPConfig::CommonSTPConfig

(

)

Member Function Documentation

addresses()

template<typename AddressT >

static std::array<AddressT, config_size_in_words> haldls::vx::CommonSTPConfig::addresses ( coordinate_type const &  coord )

static

decode()

template<typename WordT >

void haldls::vx::CommonSTPConfig::decode

(

std::array< WordT, config_size_in_words > const &

data

)

encode()

template<typename WordT >

std::array<WordT, config_size_in_words> haldls::vx::CommonSTPConfig::encode

(

)

const

get_enable_recovery_clock()

bool haldls::vx::CommonSTPConfig::get_enable_recovery_clock

(

)

const

Enable recovery clock for the STP circuit.

get_recovery_clock_speed()

RecoveryClockSpeed haldls::vx::CommonSTPConfig::get_recovery_clock_speed

(

)

const

Set the scaler for the recovery clock.

operator!=()

bool haldls::vx::CommonSTPConfig::operator!=

(

CommonSTPConfig const &

other

)

const

operator==()

bool haldls::vx::CommonSTPConfig::operator==

(

CommonSTPConfig const &

other

)

const

set_enable_recovery_clock()

void haldls::vx::CommonSTPConfig::set_enable_recovery_clock

(

bool const

value

)

set_recovery_clock_speed()

void haldls::vx::CommonSTPConfig::set_recovery_clock_speed

(

RecoveryClockSpeed const

value

)

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Definition at line 313 of file padi.h.

operator<<

std::ostream& operator<< ( std::ostream &  os, CommonSTPConfig const &  event  )

friend

Member Data Documentation

config_size_in_words

constexpr size_t haldls::vx::CommonSTPConfig::config_size_in_words = 1

staticconstexpr

Definition at line 299 of file padi.h.

unsupported_read_targets

constexpr static auto haldls::vx::CommonSTPConfig::unsupported_read_targets

staticconstexpr

Initial value:

= {
        hxcomm::vx::Target::hardware, hxcomm::vx::Target::simulation}

Definition at line 267 of file padi.h.

---

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

• /jenkins/jenlib_workspaces_f9/bld_nightly-haldls.YmxkX25pZ2h0bHktaGFsZGxzIzEzNzk.x/haldls/include/haldls/vx/padi.h