Container of PLL self-test status data. More...

#include <pll.h>

Classes
struct	CounterValue
	Measured counter value in previous self-test execution. More...

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

typedef std::true_type	is_leaf_node

Public Member Functions
	PLLSelfTestStatus () SYMBOL_VISIBLE
	Default construct a PLL self-test status. 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

CounterValue	get_counter_value () const SYMBOL_VISIBLE
	Get self-test clock period counter value. More...

bool	get_finished () const SYMBOL_VISIBLE
	Get if self-test exectution finished before this containers' read. More...

bool	get_success () const SYMBOL_VISIBLE
	Get if self-test execution was successful. More...

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

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

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

template<typename AddressT >
static std::array< AddressT, write_config_size_in_words >	write_addresses (coordinate_type const &coord) 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, PLLSelfTestStatus const &config) SYMBOL_VISIBLE

Detailed Description

Container of PLL self-test status data.

Definition at line 501 of file pll.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::PLLSelfTestStatusOnDLS haldls::vx::PLLSelfTestStatus::coordinate_type

Definition at line 504 of file pll.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::PLLSelfTestStatus::is_leaf_node

Definition at line 505 of file pll.h.

Constructor & Destructor Documentation

◆ PLLSelfTestStatus()

haldls::vx::PLLSelfTestStatus::PLLSelfTestStatus ( )

Default construct a PLL self-test status.

Member Function Documentation

◆ decode()

template<typename WordT >

void haldls::vx::PLLSelfTestStatus::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::PLLSelfTestStatus::encode ( ) const

◆ get_counter_value()

CounterValue haldls::vx::PLLSelfTestStatus::get_counter_value ( ) const

Get self-test clock period counter value.

Returns: Counter value

◆ get_finished()

bool haldls::vx::PLLSelfTestStatus::get_finished ( ) const

Get if self-test exectution finished before this containers' read.

This flag only produces reliable information on the first validly finished self test after power cycle.

Returns: Boolean value

◆ get_success()

bool haldls::vx::PLLSelfTestStatus::get_success ( ) const

Get if self-test execution was successful.

Returns: Boolean value

◆ operator!=()

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

◆ operator==()

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

◆ read_addresses()

template<typename AddressT >

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

static

◆ write_addresses()

template<typename AddressT >

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

static

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access

friend

Definition at line 567 of file pll.h.

◆ operator<<

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

friend

Member Data Documentation

◆ read_config_size_in_words

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

staticconstexpr

Definition at line 552 of file pll.h.

◆ write_config_size_in_words

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