DPF C++ Client Library 2025 R2

ansys::dpf::PinDefinition Struct Reference

Last update: 16.07.2025

#include <dpf_api.h>

Public Member Functions

 PinDefinition (int pin_position)
 
PinDefinition & setName (std::string const &n)
 
PinDefinition & setDerivedTypeName (std::string const &n)
 
PinDefinition & setPosition (int n)
 
PinDefinition & setDoc (std::string const &n)
 
PinDefinition & setOptional (bool n)
 
PinDefinition & setEllipsis (bool n)
 
PinDefinition & setAcceptedTypes (std::vector< TypeDescriptor > const &n)
 
PinDefinition & setAliases (std::vector< std::string > const &n)
 
PinDefinition & addAlias (std::string const &alias)
 

Data Fields

std::string name
 
int position
 
std::string documentation
 
bool is_optional
 
bool is_ellipsis
 
bool is_inplace
 
std::string derived_type_name
 
std::vector< TypeDescriptor > accepted_types
 
std::vector< std::string > aliases
 

Detailed Description

Definition of an Operator pin.

Constructor & Destructor Documentation

◆ 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

◆ addAlias()

PinDefinition & ansys::dpf::PinDefinition::addAlias ( std::string const &  alias)
inline
Returns
Pin definition.

◆ setAcceptedTypes()

PinDefinition & ansys::dpf::PinDefinition::setAcceptedTypes ( std::vector< TypeDescriptor > const &  n)
inline
Returns
Pin definition.

◆ setAliases()

PinDefinition & ansys::dpf::PinDefinition::setAliases ( std::vector< std::string > const &  n)
inline
Returns
Pin definition.

◆ setDerivedTypeName()

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

Allows to give a custom container type as a pin type.

Returns
Pin definition.
Parameters
[in]nName of the derived class.

◆ setDoc()

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

Set description of pin.

Returns
Pin definition.
Parameters
[in]nPin description.

◆ setEllipsis()

PinDefinition & ansys::dpf::PinDefinition::setEllipsis ( bool  n)
inline
Returns
Pin definition.

◆ setName()

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

Set name of pin.

Returns
Pin definition.
Parameters
[in]nName of pin.

◆ setOptional()

PinDefinition & ansys::dpf::PinDefinition::setOptional ( bool  n)
inline

Set indication that pin is optional.

Returns
Pin definition.
Parameters
[in]nFlag indicating if pin is optional.

◆ setPosition()

PinDefinition & ansys::dpf::PinDefinition::setPosition ( int  n)
inline

Set input pin position.

Returns
Pin definition.
Parameters
[in]nPostion of pin.

Field Documentation

◆ documentation

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

Description of pin.

◆ name

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

Name of pin.

◆ position

int ansys::dpf::PinDefinition::position

Pin position number.

Connect with Ansys