## On this page

  

 

 # ansys::dpf::PinDefinition Struct Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml#a7f96a3b401928fd5b7d29728869c2188) (int pin\_position) [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; [setName](structansys_1_1dpf_1_1PinDefinition.xhtml#a9973d2c279a5ce1db63556c815dcb5b7) (std::string const &amp;n) [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; [setPosition](structansys_1_1dpf_1_1PinDefinition.xhtml#a65b3f392b270b9cf3ef1160764b49c82) (int n) [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; [setDoc](structansys_1_1dpf_1_1PinDefinition.xhtml#a58cc9d8a539bed16ae22b5b2da90aaf5) (std::string const &amp;n) [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; [setOptional](structansys_1_1dpf_1_1PinDefinition.xhtml#a16aa7c1924a66ce4d73e72b8ceeb8a57) (bool n) [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; [setEllipsis](structansys_1_1dpf_1_1PinDefinition.xhtml#acbb3bc62e8c5e128db45a28c9ba21d57) (bool n) [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; [setAcceptedTypes](structansys_1_1dpf_1_1PinDefinition.xhtml#a99d14d58f90782a06a872c88d2fd6953) (std::vector&lt; [TypeDescriptor](structansys_1_1dpf_1_1TypeDescriptor.xhtml) &gt; const &amp;n) ## <a id="pub-attribs" name="pub-attribs"></a>Data Fields

std::string [name](structansys_1_1dpf_1_1PinDefinition.xhtml#a2dd76d015c235c3f89e7d223dde5860c) int [position](structansys_1_1dpf_1_1PinDefinition.xhtml#ac3a15b557922e20c2351e4b91c1b8fa1) std::string [documentation](structansys_1_1dpf_1_1PinDefinition.xhtml#a280231283314d4275889e5b1871fbde0) <a id="ae3a0442033de150dd5d4e6077ac95aa0" name="ae3a0442033de150dd5d4e6077ac95aa0"></a>bool **is\_optional** <a id="a1811518326691a9d54832141dd04e4eb" name="a1811518326691a9d54832141dd04e4eb"></a>bool **is\_ellipsis** <a id="ad7fe730ca1b57d8e4c8f3a70ac7041f7" name="ad7fe730ca1b57d8e4c8f3a70ac7041f7"></a>std::vector&lt; [TypeDescriptor](structansys_1_1dpf_1_1TypeDescriptor.xhtml) &gt; **accepted\_types** <a id="details" name="details"></a>## Detailed Description

Definition of an [Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") pin.



## Constructor &amp; Destructor Documentation

<a id="a7f96a3b401928fd5b7d29728869c2188" name="a7f96a3b401928fd5b7d29728869c2188"></a>## [◆ ](#a7f96a3b401928fd5b7d29728869c2188)PinDefinition()

 ansys::dpf::PinDefinition::PinDefinition  ( int  *pin\_position*)   inline 

Create pin definition for given pin.

Parameters \[in\]pin\_positionPin for which to create definition. 



## Member Function Documentation

<a id="a99d14d58f90782a06a872c88d2fd6953" name="a99d14d58f90782a06a872c88d2fd6953"></a>## [◆ ](#a99d14d58f90782a06a872c88d2fd6953)setAcceptedTypes()

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; ansys::dpf::PinDefinition::setAcceptedTypes  ( std::vector&lt; [TypeDescriptor](structansys_1_1dpf_1_1TypeDescriptor.xhtml) &gt; const &amp;  *n*)   inline 

ReturnsPin definition. 



<a id="a58cc9d8a539bed16ae22b5b2da90aaf5" name="a58cc9d8a539bed16ae22b5b2da90aaf5"></a>## [◆ ](#a58cc9d8a539bed16ae22b5b2da90aaf5)setDoc()

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; ansys::dpf::PinDefinition::setDoc  ( std::string const &amp;  *n*)   inline 

Set description of pin.

ReturnsPin definition. Parameters \[in\]nPin description. 



<a id="acbb3bc62e8c5e128db45a28c9ba21d57" name="acbb3bc62e8c5e128db45a28c9ba21d57"></a>## [◆ ](#acbb3bc62e8c5e128db45a28c9ba21d57)setEllipsis()

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; ansys::dpf::PinDefinition::setEllipsis  ( bool  *n*)   inline 

ReturnsPin definition. 



<a id="a9973d2c279a5ce1db63556c815dcb5b7" name="a9973d2c279a5ce1db63556c815dcb5b7"></a>## [◆ ](#a9973d2c279a5ce1db63556c815dcb5b7)setName()

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; ansys::dpf::PinDefinition::setName  ( std::string const &amp;  *n*)   inline 

Set name of pin.

ReturnsPin definition. Parameters \[in\]nName of pin. 



<a id="a16aa7c1924a66ce4d73e72b8ceeb8a57" name="a16aa7c1924a66ce4d73e72b8ceeb8a57"></a>## [◆ ](#a16aa7c1924a66ce4d73e72b8ceeb8a57)setOptional()

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; ansys::dpf::PinDefinition::setOptional  ( bool  *n*)   inline 

Set indication that pin is optional.

ReturnsPin definition. Parameters \[in\]nFlag indicating if pin is optional. 



<a id="a65b3f392b270b9cf3ef1160764b49c82" name="a65b3f392b270b9cf3ef1160764b49c82"></a>## [◆ ](#a65b3f392b270b9cf3ef1160764b49c82)setPosition()

 [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &amp; ansys::dpf::PinDefinition::setPosition  ( int  *n*)   inline 

Set input pin position.

ReturnsPin definition. Parameters \[in\]nPostion of pin. 



## Field Documentation

<a id="a280231283314d4275889e5b1871fbde0" name="a280231283314d4275889e5b1871fbde0"></a>## [◆ ](#a280231283314d4275889e5b1871fbde0)documentation

 std::string ansys::dpf::PinDefinition::documentation

Description of pin.





<a id="a2dd76d015c235c3f89e7d223dde5860c" name="a2dd76d015c235c3f89e7d223dde5860c"></a>## [◆ ](#a2dd76d015c235c3f89e7d223dde5860c)name

 std::string ansys::dpf::PinDefinition::name

Name of pin.





<a id="ac3a15b557922e20c2351e4b91c1b8fa1" name="ac3a15b557922e20c2351e4b91c1b8fa1"></a>## [◆ ](#ac3a15b557922e20c2351e4b91c1b8fa1)position

 int ansys::dpf::PinDefinition::position

Pin position number.