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

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

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

## Module Contents

### Classes

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

* - {py:obj}`uvm_reg_file <pyuvm._reg.uvm_reg_file.uvm_reg_file>`
  -
````

### Data

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

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

### API

````{py:data} __all__
:canonical: pyuvm._reg.uvm_reg_file.__all__
:value: >
   ['uvm_reg_file']

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

````

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

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

````{py:method} configure(blk_parent: pyuvm._reg.uvm_reg_block.uvm_reg_block, regfile_parent: pyuvm._reg.uvm_reg_file.uvm_reg_file, hdl_path: str = '') -> None
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.configure
:abstractmethod:

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

````

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

````

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

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

````

````{py:method} get_block() -> pyuvm._reg.uvm_reg_block.uvm_reg_block
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.get_block
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.get_block
```

````

````{py:method} get_regfile() -> pyuvm._reg.uvm_reg_file.uvm_reg_file
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.get_regfile
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.get_regfile
```

````

````{py:method} clear_hdl_path(kind: str = 'RTL') -> None
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.clear_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.clear_hdl_path
```

````

````{py:method} add_hdl_path(path: str, kind: str = 'RTL') -> None
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.add_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.add_hdl_path
```

````

````{py:method} has_hdl_path(kind: str = '') -> bool
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.has_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.has_hdl_path
```

````

````{py:method} get_hdl_path(paths: list[str], kind: str = '') -> None
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.get_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.get_hdl_path
```

````

````{py:method} get_full_hdl_path(paths: list[str], kind: str = '', separator: str = '.') -> None
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.get_full_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.get_full_hdl_path
```

````

````{py:method} set_default_hdl_path(kind: str) -> None
:canonical: pyuvm._reg.uvm_reg_file.uvm_reg_file.set_default_hdl_path
:abstractmethod:

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.set_default_hdl_path
```

````

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

```{autodoc2-docstring} pyuvm._reg.uvm_reg_file.uvm_reg_file.get_default_hdl_path
```

````

`````