haldls::vx::CADCConfig Class Reference

CADC container with global digital config for a vertical half. More...

#include <cadc.h>

Collaboration diagram for haldls::vx::CADCConfig:

Classes
struct	DeadTime
	Dead time in cycles after linear ramp increase to wait for signal propagation to every channel to prevent cutting off leaf channel ramps too early. More...
struct	ResetWait
	Wait time in cycles after ramp drop to compensate for analog low-pass filtering of ramp signal and preventing the drop of the last ramp to cause interference in the next linear ramp increase. More...

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

Public Member Functions
	CADCConfig () SYMBOL_VISIBLE
	Default constructor. More...
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
DeadTime	get_dead_time () const SYMBOL_VISIBLE
	Get DeadTime value common for both CADC in a vertical half. More...
bool	get_enable () const SYMBOL_VISIBLE
	Get enable value for the CADC. More...
ResetWait	get_reset_wait () const SYMBOL_VISIBLE
	Get ResetWait value common for both CADC in a vertical half. More...
bool	operator!= (CADCConfig const &other) const SYMBOL_VISIBLE
bool	operator== (CADCConfig const &other) const SYMBOL_VISIBLE
void	set_dead_time (DeadTime value) SYMBOL_VISIBLE
	Set DeadTime value common for both CADC in a vertical half. More...
void	set_enable (bool value) SYMBOL_VISIBLE
	Set enable value for the CADC. More...
void	set_reset_wait (ResetWait value) SYMBOL_VISIBLE
	Set ResetWait value common for both CADC in a vertical half. More...

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

Static Public Attributes
static constexpr size_t	config_size_in_words = 1

Protected Member Functions
template<typename Archive >
void	serialize (Archive &ar, std::uint32_t const version) SYMBOL_VISIBLE

Protected Attributes
DeadTime	m_dead_time
bool	m_enable
ResetWait	m_reset_wait

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

Detailed Description

CADC container with global digital config for a vertical half.

Definition at line 29 of file cadc.h.

Member Typedef Documentation

coordinate_type

typedef halco::hicann_dls::vx::CADCConfigOnDLS haldls::vx::CADCConfig::coordinate_type

Definition at line 33 of file cadc.h.

is_leaf_node

typedef std::true_type haldls::vx::CADCConfig::is_leaf_node

Definition at line 32 of file cadc.h.

Constructor & Destructor Documentation

CADCConfig()

haldls::vx::CADCConfig::CADCConfig

(

)

Default constructor.

Member Function Documentation

addresses()

template<typename AddressT >

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

static

decode()

template<typename WordT >

void haldls::vx::CADCConfig::decode

(

std::array< WordT, config_size_in_words > const &

data

)

encode()

template<typename WordT >

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

(

)

const

get_dead_time()

DeadTime haldls::vx::CADCConfig::get_dead_time

(

)

const

Get DeadTime value common for both CADC in a vertical half.

Returns

DeadTime value

get_enable()

bool haldls::vx::CADCConfig::get_enable

(

)

const

Get enable value for the CADC.

Returns

Boolean value

get_reset_wait()

ResetWait haldls::vx::CADCConfig::get_reset_wait

(

)

const

Get ResetWait value common for both CADC in a vertical half.

Returns

ResetWait value

operator!=()

bool haldls::vx::CADCConfig::operator!=

(

CADCConfig const &

other

)

const

operator==()

bool haldls::vx::CADCConfig::operator==

(

CADCConfig const &

other

)

const

serialize()

template<typename Archive >

void haldls::vx::CADCConfig::serialize ( Archive &  ar, std::uint32_t const  version  )

protected

set_dead_time()

void haldls::vx::CADCConfig::set_dead_time

(

DeadTime

value

)

Set DeadTime value common for both CADC in a vertical half.

Parameters

value

DeadTime value

set_enable()

void haldls::vx::CADCConfig::set_enable

(

bool

value

)

Set enable value for the CADC.

Parameters

value

Boolean value

set_reset_wait()

void haldls::vx::CADCConfig::set_reset_wait

(

ResetWait

value

)

Set ResetWait value common for both CADC in a vertical half.

Parameters

value

ResetWait value

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Definition at line 122 of file cadc.h.

operator<<

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

friend

Member Data Documentation

config_size_in_words

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

staticconstexpr

Definition at line 111 of file cadc.h.

m_dead_time

DeadTime haldls::vx::CADCConfig::m_dead_time

protected

Definition at line 128 of file cadc.h.

m_enable

bool haldls::vx::CADCConfig::m_enable

protected

Definition at line 126 of file cadc.h.

m_reset_wait

ResetWait haldls::vx::CADCConfig::m_reset_wait

protected

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