Interface definition for field.
More...
#include <field.hpp>
|
|
using | fld_t = U |
| |
|
using | reg_t = IRegister::reg_t |
| |
|
using | Register = IRegister |
| |
|
using | RegMem = IRegister::RegMem |
| |
|
using | Commander = IRegister::Commander |
| |
|
|
virtual | ~Field ()=default |
| | Default destructor.
|
| |
| virtual fld_t | get (const RegMem ®mem) const =0 |
| | Get field value from the memory. More...
|
| |
| virtual void | set (RegMem ®mem, fld_t value) const =0 |
| | Set field value into the memory. More...
|
| |
| virtual void | read (RegMem ®mem, Commander &cmdr) const =0 |
| | Set field value in memory and write commands sequence to modify field value in chip to cmdr buffer, does not send commands over e-link. More...
|
| |
| virtual void | write (RegMem ®mem, Commander &cmdr, fld_t value) const =0 |
| | Set field value in memory and write commands sequence to modify field value in chip to cmdr buffer, does not send commands over e-link. More...
|
| |
| virtual std::string | get_name () const =0 |
| | Properties. More...
|
| |
| virtual std::string | get_desc () const =0 |
| | Get field description. More...
|
| |
template<typename U, typename IRegister>
class itk::Field< U, IRegister >
Interface definition for field.
- Template Parameters
-
| U | - type of field value (uint64_t). |
| IRegister | - Register interface associated with this Field. |
◆ get()
template<typename U , typename IRegister >
| virtual fld_t itk::Field< U, IRegister >::get |
( |
const RegMem & |
regmem | ) |
const |
|
pure virtual |
Get field value from the memory.
- Parameters
-
| regmem | - reference to the register memory object. |
- Returns
- field value.
◆ get_desc()
template<typename U , typename IRegister >
| virtual std::string itk::Field< U, IRegister >::get_desc |
( |
| ) |
const |
|
pure virtual |
Get field description.
- Returns
- description of the field.
◆ get_name()
template<typename U , typename IRegister >
| virtual std::string itk::Field< U, IRegister >::get_name |
( |
| ) |
const |
|
pure virtual |
Properties.
Get field name.
- Returns
- name of the field.
◆ read()
template<typename U , typename IRegister >
| virtual void itk::Field< U, IRegister >::read |
( |
RegMem & |
regmem, |
|
|
Commander & |
cmdr |
|
) |
| const |
|
pure virtual |
Set field value in memory and write commands sequence to modify field value in chip to cmdr buffer, does not send commands over e-link.
- Parameters
-
| regmem | - reference to the register memory object. |
| cmdr | - reference to the commander object. |
| value | - field value. |
◆ set()
template<typename U , typename IRegister >
| virtual void itk::Field< U, IRegister >::set |
( |
RegMem & |
regmem, |
|
|
fld_t |
value |
|
) |
| const |
|
pure virtual |
Set field value into the memory.
- Parameters
-
| regmem | - reference to the register memory object. |
| value | - field value. |
◆ write()
template<typename U , typename IRegister >
| virtual void itk::Field< U, IRegister >::write |
( |
RegMem & |
regmem, |
|
|
Commander & |
cmdr, |
|
|
fld_t |
value |
|
) |
| const |
|
pure virtual |
Set field value in memory and write commands sequence to modify field value in chip to cmdr buffer, does not send commands over e-link.
- Parameters
-
| regmem | - reference to the register memory object. |
| cmdr | - reference to the commander object. |
| value | - field value. |
The documentation for this class was generated from the following file:
