Class ansys::dpf::Interface
Last update: 25.03.2026
Interface specifies a set of constraints that an underlying implementation (operator or workflow) must respect.
Members
- get
- getCacheInformation
- getExposedInputs
- getExposedOutputs
- getName
- Interface
- Interface
- Interface
- isOptional
- isToCache
Public functions
Function Interface
ansys::dpf::Interface::Interface()=default
Return type:
Function Interface
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 & name
- const std::vector< std::string > & exposedInputs
- const std::vector< std::string > & exposedOutputs
- const CacheInformation & cacheInformation = CacheInformation()
- bool isOptional = false
Return type:
Function Interface
ansys::dpf::Interface::Interface(const DataTree &dt)
Parameters:
- const DataTree & dt
Return type:
Function getName
std::string ansys::dpf::Interface::getName() const noexcept
Return type: std::string
Function get
DataTree ansys::dpf::Interface::get() const
Return type: DataTree
Function getExposedInputs
std::vector< std::string > ansys::dpf::Interface::getExposedInputs() const noexcept
Return type: std::vector< std::string >
Function getExposedOutputs
std::vector< std::string > ansys::dpf::Interface::getExposedOutputs() const noexcept
Return type: std::vector< std::string >
Function getCacheInformation
std::map< std::string, CacheInformation::LevelAndDestination > ansys::dpf::Interface::getCacheInformation() const
Return type: std::map< std::string, CacheInformation::LevelAndDestination >
Function isToCache
bool ansys::dpf::Interface::isToCache(const std::string &pinName) const noexcept
Parameters:
- const std::string & pinName
Return type: bool
Function isOptional
bool ansys::dpf::Interface::isOptional() const noexcept
Return type: bool