## On this page

  

 

 # ansys::dpf::CustomTypeField Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::CustomTypeField:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2023_r2/classansys_1_1dpf_1_1CustomTypeField.png)



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

template&lt;typename UnitaryDataType &gt;  [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml#a3f3bcfe7e41a277df9619b1aa57fa3f6) ([Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client, UnitaryDataType \*, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_number\_of\_entities=0, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_num\_unitary\_data=0) template&lt;typename UnitaryDataType &gt;  [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml#ab406c3bad50d8560bd4e0122e5257516) (UnitaryDataType \*, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_number\_of\_entities=0, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_num\_unitary\_data=0)  [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml#a24749f43868490f570557f637e0f18d7) ([Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) unitary\_data\_num\_bytes, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_number\_of\_entities=0, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_num\_unitary\_data=0)  [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml#a5fc6284afa25d77a2d3c2d9476ae4890) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) unitary\_data\_num\_bytes, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_number\_of\_entities=0, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) reserved\_num\_unitary\_data=0) <a id="a256a79d53f5c20515f42ab81d0c93ad4" name="a256a79d53f5c20515f42ab81d0c93ad4"></a> **CustomTypeField** ([CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;) <a id="a39c62e4c81a27b7bd33648f1c70d4db0" name="a39c62e4c81a27b7bd33648f1c70d4db0"></a> **CustomTypeField** ([CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &amp;&amp;) <a id="a1b45c053c45379dcbda125fd584bdf77" name="a1b45c053c45379dcbda125fd584bdf77"></a>[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &amp; **operator=** ([CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;) <a id="a251577eb94afb74bb17a1314ad301dd2" name="a251577eb94afb74bb17a1314ad301dd2"></a>[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &amp; **operator=** ([CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &amp;&amp;) bool [identicalPointers](classansys_1_1dpf_1_1CustomTypeField.xhtml#a68e070597207532f062a067d3fe81bde) ([CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;f) const std::string [name](classansys_1_1dpf_1_1CustomTypeField.xhtml#af9c06ed629af1d110016d3039908e2e4) () const void [setName](classansys_1_1dpf_1_1CustomTypeField.xhtml#aa4e89d6febec7ca3f83b6ab0dd505b6d) (const std::string &amp;[name](classansys_1_1dpf_1_1CustomTypeField.xhtml#af9c06ed629af1d110016d3039908e2e4)) [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [scoping](classansys_1_1dpf_1_1CustomTypeField.xhtml#a042c55cecb14366c797e50d45d7309de) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [dataSize](classansys_1_1dpf_1_1CustomTypeField.xhtml#a6563cb6e8c2c18961279c483e978d086) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfComponents](classansys_1_1dpf_1_1CustomTypeField.xhtml#a578a721aeee9907c35e366954d1354b9) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfEntities](classansys_1_1dpf_1_1CustomTypeField.xhtml#aa9e1da353050b2c8680bb16905093bbe) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfElementaryData](classansys_1_1dpf_1_1CustomTypeField.xhtml#a8708b9441d40eb600c33b734d3eb283c) () const template&lt;typename UnitaryDataType &gt; void [push\_back](classansys_1_1dpf_1_1CustomTypeField.xhtml#a570a1b90c94c38350e28270376cfe840) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, std::vector&lt; UnitaryDataType &gt; const &amp;values) template&lt;typename UnitaryDataType &gt; void [push\_back](classansys_1_1dpf_1_1CustomTypeField.xhtml#ae709fae553fd2913b51bb0c27e18539c) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, const UnitaryDataType \*values, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) size) template&lt;typename UnitaryDataType &gt; void [setData](classansys_1_1dpf_1_1CustomTypeField.xhtml#a5ba412a54fefc3048596746369a0af9f) (std::vector&lt; UnitaryDataType &gt; const &amp;[data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da)) template&lt;typename UnitaryDataType &gt; void [setData](classansys_1_1dpf_1_1CustomTypeField.xhtml#a60880df78d5d536ba3317d36ce8dac25) (UnitaryDataType const \*const [data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da), int size) void [setDataPointer](classansys_1_1dpf_1_1CustomTypeField.xhtml#ada28e8b7fbadb7a21f0b244bbcf6bf8a) (std::vector&lt; [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) &gt; const &amp;[data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da)) void [setDataPointer](classansys_1_1dpf_1_1CustomTypeField.xhtml#aba81e2a4cb0c3559eed1189abddc52a3) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) const \*const [data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da), int size) void [setScoping](classansys_1_1dpf_1_1CustomTypeField.xhtml#aea76a334048a179f83a67b9a6d170fb2) ([ansys::dpf::Scoping](classansys_1_1dpf_1_1Scoping.xhtml) &amp;s) template&lt;typename UnitaryDataType &gt; void [getData](classansys_1_1dpf_1_1CustomTypeField.xhtml#a5d1e69ec2b7dd5476db37086e9860e35) (std::vector&lt; UnitaryDataType &gt; &amp;values\_to\_fill) const template&lt;typename UnitaryDataType &gt; [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; UnitaryDataType &gt; [data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da) () const [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; [dataPointer](classansys_1_1dpf_1_1CustomTypeField.xhtml#a58c899e74917dcbc48d90c9ed9d4a499) () const template&lt;typename UnitaryDataType &gt; void [entityData](classansys_1_1dpf_1_1CustomTypeField.xhtml#a82bad4fa98d5bae26ab4f4f85170e8ce) ([dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) entity\_index, [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; UnitaryDataType &gt; &amp;[data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da)) const template&lt;typename UnitaryDataType &gt; void [entityDataById](classansys_1_1dpf_1_1CustomTypeField.xhtml#aaf0626decc9970026265b871e403a49a) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; UnitaryDataType &gt; &amp;[data](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0cfbce21104bd69617abc711be0ab2da)) const void [reserve](classansys_1_1dpf_1_1CustomTypeField.xhtml#a0387f74d0adb7e718e07311a05ac1e2d) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) number\_of\_entities, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) overall\_size=0) void [resize](classansys_1_1dpf_1_1CustomTypeField.xhtml#ab8ae09255c5fb3b3ed8aa7e8c0c835cd) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) number\_of\_entities, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) overall\_size) [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) [fieldDefinition](classansys_1_1dpf_1_1CustomTypeField.xhtml#a20ed27c8f1a5e278b76160301c1d0e15) () const [Support](classansys_1_1dpf_1_1Support.xhtml) [support](classansys_1_1dpf_1_1CustomTypeField.xhtml#ac395281a74f1a78df961f443a32648a1) () const void [setSupport](classansys_1_1dpf_1_1CustomTypeField.xhtml#a6cc095d24302187139b81ad7843d5835) ([ansys::dpf::Support](classansys_1_1dpf_1_1Support.xhtml) &amp;s) void [setFieldDefinition](classansys_1_1dpf_1_1CustomTypeField.xhtml#a3c0e7ea1d3e5eaf8feaa633d7bf88e87) ([FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) const &amp;f) template&lt;typename UnitaryDataType &gt; bool [isOfUnitaryType](classansys_1_1dpf_1_1CustomTypeField.xhtml#aaa87bd9510ed16d0038c738385932023) () const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2023_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 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

<a id="aeff7d3639c760d711ebbc4d8deb9dceb" name="aeff7d3639c760d711ebbc4d8deb9dceb"></a>static [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) **emptyCustomTypeField** () <a id="details" name="details"></a>## Detailed Description

Holds data located on given entities (the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.")'s data is bounded with its scoping). The unitary data type can be chosen by the user (it can be int32, float, char...). Is the equivalent of the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") but with custom type values data. (and not double values).



## Constructor &amp; Destructor Documentation

<a id="a3f3bcfe7e41a277df9619b1aa57fa3f6" name="a3f3bcfe7e41a277df9619b1aa57fa3f6"></a>## [◆ ](#a3f3bcfe7e41a277df9619b1aa57fa3f6)CustomTypeField() \[1/4\]

template&lt;typename UnitaryDataType &gt; 

 ansys::dpf::CustomTypeField::CustomTypeField  ( [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*,    UnitaryDataType \*  ,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_number\_of\_entities* = `0`,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_num\_unitary\_data* = `0`   ) 

Create an empty custom type field with a client. The unitary data type will be UnitaryDataType. For example, use [ansys::dpf::CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) f(ansys::dpf::UseType&lt;float&gt;()).

Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) to create the custom property field on. \[in\]reserved\_number\_of\_entitiesNumber of entities to reserve in the scoping. \[in\]reserved\_num\_unitary\_dataReserved size of data=reserved\_num\_unitary\_data\*unitary\_data\_num\_bytes. 



<a id="ab406c3bad50d8560bd4e0122e5257516" name="ab406c3bad50d8560bd4e0122e5257516"></a>## [◆ ](#ab406c3bad50d8560bd4e0122e5257516)CustomTypeField() \[2/4\]

template&lt;typename UnitaryDataType &gt; 

 ansys::dpf::CustomTypeField::CustomTypeField  ( UnitaryDataType \*  ,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_number\_of\_entities* = `0`,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_num\_unitary\_data* = `0`   ) 

Create a property with number of entities and data size. The unitary data type will be UnitaryDataType. For example, use [ansys::dpf::CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) f(ansys::dpf::UseType&lt;float&gt;()).

Parameters \[in\]reserved\_number\_of\_entitiesNumber of entities to reserve in the scoping. \[in\]reserved\_num\_unitary\_dataReserved size of data=reserved\_num\_unitary\_data\*unitary\_data\_num\_bytes. 



<a id="a24749f43868490f570557f637e0f18d7" name="a24749f43868490f570557f637e0f18d7"></a>## [◆ ](#a24749f43868490f570557f637e0f18d7)CustomTypeField() \[3/4\]

 ansys::dpf::CustomTypeField::CustomTypeField  ( [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *unitary\_data\_num\_bytes*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_number\_of\_entities* = `0`,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_num\_unitary\_data* = `0`   ) 

Create an empty custom type field with a client. The unitary data type will be of size unitary\_data\_num\_bytes.

Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) to create the custom property field on. \[in\]unitary\_data\_num\_bytesNum bytes by unitary data. \[in\]reserved\_number\_of\_entitiesNumber of entities to reserve in the scoping. \[in\]reserved\_num\_unitary\_dataReserved size of data=reserved\_num\_unitary\_data\*unitary\_data\_num\_bytes. 



<a id="a5fc6284afa25d77a2d3c2d9476ae4890" name="a5fc6284afa25d77a2d3c2d9476ae4890"></a>## [◆ ](#a5fc6284afa25d77a2d3c2d9476ae4890)CustomTypeField() \[4/4\]

 ansys::dpf::CustomTypeField::CustomTypeField  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *unitary\_data\_num\_bytes*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_number\_of\_entities* = `0`,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *reserved\_num\_unitary\_data* = `0`   ) 

Create a property with number of entities and data size. The unitary data type will be of size unitary\_data\_num\_bytes.

Parameters \[in\]unitary\_data\_num\_bytesNum bytes by unitary data. \[in\]reserved\_number\_of\_entitiesNumber of entities to reserve in the scoping. \[in\]reserved\_num\_unitary\_dataReserved size of data=reserved\_num\_unitary\_data\*unitary\_data\_num\_bytes. 



## Member Function Documentation

<a id="a0cfbce21104bd69617abc711be0ab2da" name="a0cfbce21104bd69617abc711be0ab2da"></a>## [◆ ](#a0cfbce21104bd69617abc711be0ab2da)data()

template&lt;typename UnitaryDataType &gt; 

 [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; UnitaryDataType &gt; ansys::dpf::CustomTypeField::data

Returns[DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml) of data array. The unitary data type should be UnitaryDataType. 



<a id="a58c899e74917dcbc48d90c9ed9d4a499" name="a58c899e74917dcbc48d90c9ed9d4a499"></a>## [◆ ](#a58c899e74917dcbc48d90c9ed9d4a499)dataPointer()

 [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; ansys::dpf::CustomTypeField::dataPointer  ( )  const

Returns[DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml) of data array. 



<a id="a6563cb6e8c2c18961279c483e978d086" name="a6563cb6e8c2c18961279c483e978d086"></a>## [◆ ](#a6563cb6e8c2c18961279c483e978d086)dataSize()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CustomTypeField::dataSize  ( )  const

ReturnsSize of the data container. 



<a id="a82bad4fa98d5bae26ab4f4f85170e8ce" name="a82bad4fa98d5bae26ab4f4f85170e8ce"></a>## [◆ ](#a82bad4fa98d5bae26ab4f4f85170e8ce)entityData()

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::entityData  ( [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *entity\_index*,    [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; UnitaryDataType &gt; &amp;  *data*   )  const

Returns[DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml) of data array of an entity, by index. The unitary data type should be UnitaryDataType. Parameters \[in\]entity\_indexIndex of entity for which to get data. \[out\]dataPointer to the data. 



<a id="aaf0626decc9970026265b871e403a49a" name="aaf0626decc9970026265b871e403a49a"></a>## [◆ ](#aaf0626decc9970026265b871e403a49a)entityDataById()

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::entityDataById  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *entity\_id*,    [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; UnitaryDataType &gt; &amp;  *data*   )  const

Returns[DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml) of data array of an entity, by id. The unitary data type should be UnitaryDataType. Parameters \[in\]entity\_idId of entity for which to get data. \[out\]dataPointer to the data. 



<a id="a20ed27c8f1a5e278b76160301c1d0e15" name="a20ed27c8f1a5e278b76160301c1d0e15"></a>## [◆ ](#a20ed27c8f1a5e278b76160301c1d0e15)fieldDefinition()

 [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) ansys::dpf::CustomTypeField::fieldDefinition  ( )  const

Returns[FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) of the field. 



<a id="a5d1e69ec2b7dd5476db37086e9860e35" name="a5d1e69ec2b7dd5476db37086e9860e35"></a>## [◆ ](#a5d1e69ec2b7dd5476db37086e9860e35)getData()

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::getData  ( std::vector&lt; UnitaryDataType &gt; &amp;  *values\_to\_fill*)  const

Get all data for property entities. The unitary data type should be UnitaryDataType.

Parameters \[out\]values\_to\_fillProperty entity data. 



<a id="a68e070597207532f062a067d3fe81bde" name="a68e070597207532f062a067d3fe81bde"></a>## [◆ ](#a68e070597207532f062a067d3fe81bde)identicalPointers()

 bool ansys::dpf::CustomTypeField::identicalPointers  ( [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;  *f*)  const

Compare field with input field f.

Parameters \[in\]f[Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") with which to compare. 



<a id="aaa87bd9510ed16d0038c738385932023" name="aaa87bd9510ed16d0038c738385932023"></a>## [◆ ](#aaa87bd9510ed16d0038c738385932023)isOfUnitaryType()

template&lt;typename UnitaryDataType &gt; 

 bool ansys::dpf::CustomTypeField::isOfUnitaryType

tests the type of the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.").





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

 std::string ansys::dpf::CustomTypeField::name  ( )  const

ReturnsName of [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml). 



<a id="a578a721aeee9907c35e366954d1354b9" name="a578a721aeee9907c35e366954d1354b9"></a>## [◆ ](#a578a721aeee9907c35e366954d1354b9)numberOfComponents()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CustomTypeField::numberOfComponents  ( )  const

ReturnsNumber of components in the property data. 



<a id="a8708b9441d40eb600c33b734d3eb283c" name="a8708b9441d40eb600c33b734d3eb283c"></a>## [◆ ](#a8708b9441d40eb600c33b734d3eb283c)numberOfElementaryData()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CustomTypeField::numberOfElementaryData  ( )  const

ReturnsNumber of elementary data (size = number of components) contained in the [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml). 



<a id="aa9e1da353050b2c8680bb16905093bbe" name="aa9e1da353050b2c8680bb16905093bbe"></a>## [◆ ](#aa9e1da353050b2c8680bb16905093bbe)numberOfEntities()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CustomTypeField::numberOfEntities  ( )  const

ReturnsNumber of entities in the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") Only implemented for in process udage. For gRPC usage, use [scoping()](classansys_1_1dpf_1_1CustomTypeField.xhtml#a042c55cecb14366c797e50d45d7309de).size(). 



<a id="ae709fae553fd2913b51bb0c27e18539c" name="ae709fae553fd2913b51bb0c27e18539c"></a>## [◆ ](#ae709fae553fd2913b51bb0c27e18539c)push\_back() \[1/2\]

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::push\_back  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *entity\_id*,    const UnitaryDataType \*  *values*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *size*   ) 

Push back the entity data. The unitary data type should be UnitaryDataType.

Parameters \[in\]entity\_idIndex of entity for which to push data. \[in\]valuesPtr on data for entity. \[in\]sizeNumber of entities. 



<a id="a570a1b90c94c38350e28270376cfe840" name="a570a1b90c94c38350e28270376cfe840"></a>## [◆ ](#a570a1b90c94c38350e28270376cfe840)push\_back() \[2/2\]

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::push\_back  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *entity\_id*,    std::vector&lt; UnitaryDataType &gt; const &amp;  *values*   ) 

Push back the entity data. The unitary data type should be UnitaryDataType.

Parameters \[in\]entity\_idId of entity for which to push data. \[in\]valuesVector of data for entity. 



<a id="a0387f74d0adb7e718e07311a05ac1e2d" name="a0387f74d0adb7e718e07311a05ac1e2d"></a>## [◆ ](#a0387f74d0adb7e718e07311a05ac1e2d)reserve()

 void ansys::dpf::CustomTypeField::reserve  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *number\_of\_entities*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *overall\_size* = `0`   ) 

Reserve the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity."). Only implemented for in process udage. To reserve the size for gRPC usage, use the constructor.

Parameters \[in\]number\_of\_entitiesNumber of entities. \[in\]overall\_sizeTotal size of entity data. 



<a id="ab8ae09255c5fb3b3ed8aa7e8c0c835cd" name="ab8ae09255c5fb3b3ed8aa7e8c0c835cd"></a>## [◆ ](#ab8ae09255c5fb3b3ed8aa7e8c0c835cd)resize()

 void ansys::dpf::CustomTypeField::resize  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *number\_of\_entities*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *overall\_size*   ) 

Reserve the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.").

Parameters \[in\]number\_of\_entitiesNumber of entities. \[in\]overall\_sizeTotal size of entity data. 



<a id="a042c55cecb14366c797e50d45d7309de" name="a042c55cecb14366c797e50d45d7309de"></a>## [◆ ](#a042c55cecb14366c797e50d45d7309de)scoping()

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::CustomTypeField::scoping  ( )  const

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) of the property. 



<a id="a5ba412a54fefc3048596746369a0af9f" name="a5ba412a54fefc3048596746369a0af9f"></a>## [◆ ](#a5ba412a54fefc3048596746369a0af9f)setData() \[1/2\]

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::setData  ( std::vector&lt; UnitaryDataType &gt; const &amp;  *data*) 

Set the data of the custom property field.

Push back the entity data. The unitary data type should be UnitaryDataType.

Parameters \[in\]dataVector of data. 



<a id="a60880df78d5d536ba3317d36ce8dac25" name="a60880df78d5d536ba3317d36ce8dac25"></a>## [◆ ](#a60880df78d5d536ba3317d36ce8dac25)setData() \[2/2\]

template&lt;typename UnitaryDataType &gt; 

 void ansys::dpf::CustomTypeField::setData  ( UnitaryDataType const \*const  *data*,    int  *size*   ) 

Set the data of the custom property field. The unitary data type should be UnitaryDataType.

Parameters \[in\]dataList of data. \[in\]sizeSize of list. 



<a id="aba81e2a4cb0c3559eed1189abddc52a3" name="aba81e2a4cb0c3559eed1189abddc52a3"></a>## [◆ ](#aba81e2a4cb0c3559eed1189abddc52a3)setDataPointer() \[1/2\]

 void ansys::dpf::CustomTypeField::setDataPointer  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) const \*const  *data*,    int  *size*   ) 

Set the data pointer of the custom type field.

Parameters \[in\]dataList of data. \[in\]sizeSize of list. 



<a id="ada28e8b7fbadb7a21f0b244bbcf6bf8a" name="ada28e8b7fbadb7a21f0b244bbcf6bf8a"></a>## [◆ ](#ada28e8b7fbadb7a21f0b244bbcf6bf8a)setDataPointer() \[2/2\]

 void ansys::dpf::CustomTypeField::setDataPointer  ( std::vector&lt; [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) &gt; const &amp;  *data*) 

Set the data pointer of the custom type field.

Parameters \[in\]dataVector of data. 



<a id="a3c0e7ea1d3e5eaf8feaa633d7bf88e87" name="a3c0e7ea1d3e5eaf8feaa633d7bf88e87"></a>## [◆ ](#a3c0e7ea1d3e5eaf8feaa633d7bf88e87)setFieldDefinition()

 void ansys::dpf::CustomTypeField::setFieldDefinition  ( [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) const &amp;  *f*) 

Set the [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml).





<a id="aa4e89d6febec7ca3f83b6ab0dd505b6d" name="aa4e89d6febec7ca3f83b6ab0dd505b6d"></a>## [◆ ](#aa4e89d6febec7ca3f83b6ab0dd505b6d)setName()

 void ansys::dpf::CustomTypeField::setName  ( const std::string &amp;  *name*) 

Set name of [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml).

Parameters \[in\]nameNew name. 



<a id="aea76a334048a179f83a67b9a6d170fb2" name="aea76a334048a179f83a67b9a6d170fb2"></a>## [◆ ](#aea76a334048a179f83a67b9a6d170fb2)setScoping()

 void ansys::dpf::CustomTypeField::setScoping  ( [ansys::dpf::Scoping](classansys_1_1dpf_1_1Scoping.xhtml) &amp;  *s*) 

Set the scoping of the custom property field.





<a id="a6cc095d24302187139b81ad7843d5835" name="a6cc095d24302187139b81ad7843d5835"></a>## [◆ ](#a6cc095d24302187139b81ad7843d5835)setSupport()

 void ansys::dpf::CustomTypeField::setSupport  ( [ansys::dpf::Support](classansys_1_1dpf_1_1Support.xhtml) &amp;  *s*) 

Set the support of the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.").

Parameters \[in\]s[Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") to support. 



<a id="ac395281a74f1a78df961f443a32648a1" name="ac395281a74f1a78df961f443a32648a1"></a>## [◆ ](#ac395281a74f1a78df961f443a32648a1)support()

 [Support](classansys_1_1dpf_1_1Support.xhtml) ansys::dpf::CustomTypeField::support  ( )  const

Returns[Support](classansys_1_1dpf_1_1Support.xhtml) of the field.