haldls::vx::TCA9554Config Class Reference

#include <i2c.h>

Public Types
enum class	ChannelMode : bool { output = false , input = true }
enum class	ChannelPolarity : bool { normal = false , inverted = true }
typedef halco::common::typed_array< bool, halco::hicann_dls::vx::TCA9554ChannelOnBoard >	ChannelsBooleanArray
typedef halco::common::typed_array< ChannelMode, halco::hicann_dls::vx::TCA9554ChannelOnBoard >	ChannelsModeArray
typedef halco::common::typed_array< ChannelPolarity, halco::hicann_dls::vx::TCA9554ChannelOnBoard >	ChannelsPolarityArray
typedef halco::hicann_dls::vx::TCA9554ConfigOnBoard	coordinate_type
typedef std::true_type	is_leaf_node

Public Member Functions
	TCA9554Config () SYMBOL_VISIBLE
	Default constructor. More...
void	decode (std::array< fisch::vx::word_access_type::I2CTCA9554RwRegister, config_size_in_words > const &data) SYMBOL_VISIBLE
std::array< fisch::vx::word_access_type::I2CTCA9554RwRegister, config_size_in_words >	encode () const SYMBOL_VISIBLE
bool	operator!= (TCA9554Config const &other) const SYMBOL_VISIBLE
bool	operator== (TCA9554Config const &other) const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) ChannelsBooleanArray const &get_channel_output() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) ChannelsModeArray const &get_channel_mode() const SYMBOL_VISIBLE
	return_value_policy (reference_internal)) ChannelsPolarityArray const &get_channel_polarity() const SYMBOL_VISIBLE
void	set_channel_mode (ChannelsModeArray const &value) SYMBOL_VISIBLE
	Set input/output mode for all channels. More...
void	set_channel_output (ChannelsBooleanArray const &value) SYMBOL_VISIBLE
	Set output value for all channels. More...
void	set_channel_polarity (ChannelsPolarityArray const &value) SYMBOL_VISIBLE
	Set polarity inversion mode of all channels. More...

Static Public Member Functions
static std::array< halco::hicann_dls::vx::I2CTCA9554RwRegisterOnBoard, config_size_in_words >	addresses (coordinate_type const &coord) SYMBOL_VISIBLE

Static Public Attributes
static constexpr size_t	config_size_in_words = 3
constexpr static auto	unsupported_read_targets

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

Detailed Description

Definition at line 341 of file i2c.h.

Member Typedef Documentation

ChannelsBooleanArray

typedef halco::common:: typed_array<bool, halco::hicann_dls::vx::TCA9554ChannelOnBoard> haldls::vx::TCA9554Config::ChannelsBooleanArray

Definition at line 362 of file i2c.h.

ChannelsModeArray

typedef halco::common:: typed_array<ChannelMode, halco::hicann_dls::vx::TCA9554ChannelOnBoard> haldls::vx::TCA9554Config::ChannelsModeArray

Definition at line 367 of file i2c.h.

ChannelsPolarityArray

typedef halco::common::typed_array< ChannelPolarity, halco::hicann_dls::vx::TCA9554ChannelOnBoard> haldls::vx::TCA9554Config::ChannelsPolarityArray

Definition at line 365 of file i2c.h.

coordinate_type

typedef halco::hicann_dls::vx::TCA9554ConfigOnBoard haldls::vx::TCA9554Config::coordinate_type

Definition at line 344 of file i2c.h.

is_leaf_node

typedef std::true_type haldls::vx::TCA9554Config::is_leaf_node

Definition at line 345 of file i2c.h.

Member Enumeration Documentation

ChannelMode

enum haldls::vx::TCA9554Config::ChannelMode : bool

strong

Enumerator
output
input

Definition at line 355 of file i2c.h.

ChannelPolarity

enum haldls::vx::TCA9554Config::ChannelPolarity : bool

strong

Enumerator
normal
inverted

Definition at line 349 of file i2c.h.

Constructor & Destructor Documentation

TCA9554Config()

haldls::vx::TCA9554Config::TCA9554Config

(

)

Default constructor.

Member Function Documentation

addresses()

static std::array<halco::hicann_dls::vx::I2CTCA9554RwRegisterOnBoard, config_size_in_words> haldls::vx::TCA9554Config::addresses ( coordinate_type const &  coord )

static

decode()

void haldls::vx::TCA9554Config::decode

(

std::array< fisch::vx::word_access_type::I2CTCA9554RwRegister, config_size_in_words > const &

data

)

encode()

std::array<fisch::vx::word_access_type::I2CTCA9554RwRegister, config_size_in_words> haldls::vx::TCA9554Config::encode

(

)

const

operator!=()

bool haldls::vx::TCA9554Config::operator!=

(

TCA9554Config const &

other

)

const

operator==()

bool haldls::vx::TCA9554Config::operator==

(

TCA9554Config const &

other

)

const

return_value_policy() [1/3]

haldls::vx::TCA9554Config::return_value_policy

(

reference_internal

)

const &

return_value_policy() [2/3]

haldls::vx::TCA9554Config::return_value_policy

(

reference_internal

)

const &

return_value_policy() [3/3]

haldls::vx::TCA9554Config::return_value_policy

(

reference_internal

)

const &

set_channel_mode()

void haldls::vx::TCA9554Config::set_channel_mode

(

ChannelsModeArray const &

value

)

Set input/output mode for all channels.

Parameters

value

Array of channel input/output modes

set_channel_output()

void haldls::vx::TCA9554Config::set_channel_output

(

ChannelsBooleanArray const &

value

)

Set output value for all channels.

Parameters

value

Array of output values

set_channel_polarity()

void haldls::vx::TCA9554Config::set_channel_polarity

(

ChannelsPolarityArray const &

value

)

Set polarity inversion mode of all channels.

Parameters

value

Array of polarity inversion modes

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Definition at line 430 of file i2c.h.

operator<<

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

friend

Member Data Documentation

config_size_in_words

constexpr size_t haldls::vx::TCA9554Config::config_size_in_words = 3

staticconstexpr

Definition at line 420 of file i2c.h.

unsupported_read_targets

constexpr static auto haldls::vx::TCA9554Config::unsupported_read_targets

staticconstexpr

Initial value:

= {
        hxcomm::vx::Target::simulation}

Definition at line 346 of file i2c.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/i2c.h