    

 ## On this page

  

 

 # Structure ansys::dpf::PinDefinition

 Last update: 25.03.2026 

<a id="structansys-dpf-pindefinition"></a>

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

Definition of an [Operator](classansys-dpf-operator.md#classansys-dpf-operator) pin.

## Members

- [accepted\_types](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1ad7fe730ca1b57d8e4c8f3a70ac7041f7)
- [addAlias](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1afc9b5d5161c5fffa46a4b2a7cd7cb887)
- [aliases](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a1f5dd7b4fa4650aefc9be2e1c7b0fff8)
- [derived\_type\_name](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1afe0a140c14142d72726f5ad831e65e01)
- [documentation](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a280231283314d4275889e5b1871fbde0)
- [is\_ellipsis](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a1811518326691a9d54832141dd04e4eb)
- [is\_inplace](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a27764e9352db5a61371c223a384d61d5)
- [is\_optional](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1ae3a0442033de150dd5d4e6077ac95aa0)
- [name](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a2dd76d015c235c3f89e7d223dde5860c)
- [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1aef45c262b8b9c64f3983c96ef4f4bcb4)
- [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a7f96a3b401928fd5b7d29728869c2188)
- [position](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1ac3a15b557922e20c2351e4b91c1b8fa1)
- [setAcceptedTypes](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a99d14d58f90782a06a872c88d2fd6953)
- [setAliases](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a63226a6ac16f9aafd8d24f0d94804183)
- [setDerivedTypeName](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a79fc88f277916a6c904c7240582f7f60)
- [setDoc](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a58cc9d8a539bed16ae22b5b2da90aaf5)
- [setEllipsis](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1acbb3bc62e8c5e128db45a28c9ba21d57)
- [setName](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a9973d2c279a5ce1db63556c815dcb5b7)
- [setOptional](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a16aa7c1924a66ce4d73e72b8ceeb8a57)
- [setPosition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition-1a65b3f392b270b9cf3ef1160764b49c82)

## Public attributes

<a id="structansys-dpf-pindefinition-1a2dd76d015c235c3f89e7d223dde5860c"></a>

### Variable name

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

```cpp
std::string ansys::dpf::PinDefinition::name

```

Name of pin.

**Type**: std::string

<a id="structansys-dpf-pindefinition-1ac3a15b557922e20c2351e4b91c1b8fa1"></a>

### Variable position

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

```cpp
int ansys::dpf::PinDefinition::position

```

Pin position number.

**Type**: int

<a id="structansys-dpf-pindefinition-1a280231283314d4275889e5b1871fbde0"></a>

### Variable documentation

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

```cpp
std::string ansys::dpf::PinDefinition::documentation

```

Description of pin.

**Type**: std::string

<a id="structansys-dpf-pindefinition-1ae3a0442033de150dd5d4e6077ac95aa0"></a>

### Variable is\_optional

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

```cpp
bool ansys::dpf::PinDefinition::is_optional

```

**Type**: bool

<a id="structansys-dpf-pindefinition-1a1811518326691a9d54832141dd04e4eb"></a>

### Variable is\_ellipsis

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

```cpp
bool ansys::dpf::PinDefinition::is_ellipsis

```

**Type**: bool

<a id="structansys-dpf-pindefinition-1a27764e9352db5a61371c223a384d61d5"></a>

### Variable is\_inplace

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

```cpp
bool ansys::dpf::PinDefinition::is_inplace

```

**Type**: bool

<a id="structansys-dpf-pindefinition-1afe0a140c14142d72726f5ad831e65e01"></a>

### Variable derived\_type\_name

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

```cpp
std::string ansys::dpf::PinDefinition::derived_type_name

```

**Type**: std::string

<a id="structansys-dpf-pindefinition-1ad7fe730ca1b57d8e4c8f3a70ac7041f7"></a>

### Variable accepted\_types

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

```cpp
std::vector<TypeDescriptor> ansys::dpf::PinDefinition::accepted_types

```

**Type**: std::vector&lt; [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) &gt;

<a id="structansys-dpf-pindefinition-1a1f5dd7b4fa4650aefc9be2e1c7b0fff8"></a>

### Variable aliases

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

```cpp
std::vector<std::string> ansys::dpf::PinDefinition::aliases

```

**Type**: std::vector&lt; std::string &gt;

## Public functions

<a id="structansys-dpf-pindefinition-1aef45c262b8b9c64f3983c96ef4f4bcb4"></a>

### Function PinDefinition

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

```cpp
ansys::dpf::PinDefinition::PinDefinition()

```

**Return type**:

<a id="structansys-dpf-pindefinition-1a7f96a3b401928fd5b7d29728869c2188"></a>

### Function PinDefinition

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

```cpp
ansys::dpf::PinDefinition::PinDefinition(int pin_position)

```

Create pin definition for given pin.

**Parameters**:

- int **pin\_position**: \[in\] Pin for which to create definition.

**Return type**:

<a id="structansys-dpf-pindefinition-1a9973d2c279a5ce1db63556c815dcb5b7"></a>

### Function setName

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setName(std::string const &n)

```

Set name of pin. **Returns**:

Pin definition.

**Parameters**:

- std::string const &amp; **n**: \[in\] Name of pin.

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1a79fc88f277916a6c904c7240582f7f60"></a>

### Function setDerivedTypeName

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setDerivedTypeName(std::string const &n)

```

Allows to give a custom container type as a pin type. **Returns**:

Pin definition.

**Parameters**:

- std::string const &amp; **n**: \[in\] Name of the derived class.

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1a65b3f392b270b9cf3ef1160764b49c82"></a>

### Function setPosition

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setPosition(int n)

```

Set input pin position. **Returns**:

Pin definition.

**Parameters**:

- int **n**: \[in\] Postion of pin.

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1a58cc9d8a539bed16ae22b5b2da90aaf5"></a>

### Function setDoc

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setDoc(std::string const &n)

```

Set description of pin. **Returns**:

Pin definition.

**Parameters**:

- std::string const &amp; **n**: \[in\] Pin description.

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1a16aa7c1924a66ce4d73e72b8ceeb8a57"></a>

### Function setOptional

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setOptional(bool n)

```

Set indication that pin is optional. **Returns**:

Pin definition.

**Parameters**:

- bool **n**: \[in\] Flag indicating if pin is optional.

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1acbb3bc62e8c5e128db45a28c9ba21d57"></a>

### Function setEllipsis

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setEllipsis(bool n)

```

**Returns**:

Pin definition.

**Parameters**:

- bool **n**

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1a99d14d58f90782a06a872c88d2fd6953"></a>

### Function setAcceptedTypes

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setAcceptedTypes(std::vector< TypeDescriptor > const &n)

```

**Returns**:

Pin definition.

**Parameters**:

- std::vector&lt; [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) &gt; const &amp; **n**

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1a63226a6ac16f9aafd8d24f0d94804183"></a>

### Function setAliases

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::setAliases(std::vector< std::string > const &n)

```

**Returns**:

Pin definition.

**Parameters**:

- std::vector&lt; std::string &gt; const &amp; **n**

**Return type**: PinDefinition &amp;

<a id="structansys-dpf-pindefinition-1afc9b5d5161c5fffa46a4b2a7cd7cb887"></a>

### Function addAlias

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

```cpp
PinDefinition & ansys::dpf::PinDefinition::addAlias(std::string const &alias)

```

**Returns**:

Pin definition.

**Parameters**:

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

**Return type**: PinDefinition &amp;