# {py:mod}`antcal.pyaedt.hfss`

```{py:module} antcal.pyaedt.hfss
```

```{autodoc2-docstring} antcal.pyaedt.hfss
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`MyVariable <antcal.pyaedt.hfss.MyVariable>`
  - ```{autodoc2-docstring} antcal.pyaedt.hfss.MyVariable
    :summary:
    ```
````

### Functions

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

* - {py:obj}`get_variables <antcal.pyaedt.hfss.get_variables>`
  - ```{autodoc2-docstring} antcal.pyaedt.hfss.get_variables
    :summary:
    ```
* - {py:obj}`update_variables <antcal.pyaedt.hfss.update_variables>`
  - ```{autodoc2-docstring} antcal.pyaedt.hfss.update_variables
    :summary:
    ```
* - {py:obj}`check_materials <antcal.pyaedt.hfss.check_materials>`
  - ```{autodoc2-docstring} antcal.pyaedt.hfss.check_materials
    :summary:
    ```
* - {py:obj}`create_linear_structure <antcal.pyaedt.hfss.create_linear_structure>`
  - ```{autodoc2-docstring} antcal.pyaedt.hfss.create_linear_structure
    :summary:
    ```
````

### API

`````{py:class} MyVariable(expression: str, name: str, hfss: ansys.aedt.core.hfss.Hfss)
:canonical: antcal.pyaedt.hfss.MyVariable

Bases: {py:obj}`ansys.aedt.core.application.variables.Variable`

```{autodoc2-docstring} antcal.pyaedt.hfss.MyVariable
```

```{rubric} Initialization
```

```{autodoc2-docstring} antcal.pyaedt.hfss.MyVariable.__init__
```

````{py:method} __str__() -> str
:canonical: antcal.pyaedt.hfss.MyVariable.__str__

````

`````

````{py:function} get_variables(hfss: ansys.aedt.core.hfss.Hfss) -> dict[str, str]
:canonical: antcal.pyaedt.hfss.get_variables

```{autodoc2-docstring} antcal.pyaedt.hfss.get_variables
```
````

````{py:function} update_variables(hfss: ansys.aedt.core.hfss.Hfss, variables: collections.abc.Mapping[str, str], constants: collections.abc.Mapping[str, str | float] | None = None) -> None
:canonical: antcal.pyaedt.hfss.update_variables

```{autodoc2-docstring} antcal.pyaedt.hfss.update_variables
```
````

````{py:function} check_materials(hfss: ansys.aedt.core.hfss.Hfss, materials: str | list[str]) -> None
:canonical: antcal.pyaedt.hfss.check_materials

```{autodoc2-docstring} antcal.pyaedt.hfss.check_materials
```
````

````{py:function} create_linear_structure(hfss: ansys.aedt.core.hfss.Hfss, type: typing.Literal[hole, via], size: str, starting_point: list[str], direction: typing.Literal[X, Y], length: str, min_distance: str, shape: typing.Literal[cylindrical, rectangular] = 'cylindrical', omit_start: bool = False, omit_end: bool = False, offset: str | None = None) -> ansys.aedt.core.modeler.cad.object_3d.Object3d
:canonical: antcal.pyaedt.hfss.create_linear_structure

```{autodoc2-docstring} antcal.pyaedt.hfss.create_linear_structure
```
````