Structure ansys::dpf::PinDefinition
Last update: 25.03.2026
Definition of an Operator pin.
Members
- accepted_types
- addAlias
- aliases
- derived_type_name
- documentation
- is_ellipsis
- is_inplace
- is_optional
- name
- PinDefinition
- PinDefinition
- position
- setAcceptedTypes
- setAliases
- setDerivedTypeName
- setDoc
- setEllipsis
- setName
- setOptional
- setPosition
Public attributes
Variable name
std::string ansys::dpf::PinDefinition::name
Name of pin.
Type: std::string
Variable position
int ansys::dpf::PinDefinition::position
Pin position number.
Type: int
Variable documentation
std::string ansys::dpf::PinDefinition::documentation
Description of pin.
Type: std::string
Variable is_optional
bool ansys::dpf::PinDefinition::is_optional
Type: bool
Variable is_ellipsis
bool ansys::dpf::PinDefinition::is_ellipsis
Type: bool
Variable is_inplace
bool ansys::dpf::PinDefinition::is_inplace
Type: bool
Variable derived_type_name
std::string ansys::dpf::PinDefinition::derived_type_name
Type: std::string
Variable accepted_types
std::vector<TypeDescriptor> ansys::dpf::PinDefinition::accepted_types
Type: std::vector< TypeDescriptor >
Variable aliases
std::vector<std::string> ansys::dpf::PinDefinition::aliases
Type: std::vector< std::string >
Public functions
Function PinDefinition
ansys::dpf::PinDefinition::PinDefinition()
Return type:
Function PinDefinition
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:
Function setName
PinDefinition & ansys::dpf::PinDefinition::setName(std::string const &n)
Set name of pin. Returns:
Pin definition.
Parameters:
- std::string const & n: [in] Name of pin.
Return type: PinDefinition &
Function setDerivedTypeName
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 & n: [in] Name of the derived class.
Return type: PinDefinition &
Function setPosition
PinDefinition & ansys::dpf::PinDefinition::setPosition(int n)
Set input pin position. Returns:
Pin definition.
Parameters:
- int n: [in] Postion of pin.
Return type: PinDefinition &
Function setDoc
PinDefinition & ansys::dpf::PinDefinition::setDoc(std::string const &n)
Set description of pin. Returns:
Pin definition.
Parameters:
- std::string const & n: [in] Pin description.
Return type: PinDefinition &
Function setOptional
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 &
Function setEllipsis
PinDefinition & ansys::dpf::PinDefinition::setEllipsis(bool n)
Returns:
Pin definition.
Parameters:
- bool n
Return type: PinDefinition &
Function setAcceptedTypes
PinDefinition & ansys::dpf::PinDefinition::setAcceptedTypes(std::vector< TypeDescriptor > const &n)
Returns:
Pin definition.
Parameters:
- std::vector< TypeDescriptor > const & n
Return type: PinDefinition &
Function setAliases
PinDefinition & ansys::dpf::PinDefinition::setAliases(std::vector< std::string > const &n)
Returns:
Pin definition.
Parameters:
- std::vector< std::string > const & n
Return type: PinDefinition &
Function addAlias
PinDefinition & ansys::dpf::PinDefinition::addAlias(std::string const &alias)
Returns:
Pin definition.
Parameters:
- std::string const & alias
Return type: PinDefinition &