HALDLS
haldls::vx::CADCChannelConfig Class Reference

CADC container with channel-local digital offset config. More...

#include <cadc.h>

+ Collaboration diagram for haldls::vx::CADCChannelConfig:

Classes

struct  Offset
 Offset value to add to measurement. More...
 

Public Types

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

Public Member Functions

 CADCChannelConfig ()
 Default constructor. More...
 
template<typename WordT >
void decode (std::array< WordT, config_size_in_words > const &data)
 
template<typename WordT >
std::array< WordT, config_size_in_wordsencode () const
 
Offset get_offset () const
 Get Offset value. More...
 
bool operator!= (CADCChannelConfig const &other) const
 
bool operator== (CADCChannelConfig const &other) const
 
void set_offset (Offset value)
 Set Offset value. More...
 

Static Public Member Functions

template<typename AddressT >
static std::array< AddressT, config_size_in_wordsaddresses (coordinate_type const &word)
 

Static Public Attributes

static constexpr size_t config_size_in_words = 1
 
constexpr static auto unsupported_read_targets
 

Protected Member Functions

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

Protected Attributes

Offset m_offset
 

Friends

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

Detailed Description

CADC container with channel-local digital offset config.

Definition at line 148 of file cadc.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::CADCChannelConfigOnDLS haldls::vx::CADCChannelConfig::coordinate_type

Definition at line 152 of file cadc.h.

◆ is_leaf_node

Definition at line 151 of file cadc.h.

Constructor & Destructor Documentation

◆ CADCChannelConfig()

haldls::vx::CADCChannelConfig::CADCChannelConfig ( )

Default constructor.

Member Function Documentation

◆ addresses()

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

◆ decode()

template<typename WordT >
void haldls::vx::CADCChannelConfig::decode ( std::array< WordT, config_size_in_words > const &  data)

◆ encode()

template<typename WordT >
std::array<WordT, config_size_in_words> haldls::vx::CADCChannelConfig::encode ( ) const

◆ get_offset()

Offset haldls::vx::CADCChannelConfig::get_offset ( ) const

Get Offset value.

Returns
Offset value

◆ operator!=()

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

◆ operator==()

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

◆ serialize()

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

◆ set_offset()

void haldls::vx::CADCChannelConfig::set_offset ( Offset  value)

Set Offset value.

Parameters
valueOffset value

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access
friend

Definition at line 207 of file cadc.h.

◆ operator<<

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

Definition at line 191 of file cadc.h.

Member Data Documentation

◆ config_size_in_words

constexpr size_t haldls::vx::CADCChannelConfig::config_size_in_words = 1
staticconstexpr

Definition at line 197 of file cadc.h.

◆ m_offset

Offset haldls::vx::CADCChannelConfig::m_offset
protected

Definition at line 211 of file cadc.h.

◆ unsupported_read_targets

constexpr static auto haldls::vx::CADCChannelConfig::unsupported_read_targets
staticconstexpr
Initial value:
= {
hxcomm::vx::Target::hardware}

Definition at line 154 of file cadc.h.


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