haldls::vx::JTAGClockScaler Class Reference

Container writing JTAG clock-scaler value. More...

#include <jtag.h>

Classes
struct	Value
	Clock-scaler value type. More...

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

Public Member Functions
	JTAGClockScaler (Value value=Value()) SYMBOL_VISIBLE
	Construct scaler with value. More...
void	decode (std::array< fisch::vx::word_access_type::JTAGClockScaler, read_config_size_in_words > const &data) SYMBOL_VISIBLE
	Decode read words into container config. More...
std::array< fisch::vx::word_access_type::JTAGClockScaler, write_config_size_in_words >	encode () const SYMBOL_VISIBLE
	Get container config encoded in writable words. More...
bool	operator!= (JTAGClockScaler const &other) const SYMBOL_VISIBLE
bool	operator== (JTAGClockScaler const &other) const SYMBOL_VISIBLE
void	set (Value value) SYMBOL_VISIBLE
	Set clock-scaler value. More...

Static Public Member Functions
static std::array< halco::hicann_dls::vx::JTAGClockScalerOnDLS, read_config_size_in_words >	read_addresses (coordinate_type const &word) SYMBOL_VISIBLE
	Get word addresses for encoding a read. More...
static std::array< halco::hicann_dls::vx::JTAGClockScalerOnDLS, write_config_size_in_words >	write_addresses (coordinate_type const &word) SYMBOL_VISIBLE
	Get word addresses for encoding a write. More...

Static Public Attributes
static constexpr size_t	read_config_size_in_words = 0
	Number of words for read access. More...
static constexpr size_t	write_config_size_in_words = 1
	Number of words for write access. More...

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

Detailed Description

Container writing JTAG clock-scaler value.

Definition at line 26 of file jtag.h.

Member Typedef Documentation

coordinate_type

typedef halco::hicann_dls::vx::JTAGClockScalerOnDLS haldls::vx::JTAGClockScaler::coordinate_type

Definition at line 29 of file jtag.h.

is_leaf_node

typedef std::true_type haldls::vx::JTAGClockScaler::is_leaf_node

Definition at line 30 of file jtag.h.

Constructor & Destructor Documentation

JTAGClockScaler()

haldls::vx::JTAGClockScaler::JTAGClockScaler ( Value  value = Value() )

explicit

Construct scaler with value.

Parameters

value

Value to construct scaler with

Member Function Documentation

decode()

void haldls::vx::JTAGClockScaler::decode

(

std::array< fisch::vx::word_access_type::JTAGClockScaler, read_config_size_in_words > const &

data

)

Decode read words into container config.

Parameters

data	Array of word values

encode()

std::array<fisch::vx::word_access_type::JTAGClockScaler, write_config_size_in_words> haldls::vx::JTAGClockScaler::encode

(

)

const

Get container config encoded in writable words.

Returns

Array of word values

operator!=()

bool haldls::vx::JTAGClockScaler::operator!=

(

JTAGClockScaler const &

other

)

const

operator==()

bool haldls::vx::JTAGClockScaler::operator==

(

JTAGClockScaler const &

other

)

const

read_addresses()

static std::array<halco::hicann_dls::vx::JTAGClockScalerOnDLS, read_config_size_in_words> haldls::vx::JTAGClockScaler::read_addresses ( coordinate_type const &  word )

static

Get word addresses for encoding a read.

Returns

Array of addresses

set()

void haldls::vx::JTAGClockScaler::set

(

Value

value

)

Set clock-scaler value.

Parameters

value

Clock-scaler value to set

write_addresses()

static std::array<halco::hicann_dls::vx::JTAGClockScalerOnDLS, write_config_size_in_words> haldls::vx::JTAGClockScaler::write_addresses ( coordinate_type const &  word )

static

Get word addresses for encoding a write.

Returns

Array of addresses

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Definition at line 99 of file jtag.h.

operator<<

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

friend

Member Data Documentation

read_config_size_in_words

constexpr size_t haldls::vx::JTAGClockScaler::read_config_size_in_words = 0

staticconstexpr

Number of words for read access.

Definition at line 67 of file jtag.h.

write_config_size_in_words

constexpr size_t haldls::vx::JTAGClockScaler::write_config_size_in_words = 1

staticconstexpr

Number of words for write access.

Definition at line 64 of file jtag.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/jtag.h