HALDLS
haldls::vx::DACChannel Class Reference

Container for individual configuration of the value of a DAC channel of the xBoard DACs. More...

#include <spi.h>

+ Inheritance diagram for haldls::vx::DACChannel:
+ Collaboration diagram for haldls::vx::DACChannel:

Classes

struct  Value
 

Public Types

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

Public Member Functions

 DACChannel (Value const &value=Value())
 Construct DAC channel with value. More...
 
void decode (std::array< fisch::vx::word_access_type::SPIDACDataRegister, read_config_size_in_words > const &data) SYMBOL_VISIBLE
 
std::array< fisch::vx::word_access_type::SPIDACDataRegister, write_config_size_in_wordsencode () const SYMBOL_VISIBLE
 
Value get_value () const SYMBOL_VISIBLE
 Get DAC channel value. More...
 
bool operator!= (DACChannel const &other) const SYMBOL_VISIBLE
 
bool operator== (DACChannel const &other) const SYMBOL_VISIBLE
 
void set_value (Value value) SYMBOL_VISIBLE
 Set DAC channel value. More...
 

Static Public Member Functions

static std::array< halco::hicann_dls::vx::SPIDACDataRegisterOnBoard, read_config_size_in_wordsread_addresses (coordinate_type const &coord) SYMBOL_VISIBLE
 
static std::array< halco::hicann_dls::vx::SPIDACDataRegisterOnBoard, 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, DACChannel const &config) SYMBOL_VISIBLE
 

Detailed Description

Container for individual configuration of the value of a DAC channel of the xBoard DACs.

Definition at line 286 of file spi.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::DACChannelOnBoard haldls::vx::DACChannel::coordinate_type

Definition at line 289 of file spi.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::DACChannel::is_leaf_node

Definition at line 290 of file spi.h.

Constructor & Destructor Documentation

◆ DACChannel()

haldls::vx::DACChannel::DACChannel ( Value const &  value = Value())
inline

Construct DAC channel with value.

Parameters
valueValue to construct with

Definition at line 305 of file spi.h.

Member Function Documentation

◆ decode()

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

◆ encode()

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

◆ get_value()

Value haldls::vx::DACChannel::get_value ( ) const

Get DAC channel value.

Returns
Value to get

◆ operator!=()

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

◆ operator==()

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

◆ read_addresses()

static std::array<halco::hicann_dls::vx::SPIDACDataRegisterOnBoard, read_config_size_in_words> haldls::vx::DACChannel::read_addresses ( coordinate_type const &  coord)
static

◆ set_value()

void haldls::vx::DACChannel::set_value ( Value  value)

Set DAC channel value.

Parameters
valueValue to set

◆ write_addresses()

static std::array<halco::hicann_dls::vx::SPIDACDataRegisterOnBoard, write_config_size_in_words> haldls::vx::DACChannel::write_addresses ( coordinate_type const &  coord)
static

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access
friend

Definition at line 340 of file spi.h.

◆ operator<<

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

Member Data Documentation

◆ read_config_size_in_words

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

Definition at line 328 of file spi.h.

◆ write_config_size_in_words

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

Definition at line 327 of file spi.h.


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