ReferenceGeneratorConfig Class Reference

#include <capmem.h>

Classes
struct	CapMemAmplifier
struct	CapMemOffset
struct	CapMemSlope
struct	ReferenceControl
struct	ResistorControl

Public Types
typedef halco::common::typed_array< CapMemAmplifier, halco::hicann_dls::vx::CapMemBlockOnDLS >	capmem_amplifier_type
typedef halco::common::typed_array< CapMemAmplifier, halco::hicann_dls::vx::CapMemBlockOnDLS >	capmem_amplifier_type
typedef halco::common::typed_array< CapMemOffset, halco::hicann_dls::vx::CapMemBlockOnDLS >	capmem_offset_type
typedef halco::common::typed_array< CapMemOffset, halco::hicann_dls::vx::CapMemBlockOnDLS >	capmem_offset_type
typedef halco::common::typed_array< CapMemSlope, halco::hicann_dls::vx::CapMemBlockOnDLS >	capmem_slope_type
typedef halco::common::typed_array< CapMemSlope, halco::hicann_dls::vx::CapMemBlockOnDLS >	capmem_slope_type
typedef halco::hicann_dls::vx::ReferenceGeneratorConfigOnDLS	coordinate_type
typedef halco::hicann_dls::vx::ReferenceGeneratorConfigOnDLS	coordinate_type
typedef std::true_type	is_leaf_node
typedef std::true_type	is_leaf_node

Public Member Functions
	ReferenceGeneratorConfig () SYMBOL_VISIBLE
	Default config of reference generator. More...
	ReferenceGeneratorConfig () SYMBOL_VISIBLE
	Default config of reference generator. More...
template<typename WordT >
void	decode (std::array< WordT, config_size_in_words > const &data) SYMBOL_VISIBLE
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
template<typename WordT >
std::array< WordT, config_size_in_words >	encode () const SYMBOL_VISIBLE
bool const &	get_enable_internal_reference () const SYMBOL_VISIBLE
	Set enable for internal reference current generation. More...
bool const &	get_enable_internal_reference () const SYMBOL_VISIBLE
	Set enable for internal reference current generation. More...
bool const &	get_enable_reference_input () const SYMBOL_VISIBLE
	Set enable for input of reference current from pad. More...
bool const &	get_enable_reference_input () const SYMBOL_VISIBLE
	Set enable for input of reference current from pad. More...
bool const &	get_enable_reference_output () const SYMBOL_VISIBLE
	Set enable for output of reference current to pad. More...
bool const &	get_enable_reference_output () const SYMBOL_VISIBLE
	Set enable for output of reference current to pad. More...
bool const &	get_enable_reset () const SYMBOL_VISIBLE
	Set reset signal for resistor control of reference current generation. More...
bool const &	get_enable_reset () const SYMBOL_VISIBLE
	Set reset signal for resistor control of reference current generation. More...
ReferenceControl	get_reference_control () const SYMBOL_VISIBLE
	Set reference current generation DAC value. More...
ReferenceControl	get_reference_control () const SYMBOL_VISIBLE
	Set reference current generation DAC value. More...
ResistorControl	get_resistor_control () const SYMBOL_VISIBLE
	Set reference current generation resistor value. More...
ResistorControl	get_resistor_control () const SYMBOL_VISIBLE
	Set reference current generation resistor value. More...
bool	operator!= (ReferenceGeneratorConfig const &other) const SYMBOL_VISIBLE
bool	operator!= (ReferenceGeneratorConfig const &other) const SYMBOL_VISIBLE
bool	operator== (ReferenceGeneratorConfig const &other) const SYMBOL_VISIBLE
bool	operator== (ReferenceGeneratorConfig const &other) const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) capmem_amplifier_type const &get_capmem_amplifier() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) capmem_amplifier_type const &get_capmem_amplifier() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) capmem_offset_type const &get_capmem_offset() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) capmem_offset_type const &get_capmem_offset() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) capmem_slope_type const &get_capmem_slope() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) capmem_slope_type const &get_capmem_slope() const SYMBOL_VISIBLE
void	set_capmem_amplifier (capmem_amplifier_type const &value) SYMBOL_VISIBLE
void	set_capmem_amplifier (capmem_amplifier_type const &value) SYMBOL_VISIBLE
void	set_capmem_offset (capmem_offset_type const &value) SYMBOL_VISIBLE
void	set_capmem_offset (capmem_offset_type const &value) SYMBOL_VISIBLE
void	set_capmem_slope (capmem_slope_type const &value) SYMBOL_VISIBLE
void	set_capmem_slope (capmem_slope_type const &value) SYMBOL_VISIBLE
void	set_enable_internal_reference (bool value) SYMBOL_VISIBLE
void	set_enable_internal_reference (bool value) SYMBOL_VISIBLE
void	set_enable_reference_input (bool value) SYMBOL_VISIBLE
void	set_enable_reference_input (bool value) SYMBOL_VISIBLE
void	set_enable_reference_output (bool value) SYMBOL_VISIBLE
void	set_enable_reference_output (bool value) SYMBOL_VISIBLE
void	set_enable_reset (bool value) SYMBOL_VISIBLE
void	set_enable_reset (bool value) SYMBOL_VISIBLE
void	set_reference_control (ReferenceControl value) SYMBOL_VISIBLE
void	set_reference_control (ReferenceControl value) SYMBOL_VISIBLE
void	set_resistor_control (ResistorControl value) SYMBOL_VISIBLE
void	set_resistor_control (ResistorControl value) SYMBOL_VISIBLE

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

Static Public Attributes
static constexpr size_t	config_size_in_words = 9

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

Detailed Description

Definition at line 41 of file capmem.h.

Member Typedef Documentation

capmem_amplifier_type [1/2]

typedef halco::common::typed_array<CapMemAmplifier, halco::hicann_dls::vx::CapMemBlockOnDLS> ReferenceGeneratorConfig::capmem_amplifier_type

Definition at line 94 of file capmem.h.

capmem_amplifier_type [2/2]

typedef halco::common::typed_array<CapMemAmplifier, halco::hicann_dls::vx::CapMemBlockOnDLS> ReferenceGeneratorConfig::capmem_amplifier_type

Definition at line 94 of file capmem.h.

capmem_offset_type [1/2]

typedef halco::common::typed_array<CapMemOffset, halco::hicann_dls::vx::CapMemBlockOnDLS> ReferenceGeneratorConfig::capmem_offset_type

Definition at line 96 of file capmem.h.

capmem_offset_type [2/2]

typedef halco::common::typed_array<CapMemOffset, halco::hicann_dls::vx::CapMemBlockOnDLS> ReferenceGeneratorConfig::capmem_offset_type

Definition at line 96 of file capmem.h.

capmem_slope_type [1/2]

typedef halco::common::typed_array<CapMemSlope, halco::hicann_dls::vx::CapMemBlockOnDLS> ReferenceGeneratorConfig::capmem_slope_type

Definition at line 98 of file capmem.h.

capmem_slope_type [2/2]

typedef halco::common::typed_array<CapMemSlope, halco::hicann_dls::vx::CapMemBlockOnDLS> ReferenceGeneratorConfig::capmem_slope_type

Definition at line 98 of file capmem.h.

coordinate_type [1/2]

typedef halco::hicann_dls::vx::ReferenceGeneratorConfigOnDLS ReferenceGeneratorConfig::coordinate_type

Definition at line 44 of file capmem.h.

coordinate_type [2/2]

typedef halco::hicann_dls::vx::ReferenceGeneratorConfigOnDLS ReferenceGeneratorConfig::coordinate_type

Definition at line 44 of file capmem.h.

is_leaf_node [1/2]

typedef std::true_type ReferenceGeneratorConfig::is_leaf_node

Definition at line 45 of file capmem.h.

is_leaf_node [2/2]

typedef std::true_type ReferenceGeneratorConfig::is_leaf_node

Definition at line 45 of file capmem.h.

Constructor & Destructor Documentation

ReferenceGeneratorConfig() [1/2]

ReferenceGeneratorConfig::ReferenceGeneratorConfig ( )

explicit

Default config of reference generator.

ReferenceGeneratorConfig() [2/2]

ReferenceGeneratorConfig::ReferenceGeneratorConfig ( )

explicit

Default config of reference generator.

Member Function Documentation

addresses() [1/2]

template<typename AddressT >

static std::array<AddressT, config_size_in_words> ReferenceGeneratorConfig::addresses ( coordinate_type const &  coord )

static

addresses() [2/2]

template<typename AddressT >

static std::array<AddressT, config_size_in_words> ReferenceGeneratorConfig::addresses ( coordinate_type const &  coord )

static

decode() [1/2]

template<typename WordT >

void ReferenceGeneratorConfig::decode

(

std::array< WordT, config_size_in_words > const &

data

)

decode() [2/2]

template<typename WordT >

void ReferenceGeneratorConfig::decode

(

std::array< WordT, config_size_in_words > const &

data

)

encode() [1/2]

template<typename WordT >

std::array<WordT, config_size_in_words> ReferenceGeneratorConfig::encode

(

)

const

encode() [2/2]

template<typename WordT >

std::array<WordT, config_size_in_words> ReferenceGeneratorConfig::encode

(

)

const

get_enable_internal_reference() [1/2]

bool const& ReferenceGeneratorConfig::get_enable_internal_reference

(

)

const

Set enable for internal reference current generation.

get_enable_internal_reference() [2/2]

bool const& ReferenceGeneratorConfig::get_enable_internal_reference

(

)

const

Set enable for internal reference current generation.

get_enable_reference_input() [1/2]

bool const& ReferenceGeneratorConfig::get_enable_reference_input

(

)

const

Set enable for input of reference current from pad.

get_enable_reference_input() [2/2]

bool const& ReferenceGeneratorConfig::get_enable_reference_input

(

)

const

Set enable for input of reference current from pad.

get_enable_reference_output() [1/2]

bool const& ReferenceGeneratorConfig::get_enable_reference_output

(

)

const

Set enable for output of reference current to pad.

get_enable_reference_output() [2/2]

bool const& ReferenceGeneratorConfig::get_enable_reference_output

(

)

const

Set enable for output of reference current to pad.

get_enable_reset() [1/2]

bool const& ReferenceGeneratorConfig::get_enable_reset

(

)

const

Set reset signal for resistor control of reference current generation.

The reset can be used after powerup to reach a working state.

get_enable_reset() [2/2]

bool const& ReferenceGeneratorConfig::get_enable_reset

(

)

const

Set reset signal for resistor control of reference current generation.

The reset can be used after powerup to reach a working state.

get_reference_control() [1/2]

ReferenceControl ReferenceGeneratorConfig::get_reference_control

(

)

const

Set reference current generation DAC value.

get_reference_control() [2/2]

ReferenceControl ReferenceGeneratorConfig::get_reference_control

(

)

const

Set reference current generation DAC value.

get_resistor_control() [1/2]

ResistorControl ReferenceGeneratorConfig::get_resistor_control

(

)

const

Set reference current generation resistor value.

get_resistor_control() [2/2]

ResistorControl ReferenceGeneratorConfig::get_resistor_control

(

)

const

Set reference current generation resistor value.

operator!=() [1/2]

bool ReferenceGeneratorConfig::operator!=

(

ReferenceGeneratorConfig const &

other

)

const

operator!=() [2/2]

bool ReferenceGeneratorConfig::operator!=

(

ReferenceGeneratorConfig const &

other

)

const

operator==() [1/2]

bool ReferenceGeneratorConfig::operator==

(

ReferenceGeneratorConfig const &

other

)

const

operator==() [2/2]

bool ReferenceGeneratorConfig::operator==

(

ReferenceGeneratorConfig const &

other

)

const

return_value_policy() [1/6]

ReferenceGeneratorConfig::return_value_policy

(

reference_internal

)

const &

return_value_policy() [2/6]

ReferenceGeneratorConfig::return_value_policy

(

reference_internal

)

const &

return_value_policy() [3/6]

ReferenceGeneratorConfig::return_value_policy

(

reference_internal

)

const &

return_value_policy() [4/6]

ReferenceGeneratorConfig::return_value_policy

(

reference_internal

)

const &

return_value_policy() [5/6]

ReferenceGeneratorConfig::return_value_policy

(

reference_internal

)

const &

return_value_policy() [6/6]

ReferenceGeneratorConfig::return_value_policy

(

reference_internal

)

const &

set_capmem_amplifier() [1/2]

void ReferenceGeneratorConfig::set_capmem_amplifier

(

capmem_amplifier_type const &

value

)

set_capmem_amplifier() [2/2]

void ReferenceGeneratorConfig::set_capmem_amplifier

(

capmem_amplifier_type const &

value

)

set_capmem_offset() [1/2]

void ReferenceGeneratorConfig::set_capmem_offset

(

capmem_offset_type const &

value

)

set_capmem_offset() [2/2]

void ReferenceGeneratorConfig::set_capmem_offset

(

capmem_offset_type const &

value

)

set_capmem_slope() [1/2]

void ReferenceGeneratorConfig::set_capmem_slope

(

capmem_slope_type const &

value

)

set_capmem_slope() [2/2]

void ReferenceGeneratorConfig::set_capmem_slope

(

capmem_slope_type const &

value

)

set_enable_internal_reference() [1/2]

void ReferenceGeneratorConfig::set_enable_internal_reference

(

bool

value

)

set_enable_internal_reference() [2/2]

void ReferenceGeneratorConfig::set_enable_internal_reference

(

bool

value

)

set_enable_reference_input() [1/2]

void ReferenceGeneratorConfig::set_enable_reference_input

(

bool

value

)

set_enable_reference_input() [2/2]

void ReferenceGeneratorConfig::set_enable_reference_input

(

bool

value

)

set_enable_reference_output() [1/2]

void ReferenceGeneratorConfig::set_enable_reference_output

(

bool

value

)

set_enable_reference_output() [2/2]

void ReferenceGeneratorConfig::set_enable_reference_output

(

bool

value

)

set_enable_reset() [1/2]

void ReferenceGeneratorConfig::set_enable_reset

(

bool

value

)

set_enable_reset() [2/2]

void ReferenceGeneratorConfig::set_enable_reset

(

bool

value

)

set_reference_control() [1/2]

void ReferenceGeneratorConfig::set_reference_control

(

ReferenceControl

value

)

set_reference_control() [2/2]

void ReferenceGeneratorConfig::set_reference_control

(

ReferenceControl

value

)

set_resistor_control() [1/2]

void ReferenceGeneratorConfig::set_resistor_control

(

ResistorControl

value

)

set_resistor_control() [2/2]

void ReferenceGeneratorConfig::set_resistor_control

(

ResistorControl

value

)

Friends And Related Function Documentation

cereal::access

cereal::access

friend

Definition at line 176 of file capmem.h.

operator<< [1/2]

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

friend

operator<< [2/2]

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

friend

Member Data Documentation

config_size_in_words

static constexpr size_t ReferenceGeneratorConfig::config_size_in_words = 9

staticconstexpr

Definition at line 158 of file capmem.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/v2/capmem.h