HALDLS
haldls::vx::CADCSampleQuad Class Reference

CADC container of four CADC samples. More...

#include <cadc.h>

Classes

struct  Value
 CADC measurement value (offset-corrected, see CADCChannelConfig). More...
 

Public Types

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

Public Member Functions

 CADCSampleQuad () 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_wordsencode () const SYMBOL_VISIBLE
 
Value get_sample (halco::hicann_dls::vx::EntryOnQuad const &coord) const SYMBOL_VISIBLE
 Get sample value. More...
 
bool operator!= (CADCSampleQuad const &other) const SYMBOL_VISIBLE
 
bool operator== (CADCSampleQuad const &other) const SYMBOL_VISIBLE
 
void set_sample (halco::hicann_dls::vx::EntryOnQuad const &coord, Value value) SYMBOL_VISIBLE
 Set sample value. More...
 

Static Public Member Functions

static std::array< halco::hicann_dls::vx::OmnibusAddress, read_config_size_in_wordsread_addresses (coordinate_type const &word) SYMBOL_VISIBLE
 
static std::array< halco::hicann_dls::vx::OmnibusAddress, write_config_size_in_wordswrite_addresses (coordinate_type const &word) 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
 

Protected Member Functions

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

Protected Attributes

halco::common::typed_array< Value, halco::hicann_dls::vx::EntryOnQuad > m_samples
 

Friends

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

Detailed Description

CADC container of four CADC samples.

Definition at line 268 of file cadc.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::CADCSampleQuadOnDLS haldls::vx::CADCSampleQuad::coordinate_type

Definition at line 272 of file cadc.h.

◆ is_leaf_node

Definition at line 271 of file cadc.h.

Constructor & Destructor Documentation

◆ CADCSampleQuad()

haldls::vx::CADCSampleQuad::CADCSampleQuad ( )

Default constructor.

Member Function Documentation

◆ decode()

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

◆ get_sample()

Value haldls::vx::CADCSampleQuad::get_sample ( halco::hicann_dls::vx::EntryOnQuad const &  coord) const

Get sample value.

Parameters
coordSample on quad coordinate
Returns
Value value

◆ operator!=()

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

◆ operator==()

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

◆ read_addresses()

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

◆ serialize()

template<typename Archive >
void haldls::vx::CADCSampleQuad::serialize ( Archive &  ar,
std::uint32_t const  version 
)
protected

◆ set_sample()

void haldls::vx::CADCSampleQuad::set_sample ( halco::hicann_dls::vx::EntryOnQuad const &  coord,
Value  value 
)

Set sample value.

Parameters
coordSample on quad coordinate
valueValue value

◆ write_addresses()

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

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access
friend

Definition at line 320 of file cadc.h.

◆ operator<<

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

Member Data Documentation

◆ m_samples

halco::common::typed_array<Value, halco::hicann_dls::vx::EntryOnQuad> haldls::vx::CADCSampleQuad::m_samples
protected

Definition at line 324 of file cadc.h.

◆ read_config_size_in_words

constexpr size_t haldls::vx::CADCSampleQuad::read_config_size_in_words = 1
staticconstexpr

Definition at line 308 of file cadc.h.

◆ write_config_size_in_words

constexpr size_t haldls::vx::CADCSampleQuad::write_config_size_in_words = 0
staticconstexpr

Definition at line 309 of file cadc.h.


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