## On this page

  

 

 # ansys::dpf::PropertyField Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::PropertyField:

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



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

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml#aae094e83275af15988f720966683078a) ([Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) number\_of\_entities=0, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) data\_size=0)  [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml#ac8723c38fad6636b55b31a3d6d8ccc76) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) number\_of\_entities=0, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) data\_size=0)  [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml#a88b5dfeb3f030e6afbfbf87efbcc3561) (int id, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) <a id="ad787ee870fa5d12ba322bd1d3bbb52cd" name="ad787ee870fa5d12ba322bd1d3bbb52cd"></a> **PropertyField** ([PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;) <a id="a89260e610bdbe97eaf9a0f6364daf0de" name="a89260e610bdbe97eaf9a0f6364daf0de"></a> **PropertyField** ([PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) &amp;&amp;) noexcept <a id="adec6a0cbb0a46d7831e223fad50aab62" name="adec6a0cbb0a46d7831e223fad50aab62"></a>[PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) &amp; **operator=** ([PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;) <a id="a790b5c4569b3f2b6c58c0e9292147d12" name="a790b5c4569b3f2b6c58c0e9292147d12"></a>[PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) &amp; **operator=** ([PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) &amp;&amp;) noexcept [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) [fieldDefinition](classansys_1_1dpf_1_1PropertyField.xhtml#a4df2020806c5f8d2ace1faa6b26a1ecb) () const void [setFieldDefinition](classansys_1_1dpf_1_1PropertyField.xhtml#a4ed774aecf5c68516a17da55da7b0ff7) ([FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) const &amp;f) std::string [name](classansys_1_1dpf_1_1PropertyField.xhtml#aaf5a2e4abe9da5e77cc7b954b0ef81ba) () const void [setName](classansys_1_1dpf_1_1PropertyField.xhtml#aefb5d03109bcc57f95ca1257ab92ed7b) (const std::string &amp;[name](classansys_1_1dpf_1_1PropertyField.xhtml#aaf5a2e4abe9da5e77cc7b954b0ef81ba)) [Location](structansys_1_1dpf_1_1Location.xhtml) [location](classansys_1_1dpf_1_1PropertyField.xhtml#a9dbf80f14848a93eb311d97a4b3da8dd) () const [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [scoping](classansys_1_1dpf_1_1PropertyField.xhtml#a9d57c8ecf193532958d34de87db60da0) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [dataSize](classansys_1_1dpf_1_1PropertyField.xhtml#af0ff358222e067e0c03d588a6b11b04c) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfComponents](classansys_1_1dpf_1_1PropertyField.xhtml#a1a2b01c58216827f720b4a76a8f52d9d) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfElementaryData](classansys_1_1dpf_1_1PropertyField.xhtml#a3cb32ee79adc23f5c7ab5f6b6d831e26) () const void [push\_back](classansys_1_1dpf_1_1PropertyField.xhtml#a74bc6460d3924f837b480b725f2d230c) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, std::vector&lt; int &gt; const &amp;values) void [push\_back](classansys_1_1dpf_1_1PropertyField.xhtml#ac709022d579f02b554fdc06fe0a59f7f) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, const int \*values, int size) void [push\_back](classansys_1_1dpf_1_1PropertyField.xhtml#a2200849fcd3d0c6ebc171b15d9cb8e54) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, int \*values, int size) void [setData](classansys_1_1dpf_1_1PropertyField.xhtml#ae40e20aaa78a8bfc6ff8176cb9381152) (std::vector&lt; int &gt; const &amp;[data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c)) void [setData](classansys_1_1dpf_1_1PropertyField.xhtml#a74e8c4842a23651d988f8a264c9eabe6) (int const \*const [data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c), int size) void [setDataPointer](classansys_1_1dpf_1_1PropertyField.xhtml#afb3f6cd0c63ea162c4a7a53ef8066e7f) (std::vector&lt; int &gt; const &amp;[data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c)) void [setDataPointer](classansys_1_1dpf_1_1PropertyField.xhtml#a4e7b773455c0cf6aefdfaa5e25261940) (int \*const [data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c), int size) void [setScoping](classansys_1_1dpf_1_1PropertyField.xhtml#a3aaa76eee8c33c5b3459a280fdcc6838) ([ansys::dpf::Scoping](classansys_1_1dpf_1_1Scoping.xhtml) &amp;s) const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) \* [dataByIndex](classansys_1_1dpf_1_1PropertyField.xhtml#a8b09b1109c854475c4af16cba105a667) ([dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) entity\_index, int &amp;size) const const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) \* [dataById](classansys_1_1dpf_1_1PropertyField.xhtml#aa32b0e1c2611e88a2aef55c94a8c6880) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, int &amp;size) const void [fillCursor](classansys_1_1dpf_1_1PropertyField.xhtml#a90f3baa944b4dd1a49adbcbec5a3d766) ([dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) index, [PropFieldCursor](classansys_1_1dpf_1_1PropFieldCursor.xhtml) &amp;cursor) const void [getIds](classansys_1_1dpf_1_1PropertyField.xhtml#a55c6d4eb97b98ca58672b149e2bf1483) (std::vector&lt; [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) &gt; &amp;ids\_to\_fill) const void [getData](classansys_1_1dpf_1_1PropertyField.xhtml#ab4fd6ed2f236efb404d4454944b4474b) (std::vector&lt; [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp;values\_to\_fill) const [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; [data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c) () const [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; [dataPointer](classansys_1_1dpf_1_1PropertyField.xhtml#a7b2afaba19a4b177460572a231c5275b) () const void [entityData](classansys_1_1dpf_1_1PropertyField.xhtml#a78f843b67d4df51c5bd0c57f98d9cc17) ([dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) entity\_index, [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; &amp;[data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c)) const void [entityDataById](classansys_1_1dpf_1_1PropertyField.xhtml#a433fe762b8bbf44c5cb7bc09e8e4f7a7) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) entity\_id, [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; &amp;[data](classansys_1_1dpf_1_1PropertyField.xhtml#ac77c2c8994da1d1511c69849257c748c)) const void [reserve](classansys_1_1dpf_1_1PropertyField.xhtml#ad7e142a83fd4138694a80f1a36bb778a) ([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_1PropertyField.xhtml#aafa75bc6e0e191b4914282ad620a5c35) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) number\_of\_entities, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) overall\_size) [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [deep\_copy](classansys_1_1dpf_1_1PropertyField.xhtml#ac440564a6c9b1f9266c72d600da28179) ([ansys::dpf::Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) const [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [deep\_copy](classansys_1_1dpf_1_1PropertyField.xhtml#a78cd4e97e8ad454271fe4ccdf896e842) () 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

<a id="aac8837afab55e9ebe3087e966ebc9edd" name="aac8837afab55e9ebe3087e966ebc9edd"></a>static [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) **emptyPropertyField** () static [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [createPropertyFieldWithTransformation](classansys_1_1dpf_1_1PropertyField.xhtml#a0ca259df13f04a150585337c7914c37e) ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) transformation\_wf, int reserved\_number\_of\_entity=0, int reserved\_data\_size=0, std::string const &amp;input\_name\_to\_connect="input\_field", std::string const &amp;output\_name\_to\_eval="transformed\_field") <a id="details" name="details"></a>## Detailed Description

Holds Integral (int32) data describing a Property located on given entities (the Property [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.")'s data is bounded with its scoping). Is the equivalent of the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") but with integral values data (and not double values).

Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#_a59), and [ModelTest.cpp](ModelTest_8cpp-example.xhtml#_a8).

## Constructor &amp; Destructor Documentation

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

 ansys::dpf::PropertyField::PropertyField  ( [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *number\_of\_entities* = `0`,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *data\_size* = `0`   ) 

Create an empty property field with a client.

Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) to create the property field on. \[in\]number\_of\_entitiesNumber of entities. \[in\]data\_sizeReserved size of data. 



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

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

Create a property with number of entities and data size.

Parameters \[in\]number\_of\_entitiesNumber of entities. \[in\]data\_sizeReserved size of data. 



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

 ansys::dpf::PropertyField::PropertyField  ( int  *id*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   ) 

Retrieve an existing instance of [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) on a server.

Parameters \[in\]idId of the [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity.") object on the server's database. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



## Member Function Documentation

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

 static [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::PropertyField::createPropertyFieldWithTransformation  ( [Workflow](classansys_1_1dpf_1_1Workflow.xhtml)  *transformation\_wf*,    int  *reserved\_number\_of\_entity* = `0`,    int  *reserved\_data\_size* = `0`,    std::string const &amp;  *input\_name\_to\_connect* = `"input_field"`,    std::string const &amp;  *output\_name\_to\_eval* = `"transformed_field"`   )   static 

Instantiate a [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) with Transformation. For each call to a getter, the workflow in input is connected this [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) to input\_name\_to\_connect and the [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) output in output\_name\_to\_eval is used as the getter instance.

Parameters \[in\]transformation\_wfTransformation workflow. \[in\]input\_name\_to\_connectName of the input of the workflow to connect. Should take a [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity."). \[in\]output\_name\_to\_evalName of the output of the workflow to evaluate. Should return a [Field](classansys_1_1dpf_1_1Field.xhtml "Data for an entity."). 



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

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

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



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

 const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) \* ansys::dpf::PropertyField::dataById  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *entity\_id*,    int &amp;  *size*   )  const

ReturnsPointer to entity data given by id. Parameters \[in\]entity\_idId of entity for which to get data. \[out\]sizeSize of return data. 



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

 const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) \* ansys::dpf::PropertyField::dataByIndex  ( [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *entity\_index*,    int &amp;  *size*   )  const

ReturnsPointer to entity data given by index. Parameters \[in\]entity\_indexIndex of entity for which to get data. \[out\]sizeSize of return data. 



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

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

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



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

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

ReturnsSize of the data container. Examples[ModelTest.cpp](ModelTest_8cpp-example.xhtml#a10).



<a id="a78cd4e97e8ad454271fe4ccdf896e842" name="a78cd4e97e8ad454271fe4ccdf896e842"></a>## [◆ ](#a78cd4e97e8ad454271fe4ccdf896e842)deep\_copy() \[1/2\]

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::PropertyField::deep\_copy  ( )  const

Make a deep copy locally.





<a id="ac440564a6c9b1f9266c72d600da28179" name="ac440564a6c9b1f9266c72d600da28179"></a>## [◆ ](#ac440564a6c9b1f9266c72d600da28179)deep\_copy() \[2/2\]

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::PropertyField::deep\_copy  ( [ansys::dpf::Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*)  const

Make a deep copy on a given client.

Parameters \[in\]clientRemote client 



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

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

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



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

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

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



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

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

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



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

 void ansys::dpf::PropertyField::fillCursor  ( [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *index*,    [PropFieldCursor](classansys_1_1dpf_1_1PropFieldCursor.xhtml) &amp;  *cursor*   )  const

Get data at a given index.

Parameters \[in\]indexIndex of entity for which to get data. \[out\]cursor[PropFieldCursor](classansys_1_1dpf_1_1PropFieldCursor.xhtml) with which to contain data. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a62).



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

 void ansys::dpf::PropertyField::getData  ( std::vector&lt; [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp;  *values\_to\_fill*)  const

Get all data for property entities.

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



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

 void ansys::dpf::PropertyField::getIds  ( std::vector&lt; [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) &gt; &amp;  *ids\_to\_fill*)  const

Get ids of property entities.

Parameters \[out\]ids\_to\_fillEntity ids. 



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

 [Location](structansys_1_1dpf_1_1Location.xhtml) ansys::dpf::PropertyField::location  ( )  const

Returns[Location](structansys_1_1dpf_1_1Location.xhtml) of the property. 



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

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

ReturnsName of [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml). 



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

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

ReturnsNumber of components in the property data. 



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

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

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



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

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

Push back the entity data.

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



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

 void ansys::dpf::PropertyField::push\_back  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *entity\_id*,    int \*  *values*,    int  *size*   ) 

Push back the entity data.

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



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

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

Push back the entity data.

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



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

 void ansys::dpf::PropertyField::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="aafa75bc6e0e191b4914282ad620a5c35" name="aafa75bc6e0e191b4914282ad620a5c35"></a>## [◆ ](#aafa75bc6e0e191b4914282ad620a5c35)resize()

 void ansys::dpf::PropertyField::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="a9d57c8ecf193532958d34de87db60da0" name="a9d57c8ecf193532958d34de87db60da0"></a>## [◆ ](#a9d57c8ecf193532958d34de87db60da0)scoping()

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

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



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

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

Set the data of the property field.

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



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

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

Set the data of the property field.

Parameters \[in\]dataVector of data. 



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

 void ansys::dpf::PropertyField::setDataPointer  ( int \*const  *data*,    int  *size*   ) 

Set the data pointer of the property field.

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



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

 void ansys::dpf::PropertyField::setDataPointer  ( std::vector&lt; int &gt; const &amp;  *data*) 

Set the data pointer of the property field.

Parameters \[in\]dataVector of data. 



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

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

Set the [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml).





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

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

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

Parameters \[in\]nameNew name. 



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

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

Set the scoping of the property field.