Container for syncronization of chip and FPGA systime. More...

#include <systime.h>

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

typedef std::true_type	is_leaf_node

Public Member Functions
	SystimeSync (bool do_sync=true) SYMBOL_VISIBLE

void	decode (std::array< fisch::vx::word_access_type::SystimeSync, read_config_size_in_words > const &data) SYMBOL_VISIBLE

std::array< fisch::vx::word_access_type::SystimeSync, write_config_size_in_words >	encode () const SYMBOL_VISIBLE SYMBOL_VISIBLE

bool	get_do_sync () const SYMBOL_VISIBLE
	Get systime sync enable value. More...

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

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

void	set_do_sync (bool value) SYMBOL_VISIBLE
	Set systime sync enable value. More...

Static Public Member Functions
static std::array< coordinate_type, read_config_size_in_words >	read_addresses (coordinate_type const &word) SYMBOL_VISIBLE SYMBOL_VISIBLE

static std::array< coordinate_type, write_config_size_in_words >	write_addresses (coordinate_type const &word) SYMBOL_VISIBLE SYMBOL_VISIBLE

Static Public Attributes
static constexpr size_t	read_config_size_in_words = 0

static constexpr size_t	write_config_size_in_words = 1

Friends
class	cereal::access

std::ostream &	operator<< (std::ostream &os, SystimeSync const &systime_sync) SYMBOL_VISIBLE

Detailed Description

Container for syncronization of chip and FPGA systime.

After syncronization the FPGA will annotate responses with systime information by sending additional timing messages.

Definition at line 95 of file systime.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::SystimeSyncOnFPGA haldls::vx::SystimeSync::coordinate_type

Definition at line 98 of file systime.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::SystimeSync::is_leaf_node

Definition at line 99 of file systime.h.

Constructor & Destructor Documentation

◆ SystimeSync()

haldls::vx::SystimeSync::SystimeSync ( bool do_sync = true )

Member Function Documentation

◆ decode()

void haldls::vx::SystimeSync::decode ( std::array< fisch::vx::word_access_type::SystimeSync, read_config_size_in_words > const & data )

◆ encode()

std::array<fisch::vx::word_access_type::SystimeSync, write_config_size_in_words> haldls::vx::SystimeSync::encode ( ) const

◆ get_do_sync()

bool haldls::vx::SystimeSync::get_do_sync ( ) const

Get systime sync enable value.

On true, systime sync is triggered, on false only a systime update response is emitted.

Returns: Boolean value

◆ operator!=()

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

◆ operator==()

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

◆ read_addresses()

static std::array<coordinate_type, read_config_size_in_words> haldls::vx::SystimeSync::read_addresses ( coordinate_type const & word )

static

◆ set_do_sync()

void haldls::vx::SystimeSync::set_do_sync ( bool value )

Set systime sync enable value.

On true, systime sync is triggered, on false only a systime update response is emitted.

Parameters

value Boolean value

◆ write_addresses()

static std::array<coordinate_type, write_config_size_in_words> haldls::vx::SystimeSync::write_addresses ( coordinate_type const & word )

static

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access

friend

Definition at line 141 of file systime.h.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		SystimeSync const &	systime_sync
	)

friend

Member Data Documentation

◆ read_config_size_in_words

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

staticconstexpr

Definition at line 126 of file systime.h.

◆ write_config_size_in_words

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