# {py:mod}`pyuvm._reg.uvm_vreg_field`

```{py:module} pyuvm._reg.uvm_vreg_field
```

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`uvm_vreg_field <pyuvm._reg.uvm_vreg_field.uvm_vreg_field>`
  -
* - {py:obj}`uvm_vreg_field_cbs <pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs>`
  -
* - {py:obj}`uvm_vreg_field_cb <pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb>`
  -
* - {py:obj}`uvm_vreg_field_cb_iter <pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb_iter>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb_iter
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <pyuvm._reg.uvm_vreg_field.__all__>`
  - ```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: pyuvm._reg.uvm_vreg_field.__all__
:value: >
   ['uvm_vreg_field', 'uvm_vreg_field_cbs', 'uvm_vreg_field_cb', 'uvm_vreg_field_cb_iter']

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.__all__
```

````

`````{py:class} uvm_vreg_field(name: str = 'uvm_vreg_field')
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field

Bases: {py:obj}`pyuvm._s05_base_classes.uvm_object`

````{py:method} configure(parent: pyuvm._reg.uvm_vreg.uvm_vreg, size: int, lsb_pos: int) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.configure
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.configure
```

````

````{py:method} get_full_name() -> str
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_full_name
:abstractmethod:

````

````{py:method} get_parent() -> pyuvm._reg.uvm_vreg.uvm_vreg
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_parent
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_parent
```

````

````{py:method} get_register() -> pyuvm._reg.uvm_vreg.uvm_vreg
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_register
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_register
```

````

````{py:method} get_lsb_pos_in_register() -> int
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_lsb_pos_in_register
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_lsb_pos_in_register
```

````

````{py:method} get_n_bits() -> int
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_n_bits
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_n_bits
```

````

````{py:method} get_access(map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None) -> str
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_access
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.get_access
```

````

````{py:method} write(idx: int, value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.write
```

````

````{py:method} read(idx: int, path: pyuvm._reg.uvm_reg_model.uvm_door_e = uvm_door_e.UVM_DEFAULT_DOOR, map: pyuvm._reg.uvm_reg_map.uvm_reg_map = None, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> tuple[pyuvm._reg.uvm_reg_model.uvm_status_e, pyuvm._reg.uvm_reg_model.uvm_reg_data_t]
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.read
```

````

````{py:method} poke(idx: int, value: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> pyuvm._reg.uvm_reg_model.uvm_status_e
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.poke
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.poke
```

````

````{py:method} peek(idx: int, parent: pyuvm._s14_15_python_sequences.uvm_sequence_base = None, extension: pyuvm._s05_base_classes.uvm_object = None, fname: str = '', lineno: int = 0) -> tuple[pyuvm._reg.uvm_reg_model.uvm_status_e, pyuvm._reg.uvm_reg_model.uvm_reg_data_t]
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.peek
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.peek
```

````

````{py:method} pre_write(idx: int, wdat: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.pre_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.pre_write
```

````

````{py:method} post_write(idx: int, wdat: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map, status: pyuvm._reg.uvm_reg_model.uvm_status_e) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.post_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.post_write
```

````

````{py:method} pre_read(idx: int, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.pre_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.pre_read
```

````

````{py:method} post_read(idx: int, rdat: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map, status: pyuvm._reg.uvm_reg_model.uvm_status_e) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field.post_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field.post_read
```

````

`````

`````{py:class} uvm_vreg_field_cbs(name: str = 'uvm_vreg_field_cbs')
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs

Bases: {py:obj}`pyuvm._s10_synchronization_classes.uvm_callback`

````{py:method} pre_write(field: pyuvm._reg.uvm_vreg_field.uvm_vreg_field, idx: int, wdat: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.pre_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.pre_write
```

````

````{py:method} post_write(field: pyuvm._reg.uvm_vreg_field.uvm_vreg_field, idx: int, wdat: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map, status: pyuvm._reg.uvm_reg_model.uvm_status_e) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.post_write
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.post_write
```

````

````{py:method} pre_read(field: pyuvm._reg.uvm_vreg_field.uvm_vreg_field, idx: int, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.pre_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.pre_read
```

````

````{py:method} post_read(field: pyuvm._reg.uvm_vreg_field.uvm_vreg_field, idx: int, rdat: pyuvm._reg.uvm_reg_model.uvm_reg_data_t, path: pyuvm._reg.uvm_reg_model.uvm_door_e, map: pyuvm._reg.uvm_reg_map.uvm_reg_map, status: pyuvm._reg.uvm_reg_model.uvm_status_e) -> None
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.post_read
:abstractmethod:
:async:

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cbs.post_read
```

````

`````

```{py:class} uvm_vreg_field_cb(name: str = 'uvm_callbacks')
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb

Bases: {py:obj}`pyuvm._s10_synchronization_classes.uvm_callbacks`

```

````{py:class} uvm_vreg_field_cb_iter(obj: type[pyuvm._s05_base_classes.uvm_object] | pyuvm._s05_base_classes.uvm_object)
:canonical: pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb_iter

Bases: {py:obj}`pyuvm._s10_synchronization_classes.uvm_callback_iter`

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb_iter
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._reg.uvm_vreg_field.uvm_vreg_field_cb_iter.__init__
```

````