ansys::dpf::GenericSupport Class Reference
Last update: 10.07.2023
ansys::dpf::GenericSupport Class Reference
Define a generic support. More...
#include <dpf_api.h>
Inheritance diagram for ansys::dpf::GenericSupport:
Public Member Functions | |
| GenericSupport (Location const &location) | |
| GenericSupport (Location const &location, Client const *const client) | |
| GenericSupport (GenericSupport const &) | |
| GenericSupport (GenericSupport &&) | |
| GenericSupport & | operator= (GenericSupport const &) |
| GenericSupport & | operator= (GenericSupport &&) |
| void | setSupportOfProperty (PropertyType const &property_name, Field const &field) const |
| void | setSupportOfProperty (PropertyType const &property_name, PropertyField const &field) const |
| void | setSupportOfProperty (PropertyType const &property_name, StringField const &field) const |
 Public Member Functions inherited from ansys::dpf::Support | |
| Support (Support const &) | |
| Support (Support &&) | |
| Support & | operator= (Support const &) |
| Support & | operator= (Support &&) |
| bool | isMeshedDomain () const |
| MeshedRegion | getAsDomainMesh () const |
| CyclicSupport | getAsCyclicSupport () const |
| TimeFreqSupport | getAsTimeFreqSupport () const |
| Field | getFieldSupportByProperty (PropertyType const &property_name) const |
| PropertyField | getPropertyFieldSupportByProperty (PropertyType const &property_name) const |
| StringField | getStringFieldSupportByProperty (PropertyType const &property_name) const |
| std::vector< std::string > | getAvailablePropertyNamesForFields () const |
| std::vector< std::string > | getAvailablePropertyNamesForPropertyFields () const |
| std::vector< std::string > | getAvailablePropertyNamesForStringFields () const |
| Public Member Functions inherited from ansys::dpf::DpfTypes | |
| virtual bool | empty () const |
| virtual std::string | describe () const |
| so::API const * | callAPI () const |
| bool | isOnCommonAPI () const |
| bool | getClient (Client &client) const |
| bool | hasBeenMovedLocally () const |
| bool | isSameObject (DpfTypes const &rhs) const |
Static Public Member Functions | |
| static GenericSupport | emptyGenericSupport () |
| Static Public Member Functions inherited from ansys::dpf::Support | |
| static Support | emptySupport () |
Detailed Description
Define a generic support.
GenericSupport can support a location to describe its domain with its scope and properties.
Constructor & Destructor Documentation
◆ GenericSupport()
| ansys::dpf::GenericSupport::GenericSupport | ( | Location const & | location, |
| Client const *const | client | ||
| ) |
- Parameters
-
[in] client Client instance designating the IP, port and protocol to use.
Member Function Documentation
◆ emptyGenericSupport()
|
static |
Create an empty support.
- Returns
- Empty Support.
◆ setSupportOfProperty() [1/3]
| void ansys::dpf::GenericSupport::setSupportOfProperty | ( | PropertyType const & | property_name, |
| Field const & | field | ||
| ) | const |
insert (if new) or replace a property with its name and Field value.
◆ setSupportOfProperty() [2/3]
| void ansys::dpf::GenericSupport::setSupportOfProperty | ( | PropertyType const & | property_name, |
| PropertyField const & | field | ||
| ) | const |
insert (if new) or replace a property with its name and PropertyField value.
◆ setSupportOfProperty() [3/3]
| void ansys::dpf::GenericSupport::setSupportOfProperty | ( | PropertyType const & | property_name, |
| StringField const & | field | ||
| ) | const |
insert (if new) or replace a property with its name and StringField value.