    

 ## On this page

  

 

 # Class ansys::dpf::Interface

 Last update: 25.03.2026 

<a id="classansys-dpf-interface"></a>

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

[Interface](classansys-dpf-interface.md#classansys-dpf-interface) specifies a set of constraints that an underlying implementation (operator or workflow) must respect.

## Members

- [get](classansys-dpf-interface.md#classansys-dpf-interface-1a2f04134d6869e0e2850b163098d7f60d)
- [getCacheInformation](classansys-dpf-interface.md#classansys-dpf-interface-1aa11f77e7c6afac065eed67320bc76152)
- [getExposedInputs](classansys-dpf-interface.md#classansys-dpf-interface-1ad95dea740aaabe8b28151116205d9015)
- [getExposedOutputs](classansys-dpf-interface.md#classansys-dpf-interface-1aae0d89447d85a705dad45f87fe5a6ddc)
- [getName](classansys-dpf-interface.md#classansys-dpf-interface-1aadad56bc25f8e1cfa01e776138e2a40e)
- [Interface](classansys-dpf-interface.md#classansys-dpf-interface-1a3f86c8753b44a5ff8ff372698a99f44f)
- [Interface](classansys-dpf-interface.md#classansys-dpf-interface-1ae7b77e9e0a3b3c9e0b6fb360bce69574)
- [Interface](classansys-dpf-interface.md#classansys-dpf-interface-1a886749ab22972009fb46b4369452b5a7)
- [isOptional](classansys-dpf-interface.md#classansys-dpf-interface-1a5ec662354dff0bc0c21efea29a50c135)
- [isToCache](classansys-dpf-interface.md#classansys-dpf-interface-1acdd838b3056830bb4e4f6beb8328d926)

## Public functions

<a id="classansys-dpf-interface-1a3f86c8753b44a5ff8ff372698a99f44f"></a>

### Function Interface

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Interface::Interface()=default

```

**Return type**:

<a id="classansys-dpf-interface-1ae7b77e9e0a3b3c9e0b6fb360bce69574"></a>

### Function Interface

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Interface::Interface(const std::string &name, const std::vector< std::string > &exposedInputs, const std::vector< std::string > &exposedOutputs, const CacheInformation &cacheInformation=CacheInformation(), bool isOptional=false)

```

**Parameters**:

- const std::string &amp; **name**
- const std::vector&lt; std::string &gt; &amp; **exposedInputs**
- const std::vector&lt; std::string &gt; &amp; **exposedOutputs**
- const [CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation) &amp; **cacheInformation** = [CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation)()
- bool **isOptional** = false

**Return type**:

<a id="classansys-dpf-interface-1a886749ab22972009fb46b4369452b5a7"></a>

### Function Interface

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::Interface::Interface(const DataTree &dt)

```

**Parameters**:

- const [DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) &amp; **dt**

**Return type**:

<a id="classansys-dpf-interface-1aadad56bc25f8e1cfa01e776138e2a40e"></a>

### Function getName

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::string ansys::dpf::Interface::getName() const noexcept

```

**Return type**: std::string

<a id="classansys-dpf-interface-1a2f04134d6869e0e2850b163098d7f60d"></a>

### Function get

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
DataTree ansys::dpf::Interface::get() const

```

**Return type**: [DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree)

<a id="classansys-dpf-interface-1ad95dea740aaabe8b28151116205d9015"></a>

### Function getExposedInputs

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::vector< std::string > ansys::dpf::Interface::getExposedInputs() const noexcept

```

**Return type**: std::vector&lt; std::string &gt;

<a id="classansys-dpf-interface-1aae0d89447d85a705dad45f87fe5a6ddc"></a>

### Function getExposedOutputs

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::vector< std::string > ansys::dpf::Interface::getExposedOutputs() const noexcept

```

**Return type**: std::vector&lt; std::string &gt;

<a id="classansys-dpf-interface-1aa11f77e7c6afac065eed67320bc76152"></a>

### Function getCacheInformation

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::map< std::string, CacheInformation::LevelAndDestination > ansys::dpf::Interface::getCacheInformation() const

```

**Return type**: std::map&lt; std::string, CacheInformation::LevelAndDestination &gt;

<a id="classansys-dpf-interface-1acdd838b3056830bb4e4f6beb8328d926"></a>

### Function isToCache

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
bool ansys::dpf::Interface::isToCache(const std::string &pinName) const noexcept

```

**Parameters**:

- const std::string &amp; **pinName**

**Return type**: bool

<a id="classansys-dpf-interface-1a5ec662354dff0bc0c21efea29a50c135"></a>

### Function isOptional

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
bool ansys::dpf::Interface::isOptional() const noexcept

```

**Return type**: bool