HALDLS
haldls::vx::MADCControl Class Reference

Container for MADC control state machine. More...

#include <madc.h>

Public Types

typedef halco::hicann_dls::vx::MADCControlOnDLS coordinate_type
 
typedef std::true_type is_leaf_node
 

Public Member Functions

 MADCControl () SYMBOL_VISIBLE
 
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_wordsencode () const SYMBOL_VISIBLE
 
bool get_enable_continuous_sampling () const SYMBOL_VISIBLE
 Let the MADC sample continuously. More...
 
bool get_enable_iconv_amplifier () const SYMBOL_VISIBLE
 Enable switched capacitor amplifier for current measurements. More...
 
bool get_enable_power_down_after_sampling () const SYMBOL_VISIBLE
 Let the MADC power down after it finished sampling. More...
 
bool get_enable_pre_amplifier () const SYMBOL_VISIBLE
 Enable switched capacitor pre-amplifier for voltage measurements. More...
 
bool get_start_recording () const SYMBOL_VISIBLE
 Start a recording. More...
 
bool get_stop_recording () const SYMBOL_VISIBLE
 Stop a currently active recording. More...
 
bool get_wake_up () const SYMBOL_VISIBLE
 Wake up the MADC. More...
 
bool operator!= (MADCControl const &other) const SYMBOL_VISIBLE
 
bool operator== (MADCControl const &other) const SYMBOL_VISIBLE
 
void set_enable_continuous_sampling (bool const value) SYMBOL_VISIBLE
 
void set_enable_iconv_amplifier (bool const value) SYMBOL_VISIBLE
 
void set_enable_power_down_after_sampling (bool const value) SYMBOL_VISIBLE
 
void set_enable_pre_amplifier (bool const value) SYMBOL_VISIBLE
 
void set_start_recording (bool const value) SYMBOL_VISIBLE
 
void set_stop_recording (bool const value) SYMBOL_VISIBLE
 
void set_wake_up (bool const value) SYMBOL_VISIBLE
 

Static Public Member Functions

template<typename AddressT >
static std::array< AddressT, read_config_size_in_wordsread_addresses (coordinate_type const &coord) SYMBOL_VISIBLE
 
template<typename AddressT >
static std::array< AddressT, write_config_size_in_wordswrite_addresses (coordinate_type const &coord) 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, MADCControl const &event) SYMBOL_VISIBLE
 

Detailed Description

Container for MADC control state machine.

Flow chart of state machine: https://chat.bioai.eu/visions/pl/s4o4mq36xtyeigtzkw9kgfihcc FIXME: Add more explanatory description (issue #3471)

Definition at line 30 of file madc.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::MADCControlOnDLS haldls::vx::MADCControl::coordinate_type

Definition at line 33 of file madc.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::MADCControl::is_leaf_node

Definition at line 34 of file madc.h.

Constructor & Destructor Documentation

◆ MADCControl()

haldls::vx::MADCControl::MADCControl ( )

Member Function Documentation

◆ decode()

template<typename WordT >
void haldls::vx::MADCControl::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::MADCControl::encode ( ) const

◆ get_enable_continuous_sampling()

bool haldls::vx::MADCControl::get_enable_continuous_sampling ( ) const

Let the MADC sample continuously.

◆ get_enable_iconv_amplifier()

bool haldls::vx::MADCControl::get_enable_iconv_amplifier ( ) const

Enable switched capacitor amplifier for current measurements.

◆ get_enable_power_down_after_sampling()

bool haldls::vx::MADCControl::get_enable_power_down_after_sampling ( ) const

Let the MADC power down after it finished sampling.

◆ get_enable_pre_amplifier()

bool haldls::vx::MADCControl::get_enable_pre_amplifier ( ) const

Enable switched capacitor pre-amplifier for voltage measurements.

◆ get_start_recording()

bool haldls::vx::MADCControl::get_start_recording ( ) const

Start a recording.

◆ get_stop_recording()

bool haldls::vx::MADCControl::get_stop_recording ( ) const

Stop a currently active recording.

◆ get_wake_up()

bool haldls::vx::MADCControl::get_wake_up ( ) const

Wake up the MADC.

◆ operator!=()

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

◆ operator==()

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

◆ read_addresses()

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

◆ set_enable_continuous_sampling()

void haldls::vx::MADCControl::set_enable_continuous_sampling ( bool const  value)

◆ set_enable_iconv_amplifier()

void haldls::vx::MADCControl::set_enable_iconv_amplifier ( bool const  value)

◆ set_enable_power_down_after_sampling()

void haldls::vx::MADCControl::set_enable_power_down_after_sampling ( bool const  value)

◆ set_enable_pre_amplifier()

void haldls::vx::MADCControl::set_enable_pre_amplifier ( bool const  value)

◆ set_start_recording()

void haldls::vx::MADCControl::set_start_recording ( bool const  value)

◆ set_stop_recording()

void haldls::vx::MADCControl::set_stop_recording ( bool const  value)

◆ set_wake_up()

void haldls::vx::MADCControl::set_wake_up ( bool const  value)

◆ write_addresses()

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

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access
friend

Definition at line 103 of file madc.h.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
MADCControl const &  event 
)
friend

Member Data Documentation

◆ read_config_size_in_words

constexpr size_t haldls::vx::MADCControl::read_config_size_in_words = 0
staticconstexpr

Definition at line 86 of file madc.h.

◆ write_config_size_in_words

constexpr size_t haldls::vx::MADCControl::write_config_size_in_words = 1
staticconstexpr

Definition at line 85 of file madc.h.


The documentation for this class was generated from the following file: