## On this page

  

 

 # ansys::dpf::GenericSupport Class Reference

 Last update: 16.07.2025 

Define a generic support. [More...](classansys_1_1dpf_1_1GenericSupport.xhtml#details)

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::GenericSupport:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/classansys_1_1dpf_1_1GenericSupport.png)



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

<a id="aed6480294bd5095215fdd1468fc4215b" name="aed6480294bd5095215fdd1468fc4215b"></a> **GenericSupport** ([Location](structansys_1_1dpf_1_1Location.xhtml) const &amp;location)  [GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml#ab69289ea19752bb26eff730f73269ede) ([Location](structansys_1_1dpf_1_1Location.xhtml) const &amp;location, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) <a id="a507d80322d882d68d1f826612c4cb283" name="a507d80322d882d68d1f826612c4cb283"></a> **GenericSupport** ([GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) const &amp;) <a id="a21a8be4f117cfebba72b1a4dfeb0aa68" name="a21a8be4f117cfebba72b1a4dfeb0aa68"></a> **GenericSupport** ([GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) &amp;&amp;) noexcept <a id="a9c2e1f7c456ff805191d412c2254d832" name="a9c2e1f7c456ff805191d412c2254d832"></a>[GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) &amp; **operator=** ([GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) const &amp;) <a id="a340450fcae90eadbcf25a7b18f5fe6e2" name="a340450fcae90eadbcf25a7b18f5fe6e2"></a>[GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) &amp; **operator=** ([GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) &amp;&amp;) noexcept void [setSupportOfProperty](classansys_1_1dpf_1_1GenericSupport.xhtml#af2e77d87cb69995c0189349ee42264b3) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name, [Field](classansys_1_1dpf_1_1Field.xhtml) const &amp;field) const void [setSupportOfProperty](classansys_1_1dpf_1_1GenericSupport.xhtml#a3315d3bd4873c1bc7d5f96a94c8a13ca) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name, [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;field) const void [setSupportOfProperty](classansys_1_1dpf_1_1GenericSupport.xhtml#a4cff390263e550b35c34bbc7f7f675d4) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name, [StringField](classansys_1_1dpf_1_1StringField.xhtml) const &amp;field) const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/closed.png) Public Member Functions inherited from [ansys::dpf::Support](classansys_1_1dpf_1_1Support.xhtml)<a id="a7437ca78d2d2fa368dc0063fdf3c221a" name="a7437ca78d2d2fa368dc0063fdf3c221a"></a> **Support** ([Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;) <a id="a71326b7a5a317dd79c6b97a4eb18e79a" name="a71326b7a5a317dd79c6b97a4eb18e79a"></a> **Support** ([Support](classansys_1_1dpf_1_1Support.xhtml) &amp;&amp;) noexcept <a id="aafaebcbcdc49b2ab6fe730399f382d81" name="aafaebcbcdc49b2ab6fe730399f382d81"></a>[Support](classansys_1_1dpf_1_1Support.xhtml) &amp; **operator=** ([Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;) <a id="a8584e7d484ca126718b4bd7e563011de" name="a8584e7d484ca126718b4bd7e563011de"></a>[Support](classansys_1_1dpf_1_1Support.xhtml) &amp; **operator=** ([Support](classansys_1_1dpf_1_1Support.xhtml) &amp;&amp;) noexcept bool [isMeshedDomain](classansys_1_1dpf_1_1Support.xhtml#a3cad097e6d82306d5ab8ba23bdb7c8ff) () const [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) [getAsDomainMesh](classansys_1_1dpf_1_1Support.xhtml#a244cc29be85eb6192faf468268478064) () const [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) [getAsCyclicSupport](classansys_1_1dpf_1_1Support.xhtml#a5903cf9eb1f3f3fec9fc0a22331db3d3) () const [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) [getAsTimeFreqSupport](classansys_1_1dpf_1_1Support.xhtml#a2ced0ad4403332166b14f301d67f4a4e) () const [Field](classansys_1_1dpf_1_1Field.xhtml) [getFieldSupportByProperty](classansys_1_1dpf_1_1Support.xhtml#aa4704f682e0e0543acf44e37e9350aab) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name) const [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [getPropertyFieldSupportByProperty](classansys_1_1dpf_1_1Support.xhtml#a7b80b961c6418d9c54bb2d50560d3d2f) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name) const [StringField](classansys_1_1dpf_1_1StringField.xhtml) [getStringFieldSupportByProperty](classansys_1_1dpf_1_1Support.xhtml#a85465ef9621478e6990fddc5ecddc264) ([PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;property\_name) const std::vector&lt; std::string &gt; [getAvailablePropertyNamesForFields](classansys_1_1dpf_1_1Support.xhtml#ac6c5332826a5eb2814e71a02fe3e7132) () const std::vector&lt; std::string &gt; [getAvailablePropertyNamesForPropertyFields](classansys_1_1dpf_1_1Support.xhtml#adb40c35236879d4d6d8a418c618a2f00) () const std::vector&lt; std::string &gt; [getAvailablePropertyNamesForStringFields](classansys_1_1dpf_1_1Support.xhtml#aefed9b020ce057f1c59e87c5cd0c11f5) () const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/closed.png) Public Member Functions inherited from [ansys::dpf::DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml)virtual bool [empty](classansys_1_1dpf_1_1DpfTypes.xhtml#a39cd546c42518e2332be8f287db95459) () const virtual bool [hasInternalObject](classansys_1_1dpf_1_1DpfTypes.xhtml#ae198f89868d85c7db6dc1a934a1d3c15) () const virtual std::string [describe](classansys_1_1dpf_1_1DpfTypes.xhtml#a9977945710983bc03d2940fa007847b2) () const so::API const \* [callAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#aea34d37e0c080126eff70db34bf46597) () const bool [isOnCommonAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#a9f9789ff61cc9d400a2a344830706b73) () const bool [getClient](classansys_1_1dpf_1_1DpfTypes.xhtml#a968afd9daa0b0f13b65a2ac61369d73a) ([Client](classansys_1_1dpf_1_1Client.xhtml) &amp;client) const bool [hasBeenMovedLocally](classansys_1_1dpf_1_1DpfTypes.xhtml#a1a5634202c15404b6b24e8f50e51cb66) () const bool [isSameObject](classansys_1_1dpf_1_1DpfTypes.xhtml#aa64d5f8fcd7d85ad6ebf708494dbefd7) ([DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) const &amp;rhs) const ## <a id="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static [GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) [emptyGenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml#aa561f217253e9f5ef38c1d027d08b560) () ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/closed.png) Static Public Member Functions inherited from [ansys::dpf::Support](classansys_1_1dpf_1_1Support.xhtml)static [Support](classansys_1_1dpf_1_1Support.xhtml) [emptySupport](classansys_1_1dpf_1_1Support.xhtml#ad5b62f0bc3fc29380461006280edf89b) () <a id="details" name="details"></a>## Detailed Description

Define a generic support.

[GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) can support a location to describe its domain with its scope and properties.



## Constructor &amp; Destructor Documentation

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

 ansys::dpf::GenericSupport::GenericSupport  ( [Location](structansys_1_1dpf_1_1Location.xhtml) const &amp;  *location*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   ) 

Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



## Member Function Documentation

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

 static [GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) ansys::dpf::GenericSupport::emptyGenericSupport  ( )   static 

Create an empty support.

ReturnsEmpty [Support](classansys_1_1dpf_1_1Support.xhtml). 



<a id="af2e77d87cb69995c0189349ee42264b3" name="af2e77d87cb69995c0189349ee42264b3"></a>## [◆ ](#af2e77d87cb69995c0189349ee42264b3)setSupportOfProperty() \[1/3\]

 void ansys::dpf::GenericSupport::setSupportOfProperty  ( [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;  *property\_name*,    [Field](classansys_1_1dpf_1_1Field.xhtml) const &amp;  *field*   )  const

insert (if new) or replace a property with its name and [Field](classansys_1_1dpf_1_1Field.xhtml) value.





<a id="a3315d3bd4873c1bc7d5f96a94c8a13ca" name="a3315d3bd4873c1bc7d5f96a94c8a13ca"></a>## [◆ ](#a3315d3bd4873c1bc7d5f96a94c8a13ca)setSupportOfProperty() \[2/3\]

 void ansys::dpf::GenericSupport::setSupportOfProperty  ( [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;  *property\_name*,    [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;  *field*   )  const

insert (if new) or replace a property with its name and [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) value.





<a id="a4cff390263e550b35c34bbc7f7f675d4" name="a4cff390263e550b35c34bbc7f7f675d4"></a>## [◆ ](#a4cff390263e550b35c34bbc7f7f675d4)setSupportOfProperty() \[3/3\]

 void ansys::dpf::GenericSupport::setSupportOfProperty  ( [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) const &amp;  *property\_name*,    [StringField](classansys_1_1dpf_1_1StringField.xhtml) const &amp;  *field*   )  const

insert (if new) or replace a property with its name and [StringField](classansys_1_1dpf_1_1StringField.xhtml) value.