itk::RegMem< T > Class Template Reference

Interface definition for register memory. More...

#include <concepts.hpp>

Public Types
using	reg_t = T
using	reg_t = T

Public Member Functions
virtual	~RegMem ()=default
	Default destructor.
virtual reg_t	get_mem (uint16_t addr) const =0
	Get a value from memory. More...
virtual void	set_mem (uint16_t addr, reg_t val)=0
	Set a value into memory. More...
virtual reg_t	get_mem_bits (uint16_t addr, uint8_t low, uint8_t num) const =0
	Get bits from memory. More...
virtual void	set_mem_bits (uint16_t addr, uint8_t low, uint8_t num, reg_t val)=0
	Set bits to memory. More...
virtual void	reset ()=0
	Reset memory.
virtual	~RegMem ()=default
	Default destructor.
virtual reg_t	get_mem (uint16_t addr) const =0
	Get a value from memory. More...
virtual void	set_mem (uint16_t addr, reg_t val)=0
	Set a value into memory. More...
virtual reg_t	get_mem_bits (uint16_t addr, uint8_t low, uint8_t num) const =0
	Get bits from memory. More...
virtual void	set_mem_bits (uint16_t addr, uint8_t low, uint8_t num, reg_t val)=0
	Set bits to memory. More...
virtual void	reset ()=0
	Reset memory.

Detailed Description

template<typename T>
class itk::RegMem< T >

Interface definition for register memory.

Template Parameters

T	- type of register value (uint8_t, uint16_t, uint32_t).

Member Function Documentation

get_mem() [1/2]

template<typename T >

virtual reg_t itk::RegMem< T >::get_mem ( uint16_t  addr ) const

pure virtual

Get a value from memory.

Parameters

addr	- memory address.

Returns

value from memory.

get_mem() [2/2]

template<typename T >

virtual reg_t itk::RegMem< T >::get_mem ( uint16_t  addr ) const

pure virtual

Get a value from memory.

Parameters

addr	- memory address.

Returns

value from memory.

get_mem_bits() [1/2]

template<typename T >

virtual reg_t itk::RegMem< T >::get_mem_bits ( uint16_t  addr, uint8_t  low, uint8_t  num  ) const

pure virtual

Get bits from memory.

Parameters

addr	- memory address.
low	- offset of the bitfield.
num	- number of bits to get.

Returns

bitfield value from memory.

get_mem_bits() [2/2]

template<typename T >

virtual reg_t itk::RegMem< T >::get_mem_bits ( uint16_t  addr, uint8_t  low, uint8_t  num  ) const

pure virtual

Get bits from memory.

Parameters

addr	- memory address.
low	- offset of the bitfield.
num	- number of bits to get.

Returns

bitfield value from memory.

set_mem() [1/2]

template<typename T >

virtual void itk::RegMem< T >::set_mem ( uint16_t  addr, reg_t  val  )

pure virtual

Set a value into memory.

Parameters

addr	- memory address.
val	- value to be set.

set_mem() [2/2]

template<typename T >

virtual void itk::RegMem< T >::set_mem ( uint16_t  addr, reg_t  val  )

pure virtual

Set a value into memory.

Parameters

addr	- memory address.
val	- value to be set.

set_mem_bits() [1/2]

template<typename T >

virtual void itk::RegMem< T >::set_mem_bits ( uint16_t  addr, uint8_t  low, uint8_t  num, reg_t  val  )

pure virtual

Set bits to memory.

Parameters

addr	- memory address.
low	- offset of the bitfield to be set.
num	- number of bits to be set.
val	- value to be set.

set_mem_bits() [2/2]

template<typename T >

virtual void itk::RegMem< T >::set_mem_bits ( uint16_t  addr, uint8_t  low, uint8_t  num, reg_t  val  )

pure virtual

Set bits to memory.

Parameters

addr	- memory address.
low	- offset of the bitfield to be set.
num	- number of bits to be set.
val	- value to be set.

---

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

• itksw/itk/fec/concepts.hpp
• itksw/itk/fec/regmem.hpp