# {py:mod}`pyuvm._s24_uvm_reg_includes`

```{py:module} pyuvm._s24_uvm_reg_includes
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`path_t <pyuvm._s24_uvm_reg_includes.path_t>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.path_t
    :summary:
    ```
* - {py:obj}`check_t <pyuvm._s24_uvm_reg_includes.check_t>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.check_t
    :summary:
    ```
* - {py:obj}`status_t <pyuvm._s24_uvm_reg_includes.status_t>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.status_t
    :summary:
    ```
* - {py:obj}`predict_t <pyuvm._s24_uvm_reg_includes.predict_t>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.predict_t
    :summary:
    ```
* - {py:obj}`elem_kind_e <pyuvm._s24_uvm_reg_includes.elem_kind_e>`
  -
* - {py:obj}`access_e <pyuvm._s24_uvm_reg_includes.access_e>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.access_e
    :summary:
    ```
* - {py:obj}`uvm_resp_t <pyuvm._s24_uvm_reg_includes.uvm_resp_t>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_resp_t
    :summary:
    ```
* - {py:obj}`uvm_reg_bus_op <pyuvm._s24_uvm_reg_includes.uvm_reg_bus_op>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_bus_op
    :summary:
    ```
* - {py:obj}`uvm_reg_error_decoder <pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder
    :summary:
    ```
* - {py:obj}`uvm_reg_field_error_decoder <pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder
    :summary:
    ```
````

### Functions

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

* - {py:obj}`rand_enable <pyuvm._s24_uvm_reg_includes.rand_enable>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.rand_enable
    :summary:
    ```
* - {py:obj}`uvm_error <pyuvm._s24_uvm_reg_includes.uvm_error>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_error
    :summary:
    ```
* - {py:obj}`uvm_fatal <pyuvm._s24_uvm_reg_includes.uvm_fatal>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_fatal
    :summary:
    ```
* - {py:obj}`uvm_not_implemeneted <pyuvm._s24_uvm_reg_includes.uvm_not_implemeneted>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_not_implemeneted
    :summary:
    ```
* - {py:obj}`error_out <pyuvm._s24_uvm_reg_includes.error_out>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.error_out
    :summary:
    ```
````

### Data

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

* - {py:obj}`enable_pyvsc <pyuvm._s24_uvm_reg_includes.enable_pyvsc>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_pyvsc
    :summary:
    ```
* - {py:obj}`enable_auto_predict <pyuvm._s24_uvm_reg_includes.enable_auto_predict>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_auto_predict
    :summary:
    ```
* - {py:obj}`enable_throw_error_response_on_read <pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_read>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_read
    :summary:
    ```
* - {py:obj}`enable_throw_error_response_on_write <pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_write>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_write
    :summary:
    ```
* - {py:obj}`disable_code_interruption_assert <pyuvm._s24_uvm_reg_includes.disable_code_interruption_assert>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.disable_code_interruption_assert
    :summary:
    ```
* - {py:obj}`disable_code_interruption_fatal <pyuvm._s24_uvm_reg_includes.disable_code_interruption_fatal>`
  - ```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.disable_code_interruption_fatal
    :summary:
    ```
````

### API

`````{py:class} path_t(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.path_t

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.path_t
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.path_t.__init__
```

````{py:attribute} FRONTDOOR
:canonical: pyuvm._s24_uvm_reg_includes.path_t.FRONTDOOR
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.path_t.FRONTDOOR
```

````

````{py:attribute} BACKDOOR
:canonical: pyuvm._s24_uvm_reg_includes.path_t.BACKDOOR
:value: >
   2

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.path_t.BACKDOOR
```

````

````{py:attribute} USER_FRONTDOOR
:canonical: pyuvm._s24_uvm_reg_includes.path_t.USER_FRONTDOOR
:value: >
   3

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.path_t.USER_FRONTDOOR
```

````

`````

`````{py:class} check_t(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.check_t

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.check_t
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.check_t.__init__
```

````{py:attribute} CHECK
:canonical: pyuvm._s24_uvm_reg_includes.check_t.CHECK
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.check_t.CHECK
```

````

````{py:attribute} NO_CHECK
:canonical: pyuvm._s24_uvm_reg_includes.check_t.NO_CHECK
:value: >
   2

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.check_t.NO_CHECK
```

````

`````

`````{py:class} status_t(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.status_t

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.status_t
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.status_t.__init__
```

````{py:attribute} IS_OK
:canonical: pyuvm._s24_uvm_reg_includes.status_t.IS_OK
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.status_t.IS_OK
```

````

````{py:attribute} IS_NOT_OK
:canonical: pyuvm._s24_uvm_reg_includes.status_t.IS_NOT_OK
:value: >
   2

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.status_t.IS_NOT_OK
```

````

`````

`````{py:class} predict_t(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.predict_t

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.predict_t
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.predict_t.__init__
```

````{py:attribute} PREDICT_WRITE
:canonical: pyuvm._s24_uvm_reg_includes.predict_t.PREDICT_WRITE
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.predict_t.PREDICT_WRITE
```

````

````{py:attribute} PREDICT_READ
:canonical: pyuvm._s24_uvm_reg_includes.predict_t.PREDICT_READ
:value: >
   2

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.predict_t.PREDICT_READ
```

````

````{py:attribute} PREDICT_DIRECT
:canonical: pyuvm._s24_uvm_reg_includes.predict_t.PREDICT_DIRECT
:value: >
   3

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.predict_t.PREDICT_DIRECT
```

````

`````

```{py:class} elem_kind_e(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.elem_kind_e

Bases: {py:obj}`enum.Enum`

```

`````{py:class} access_e(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.access_e

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.access_e
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.access_e.__init__
```

````{py:attribute} UVM_READ
:canonical: pyuvm._s24_uvm_reg_includes.access_e.UVM_READ
:value: >
   0

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.access_e.UVM_READ
```

````

````{py:attribute} UVM_WRITE
:canonical: pyuvm._s24_uvm_reg_includes.access_e.UVM_WRITE
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.access_e.UVM_WRITE
```

````

`````

`````{py:class} uvm_resp_t(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.uvm_resp_t

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_resp_t
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_resp_t.__init__
```

````{py:attribute} PASS_RESP
:canonical: pyuvm._s24_uvm_reg_includes.uvm_resp_t.PASS_RESP
:value: >
   0

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_resp_t.PASS_RESP
```

````

````{py:attribute} ERROR_RESP
:canonical: pyuvm._s24_uvm_reg_includes.uvm_resp_t.ERROR_RESP
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_resp_t.ERROR_RESP
```

````

`````

````{py:function} rand_enable(use_pyvsc: bool)
:canonical: pyuvm._s24_uvm_reg_includes.rand_enable

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.rand_enable
```
````

````{py:data} enable_pyvsc
:canonical: pyuvm._s24_uvm_reg_includes.enable_pyvsc
:value: >
   False

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_pyvsc
```

````

````{py:data} enable_auto_predict
:canonical: pyuvm._s24_uvm_reg_includes.enable_auto_predict
:value: >
   False

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_auto_predict
```

````

````{py:data} enable_throw_error_response_on_read
:canonical: pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_read
:value: >
   False

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_read
```

````

````{py:data} enable_throw_error_response_on_write
:canonical: pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_write
:value: >
   False

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.enable_throw_error_response_on_write
```

````

````{py:data} disable_code_interruption_assert
:canonical: pyuvm._s24_uvm_reg_includes.disable_code_interruption_assert
:value: >
   False

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.disable_code_interruption_assert
```

````

````{py:data} disable_code_interruption_fatal
:canonical: pyuvm._s24_uvm_reg_includes.disable_code_interruption_fatal
:value: >
   False

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.disable_code_interruption_fatal
```

````

````{py:function} uvm_error(header='', message='')
:canonical: pyuvm._s24_uvm_reg_includes.uvm_error

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_error
```
````

````{py:function} uvm_fatal(header='', message='')
:canonical: pyuvm._s24_uvm_reg_includes.uvm_fatal

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_fatal
```
````

````{py:function} uvm_not_implemeneted(header='', message='')
:canonical: pyuvm._s24_uvm_reg_includes.uvm_not_implemeneted

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_not_implemeneted
```
````

````{py:function} error_out(header, message)
:canonical: pyuvm._s24_uvm_reg_includes.error_out

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.error_out
```
````

````{py:class} uvm_reg_bus_op()
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_bus_op

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_bus_op
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_bus_op.__init__
```

````

`````{py:class} uvm_reg_error_decoder(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.__init__
```

````{py:attribute} FIELD_CANNOT_BE_NONE
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_CANNOT_BE_NONE
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_CANNOT_BE_NONE
```

````

````{py:attribute} FIELD_ALREADY_ADDED
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_ALREADY_ADDED
:value: >
   2

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_ALREADY_ADDED
```

````

````{py:attribute} FIELD_DOESNT_FIT_INTO_REG
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_DOESNT_FIT_INTO_REG
:value: >
   3

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_DOESNT_FIT_INTO_REG
```

````

````{py:attribute} FIELD_OVERLAPPING_ERROR
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_OVERLAPPING_ERROR
:value: >
   4

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.FIELD_OVERLAPPING_ERROR
```

````

````{py:attribute} REG_SIZE_CANNOT_BE_ZERO
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.REG_SIZE_CANNOT_BE_ZERO
:value: >
   5

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_error_decoder.REG_SIZE_CANNOT_BE_ZERO
```

````

`````

`````{py:class} uvm_reg_field_error_decoder(*args, **kwds)
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.__init__
```

````{py:attribute} CONFIGURE_MUST_BE_CALLED_BEFORE
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.CONFIGURE_MUST_BE_CALLED_BEFORE
:value: >
   1

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.CONFIGURE_MUST_BE_CALLED_BEFORE
```

````

````{py:attribute} ACCESS_TYPE_NEEDS_TO_BE_A_STRING
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.ACCESS_TYPE_NEEDS_TO_BE_A_STRING
:value: >
   2

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.ACCESS_TYPE_NEEDS_TO_BE_A_STRING
```

````

````{py:attribute} WRONG_ACCESS_FOR_PREDICT_READ
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.WRONG_ACCESS_FOR_PREDICT_READ
:value: >
   3

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.WRONG_ACCESS_FOR_PREDICT_READ
```

````

````{py:attribute} WRONG_COMBINATION_PREDICTION_DIRECTION
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.WRONG_COMBINATION_PREDICTION_DIRECTION
:value: >
   4

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.WRONG_COMBINATION_PREDICTION_DIRECTION
```

````

````{py:attribute} ACCESS_VALUE_OUT_OF_LIST
:canonical: pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.ACCESS_VALUE_OUT_OF_LIST
:value: >
   5

```{autodoc2-docstring} pyuvm._s24_uvm_reg_includes.uvm_reg_field_error_decoder.ACCESS_VALUE_OUT_OF_LIST
```

````

`````