haldls::vx::PerfTestStatus Class Reference

Container for perf test result readout. More...

#include <perftest.h>

Classes
struct	ErrorWord
	First non-consecutive payload. More...
struct	InOrder
	Number of words received in order. More...
struct	Received
	Number of words received. More...
struct	Sent
	Number of words sent successfully. More...

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

Public Member Functions
	PerfTestStatus () SYMBOL_VISIBLE
	Default constructor. More...
void	decode (std::array< fisch::vx::word_access_type::Omnibus, read_config_size_in_words > const &data) SYMBOL_VISIBLE
std::array< fisch::vx::word_access_type::Omnibus, write_config_size_in_words >	encode () const SYMBOL_VISIBLE
ErrorWord	get_error_word () const SYMBOL_VISIBLE
	Get index of first non-consecutive word. More...
InOrder	get_in_order () const SYMBOL_VISIBLE
	Get number of words received in order. More...
Received	get_received () const SYMBOL_VISIBLE
	Get number of successfully received words. More...
Sent	get_sent () const SYMBOL_VISIBLE
	Get number of successfully sent words. More...
bool	operator!= (PerfTestStatus const &other) const SYMBOL_VISIBLE
bool	operator== (PerfTestStatus const &other) const SYMBOL_VISIBLE
void	set_error_word (ErrorWord value) SYMBOL_VISIBLE
	Set index of first non-consecutive word. More...
void	set_in_order (InOrder value) SYMBOL_VISIBLE
	Set number of words received in order. More...
void	set_received (Received value) SYMBOL_VISIBLE
	Set number of successfully received words. More...
void	set_sent (Sent value) SYMBOL_VISIBLE
	Set number of successfully sent words. More...

Static Public Member Functions
static std::array< halco::hicann_dls::vx::OmnibusAddress, read_config_size_in_words >	read_addresses (coordinate_type const &word) SYMBOL_VISIBLE
static std::array< halco::hicann_dls::vx::OmnibusAddress, write_config_size_in_words >	write_addresses (coordinate_type const &word) SYMBOL_VISIBLE

Static Public Attributes
static constexpr size_t	read_config_size_in_words = 4
static constexpr size_t	write_config_size_in_words = 0

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

Detailed Description

Container for perf test result readout.

Definition at line 90 of file perftest.h.

Member Typedef Documentation

coordinate_type

typedef halco::hicann_dls::vx::PerfTestStatusOnFPGA haldls::vx::PerfTestStatus::coordinate_type

Definition at line 93 of file perftest.h.

is_leaf_node

typedef std::true_type haldls::vx::PerfTestStatus::is_leaf_node

Definition at line 94 of file perftest.h.

Constructor & Destructor Documentation

PerfTestStatus()

haldls::vx::PerfTestStatus::PerfTestStatus

(

)

Default constructor.

Member Function Documentation

decode()

void haldls::vx::PerfTestStatus::decode

(

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

data

)

encode()

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

(

)

const

get_error_word()

ErrorWord haldls::vx::PerfTestStatus::get_error_word

(

)

const

Get index of first non-consecutive word.

Returns

ErrorWord index value

get_in_order()

InOrder haldls::vx::PerfTestStatus::get_in_order

(

)

const

Get number of words received in order.

Returns

InOrder counter value

get_received()

Received haldls::vx::PerfTestStatus::get_received

(

)

const

Get number of successfully received words.

Returns

Received counter value

get_sent()

Sent haldls::vx::PerfTestStatus::get_sent

(

)

const

Get number of successfully sent words.

Returns

Sent counter value

operator!=()

bool haldls::vx::PerfTestStatus::operator!=

(

PerfTestStatus const &

other

)

const

operator==()

bool haldls::vx::PerfTestStatus::operator==

(

PerfTestStatus const &

other

)

const

read_addresses()

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

static

set_error_word()

void haldls::vx::PerfTestStatus::set_error_word

(

ErrorWord

value

)

Set index of first non-consecutive word.

Parameters

value

ErrorWord index value

set_in_order()

void haldls::vx::PerfTestStatus::set_in_order

(

InOrder

value

)

Set number of words received in order.

Parameters

value

InOrder counter value

set_received()

void haldls::vx::PerfTestStatus::set_received

(

Received

value

)

Set number of successfully received words.

Parameters

value

Received counter value

set_sent()

void haldls::vx::PerfTestStatus::set_sent

(

Sent

value

)

Set number of successfully sent words.

Parameters

value

Sent counter value

write_addresses()

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

static

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Definition at line 201 of file perftest.h.

operator<<

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

friend

Member Data Documentation

read_config_size_in_words

constexpr size_t haldls::vx::PerfTestStatus::read_config_size_in_words = 4

staticconstexpr

Definition at line 189 of file perftest.h.

write_config_size_in_words

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

staticconstexpr

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