    

 ## On this page

  

 

 # Class ansys::dpf::PropertyField

 Last update: 25.03.2026 

<a id="classansys-dpf-propertyfield"></a>

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

Holds Integral (int32) data describing a Property located on given entities (the Property [Field](classansys-dpf-field.md#classansys-dpf-field)'s data is bounded with its scoping). Is the equivalent of the [Field](classansys-dpf-field.md#classansys-dpf-field) but with integral values data (and not double values).

**Inherits from**:

- [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes)

## Members

- [callAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aea34d37e0c080126eff70db34bf46597)
- [cloneToCustomTypeField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a695daa98db9128948db4c67ffc57eedd)
- [cloneToField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ace579cbad593a985d56dfae75f3a50ba)
- [cloneToPropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a940bc0ea91ca4e1725abb112eee4c0e4)
- [createPropertyFieldWithTransformation](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a0ca259df13f04a150585337c7914c37e)
- [data](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ac77c2c8994da1d1511c69849257c748c)
- [dataById](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1aa32b0e1c2611e88a2aef55c94a8c6880)
- [dataByIndex](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a8b09b1109c854475c4af16cba105a667)
- [dataPointer](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a7b2afaba19a4b177460572a231c5275b)
- [dataSize](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1af0ff358222e067e0c03d588a6b11b04c)
- [deep\_copy](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ab1245b64a580a13f74be20bc993eb403)
- [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2)
- [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459)
- [emptyPropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1aac8837afab55e9ebe3087e966ebc9edd)
- [entityData](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a78f843b67d4df51c5bd0c57f98d9cc17)
- [entityDataById](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a433fe762b8bbf44c5cb7bc09e8e4f7a7)
- [fieldDefinition](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a4df2020806c5f8d2ace1faa6b26a1ecb)
- [fillCursor](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a90f3baa944b4dd1a49adbcbec5a3d766)
- [getClient](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a968afd9daa0b0f13b65a2ac61369d73a)
- [getData](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ab4fd6ed2f236efb404d4454944b4474b)
- [getHeaderAsDataTree](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1aa9dc8cbf0e0bb1fd4efb704737ad2065)
- [getIds](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a55c6d4eb97b98ca58672b149e2bf1483)
- [hasBeenMovedLocally](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a1a5634202c15404b6b24e8f50e51cb66)
- [hasInternalObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ae198f89868d85c7db6dc1a934a1d3c15)
- [isOnCommonAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9f9789ff61cc9d400a2a344830706b73)
- [isSameObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aa64d5f8fcd7d85ad6ebf708494dbefd7)
- [location](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a9dbf80f14848a93eb311d97a4b3da8dd)
- [name](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1aaf5a2e4abe9da5e77cc7b954b0ef81ba)
- [numberOfComponents](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a1a2b01c58216827f720b4a76a8f52d9d)
- [numberOfElementaryData](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a3cb32ee79adc23f5c7ab5f6b6d831e26)
- [operator=](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1adec6a0cbb0a46d7831e223fad50aab62)
- [operator=](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a790b5c4569b3f2b6c58c0e9292147d12)
- [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a41f086b401649bbbaa1e1242b0d9ac03)
- [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ac8723c38fad6636b55b31a3d6d8ccc76)
- [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a88b5dfeb3f030e6afbfbf87efbcc3561)
- [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ad787ee870fa5d12ba322bd1d3bbb52cd)
- [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a89260e610bdbe97eaf9a0f6364daf0de)
- [push\_back](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a74bc6460d3924f837b480b725f2d230c)
- [push\_back](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ac709022d579f02b554fdc06fe0a59f7f)
- [push\_back](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a2200849fcd3d0c6ebc171b15d9cb8e54)
- [reserve](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ad7e142a83fd4138694a80f1a36bb778a)
- [resize](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1aafa75bc6e0e191b4914282ad620a5c35)
- [scoping](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a9d57c8ecf193532958d34de87db60da0)
- [setData](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ae40e20aaa78a8bfc6ff8176cb9381152)
- [setData](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a74e8c4842a23651d988f8a264c9eabe6)
- [setDataPointer](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1afb3f6cd0c63ea162c4a7a53ef8066e7f)
- [setDataPointer](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a4e7b773455c0cf6aefdfaa5e25261940)
- [setFieldDefinition](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a4ed774aecf5c68516a17da55da7b0ff7)
- [setHeaderAsDataTree](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a9c5f2a9ad893a89b067fc93c72170d56)
- [setName](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1aefb5d03109bcc57f95ca1257ab92ed7b)
- [setScoping](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a6e63d1d672b5b1d074052e9e9f0ad239)
- [setSupport](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a8124e1eaed971c006045b89b5fb28798)
- [setSupport](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ae715fc13eaca1ce40e0fcd686d3c8555)
- [setSupport](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1a8244b39576d028e8168557c0764d49a6)
- [support](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ac99d91c191df704b90601b43076c216a)
- [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f)
- [~PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield-1ae4d4f5e5f1452e4fba0fcf5897649d17)

## Friends

## Public static functions

<a id="classansys-dpf-propertyfield-1aac8837afab55e9ebe3087e966ebc9edd"></a>

### Function emptyPropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

```cpp
static PropertyField ansys::dpf::PropertyField::emptyPropertyField()

```

**Return type**: PropertyField

<a id="classansys-dpf-propertyfield-1a0ca259df13f04a150585337c7914c37e"></a>

### Function createPropertyFieldWithTransformation

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

```cpp
static PropertyField ansys::dpf::PropertyField::createPropertyFieldWithTransformation(Workflow transformation_wf, int reserved_number_of_entity=0, int reserved_data_size=0, std::string const &input_name_to_connect="input_field", std::string const &output_name_to_eval="transformed_field")

```

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

**Parameters**:

- Workflow **transformation\_wf**: \[in\] Transformation workflow.
- int **reserved\_number\_of\_entity** = 0
- int **reserved\_data\_size** = 0
- std::string const &amp; **input\_name\_to\_connect** = "input\_field" : \[in\] Name of the input of the workflow to connect. Should take a [Field](classansys-dpf-field.md#classansys-dpf-field).
- std::string const &amp; **output\_name\_to\_eval** = "transformed\_field" : \[in\] Name of the output of the workflow to evaluate. Should return a [Field](classansys-dpf-field.md#classansys-dpf-field).

**Return type**: PropertyField

## Public functions

<a id="classansys-dpf-propertyfield-1ae4d4f5e5f1452e4fba0fcf5897649d17"></a>

### Function ~PropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
virtual ansys::dpf::PropertyField::~PropertyField()

```

**Return type**:

<a id="classansys-dpf-propertyfield-1a41f086b401649bbbaa1e1242b0d9ac03"></a>

### Function PropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::PropertyField::PropertyField(Client const *const client, dp_int number_of_entities=0, dp_int data_size=0, const Location &loc=Location())

```

Create an empty property field with a client.

**Parameters**:

- [Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client**: \[in\] [Client](classansys-dpf-client.md#classansys-dpf-client) to create the property field on.
- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **number\_of\_entities** = 0 : \[in\] Number of entities.
- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **data\_size** = 0 : \[in\] Reserved size of data.
- const [Location](structansys-dpf-location.md#structansys-dpf-location) &amp; **loc** = [Location](structansys-dpf-location.md#structansys-dpf-location)() : \[in\] [Location](structansys-dpf-location.md#structansys-dpf-location) of entities.

**Return type**:

<a id="classansys-dpf-propertyfield-1ac8723c38fad6636b55b31a3d6d8ccc76"></a>

### Function PropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::PropertyField::PropertyField(dp_int number_of_entities=0, dp_int data_size=0)

```

Create a property with number of entities and data size.

**Parameters**:

- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **number\_of\_entities** = 0 : \[in\] Number of entities.
- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **data\_size** = 0 : \[in\] Reserved size of data.

**Return type**:

<a id="classansys-dpf-propertyfield-1a88b5dfeb3f030e6afbfbf87efbcc3561"></a>

### Function PropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::PropertyField::PropertyField(int id, Client const *const client)

```

Retrieve an existing instance of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) on a server.

**Parameters**:

- int **id**: \[in\] Id of the [Field](classansys-dpf-field.md#classansys-dpf-field) object on the server's database.
- [Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client**: \[in\] [Client](classansys-dpf-client.md#classansys-dpf-client) instance designating the IP, port and protocol to use.

**Return type**:

<a id="classansys-dpf-propertyfield-1ad787ee870fa5d12ba322bd1d3bbb52cd"></a>

### Function PropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::PropertyField::PropertyField(PropertyField const &)

```

**Parameters**:

- PropertyField const &amp;

**Return type**:

<a id="classansys-dpf-propertyfield-1a89260e610bdbe97eaf9a0f6364daf0de"></a>

### Function PropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::PropertyField::PropertyField(PropertyField &&) noexcept

```

**Parameters**:

- PropertyField &amp;&amp;

**Return type**:

<a id="classansys-dpf-propertyfield-1adec6a0cbb0a46d7831e223fad50aab62"></a>

### Function operator=

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
PropertyField & ansys::dpf::PropertyField::operator=(PropertyField const &)

```

**Parameters**:

- PropertyField const &amp;

**Return type**: PropertyField &amp;

<a id="classansys-dpf-propertyfield-1a790b5c4569b3f2b6c58c0e9292147d12"></a>

### Function operator=

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
PropertyField & ansys::dpf::PropertyField::operator=(PropertyField &&) noexcept

```

**Parameters**:

- PropertyField &amp;&amp;

**Return type**: PropertyField &amp;

<a id="classansys-dpf-propertyfield-1a4df2020806c5f8d2ace1faa6b26a1ecb"></a>

### Function fieldDefinition

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
FieldDefinition ansys::dpf::PropertyField::fieldDefinition() const

```

**Returns**:

[FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) of the field.

**Return type**: [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition)

<a id="classansys-dpf-propertyfield-1a4ed774aecf5c68516a17da55da7b0ff7"></a>

### Function setFieldDefinition

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setFieldDefinition(FieldDefinition const &f)

```

Set the [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Parameters**:

- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) const &amp; **f**

**Return type**: void

<a id="classansys-dpf-propertyfield-1ac99d91c191df704b90601b43076c216a"></a>

### Function support

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Support ansys::dpf::PropertyField::support() const

```

**Returns**:

[Support](classansys-dpf-support.md#classansys-dpf-support) of the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Return type**: Support

<a id="classansys-dpf-propertyfield-1a8124e1eaed971c006045b89b5fb28798"></a>

### Function setSupport

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setSupport(ansys::dpf::Support const &s)

```

Set the support of the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Parameters**:

- [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) const &amp; **s**: \[in\] [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) to support.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ae715fc13eaca1ce40e0fcd686d3c8555"></a>

### Function setSupport

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setSupport(ansys::dpf::TimeFreqSupport const &s)

```

Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field).

**Parameters**:

- [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) const &amp; **s**: \[in\] [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) to support.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a8244b39576d028e8168557c0764d49a6"></a>

### Function setSupport

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setSupport(ansys::dpf::MeshedRegion const &s)

```

Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field).

**Parameters**:

- [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) const &amp; **s**: \[in\] [MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) to support.

**Return type**: void

<a id="classansys-dpf-propertyfield-1aaf5a2e4abe9da5e77cc7b954b0ef81ba"></a>

### Function name

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

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

```

**Returns**:

Name of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Return type**: std::string

<a id="classansys-dpf-propertyfield-1aefb5d03109bcc57f95ca1257ab92ed7b"></a>

### Function setName

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setName(const std::string &name)

```

Set name of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Parameters**:

- const std::string &amp; **name**: \[in\] New name.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a9dbf80f14848a93eb311d97a4b3da8dd"></a>

### Function location

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Location ansys::dpf::PropertyField::location() const

```

**Returns**:

[Location](structansys-dpf-location.md#structansys-dpf-location) of the property.

**Return type**: [Location](structansys-dpf-location.md#structansys-dpf-location)

<a id="classansys-dpf-propertyfield-1a9d57c8ecf193532958d34de87db60da0"></a>

### Function scoping

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Scoping ansys::dpf::PropertyField::scoping() const

```

**Returns**:

[Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping) of the property.

**Return type**: [Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping)

<a id="classansys-dpf-propertyfield-1af0ff358222e067e0c03d588a6b11b04c"></a>

### Function dataSize

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
dp_int ansys::dpf::PropertyField::dataSize() const

```

**Returns**:

Size of the data container.

**Return type**: [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0)

<a id="classansys-dpf-propertyfield-1a1a2b01c58216827f720b4a76a8f52d9d"></a>

### Function numberOfComponents

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
dp_int ansys::dpf::PropertyField::numberOfComponents() const

```

**Returns**:

Number of components in the property data.

**Return type**: [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0)

<a id="classansys-dpf-propertyfield-1a3cb32ee79adc23f5c7ab5f6b6d831e26"></a>

### Function numberOfElementaryData

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
dp_int ansys::dpf::PropertyField::numberOfElementaryData() const

```

**Returns**:

Number of elementary data (size = number of components) contained in the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Return type**: [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0)

<a id="classansys-dpf-propertyfield-1a74bc6460d3924f837b480b725f2d230c"></a>

### Function push\_back

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::push_back(dp_id entity_id, std::vector< int > const &values)

```

Push back the entity data.

**Parameters**:

- [dp\_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) **entity\_id**: \[in\] Id of entity for which to push data.
- std::vector&lt; int &gt; const &amp; **values**: \[in\] Vector of data for entity.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ac709022d579f02b554fdc06fe0a59f7f"></a>

### Function push\_back

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::push_back(dp_id entity_id, const int *values, int size)

```

Push back the entity data.

**Parameters**:

- [dp\_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) **entity\_id**: \[in\] Index of entity for which to push data.
- const int \* **values**: \[in\] Ptr on data for entity.
- int **size**: \[in\] Number of entities.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a2200849fcd3d0c6ebc171b15d9cb8e54"></a>

### Function push\_back

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::push_back(dp_id entity_id, int *values, int size)

```

Push back the entity data.

**Parameters**:

- [dp\_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) **entity\_id**: \[in\] Index of entity for which to push data.
- int \* **values**: \[in\] Ptr on data for entity.
- int **size**: \[in\] Number of entities.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ae40e20aaa78a8bfc6ff8176cb9381152"></a>

### Function setData

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setData(std::vector< int > const &data)

```

Set the data of the property field.

**Parameters**:

- std::vector&lt; int &gt; const &amp; **data**: \[in\] Vector of data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a74e8c4842a23651d988f8a264c9eabe6"></a>

### Function setData

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

Set the data of the property field.

**Parameters**:

- int const \*const **data**: \[in\] List of data.
- int **size**: \[in\] Size of list.

**Return type**: void

<a id="classansys-dpf-propertyfield-1afb3f6cd0c63ea162c4a7a53ef8066e7f"></a>

### Function setDataPointer

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setDataPointer(std::vector< int > const &data)

```

Set the data pointer of the property field.

**Parameters**:

- std::vector&lt; int &gt; const &amp; **data**: \[in\] Vector of data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a4e7b773455c0cf6aefdfaa5e25261940"></a>

### Function setDataPointer

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

Set the data pointer of the property field.

**Parameters**:

- int \*const **data**: \[in\] List of data.
- int **size**: \[in\] Size of list.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a6e63d1d672b5b1d074052e9e9f0ad239"></a>

### Function setScoping

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setScoping(ansys::dpf::Scoping const &s)

```

Set the scoping of the property field.

**Parameters**:

- [ansys::dpf::Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping) const &amp; **s**

**Return type**: void

<a id="classansys-dpf-propertyfield-1a8b09b1109c854475c4af16cba105a667"></a>

### Function dataByIndex

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
const dp_int * ansys::dpf::PropertyField::dataByIndex(dp_index entity_index, int &size) const

```

**Returns**:

Pointer to entity data given by index.

**Parameters**:

- [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **entity\_index**: \[in\] Index of entity for which to get data.
- int &amp; **size**: \[out\] Size of return data.

**Return type**: const [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) \*

<a id="classansys-dpf-propertyfield-1aa32b0e1c2611e88a2aef55c94a8c6880"></a>

### Function dataById

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
const dp_int * ansys::dpf::PropertyField::dataById(dp_id entity_id, int &size) const

```

**Returns**:

Pointer to entity data given by id.

**Parameters**:

- [dp\_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) **entity\_id**: \[in\] Id of entity for which to get data.
- int &amp; **size**: \[out\] Size of return data.

**Return type**: const [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) \*

<a id="classansys-dpf-propertyfield-1a90f3baa944b4dd1a49adbcbec5a3d766"></a>

### Function fillCursor

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void ansys::dpf::PropertyField::fillCursor(dp_index index, PropFieldCursor &cursor) const

```

Get data at a given index.

**Parameters**:

- [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: \[in\] Index of entity for which to get data.
- [PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) &amp; **cursor**: \[out\] [PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) with which to contain data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a55c6d4eb97b98ca58672b149e2bf1483"></a>

### Function getIds

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void ansys::dpf::PropertyField::getIds(std::vector< dp_id > &ids_to_fill) const

```

Get ids of property entities.

**Parameters**:

- std::vector&lt; [dp\_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) &gt; &amp; **ids\_to\_fill**: \[out\] Entity ids.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ab4fd6ed2f236efb404d4454944b4474b"></a>

### Function getData

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void ansys::dpf::PropertyField::getData(std::vector< dp_int > &values_to_fill) const

```

Get all data for property entities.

**Parameters**:

- std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp; **values\_to\_fill**: \[out\] Property entity data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ac77c2c8994da1d1511c69849257c748c"></a>

### Function data

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
DpfVector< int > ansys::dpf::PropertyField::data() const

```

**Returns**:

[DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) of data array.

**Return type**: DpfVector&lt; int &gt;

<a id="classansys-dpf-propertyfield-1a7b2afaba19a4b177460572a231c5275b"></a>

### Function dataPointer

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
DpfVector< int > ansys::dpf::PropertyField::dataPointer() const

```

**Returns**:

[DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) of data array.

**Return type**: DpfVector&lt; int &gt;

<a id="classansys-dpf-propertyfield-1a78f843b67d4df51c5bd0c57f98d9cc17"></a>

### Function entityData

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void ansys::dpf::PropertyField::entityData(dp_index entity_index, DpfVector< int > &data) const

```

**Returns**:

[DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) of data array of an entity, by index.

**Parameters**:

- [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **entity\_index**: \[in\] Index of entity for which to get data.
- DpfVector&lt; int &gt; &amp; **data**: \[out\] Pointer to the data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1a433fe762b8bbf44c5cb7bc09e8e4f7a7"></a>

### Function entityDataById

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void ansys::dpf::PropertyField::entityDataById(dp_id entity_id, DpfVector< int > &data) const

```

**Returns**:

[DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) of data array of an entity, by id.

**Parameters**:

- [dp\_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) **entity\_id**: \[in\] Id of entity for which to get data.
- DpfVector&lt; int &gt; &amp; **data**: \[out\] Pointer to the data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ad7e142a83fd4138694a80f1a36bb778a"></a>

### Function reserve

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::reserve(dp_int number_of_entities, dp_int overall_size=0)

```

Reserve the [Field](classansys-dpf-field.md#classansys-dpf-field). Only implemented for in process udage. To reserve the size for gRPC usage, use the constructor.

**Parameters**:

- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **number\_of\_entities**: \[in\] Number of entities.
- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **overall\_size** = 0 : \[in\] Total size of entity data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1aafa75bc6e0e191b4914282ad620a5c35"></a>

### Function resize

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::resize(dp_int number_of_entities, dp_int overall_size)

```

Reserve the [Field](classansys-dpf-field.md#classansys-dpf-field).

**Parameters**:

- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **number\_of\_entities**: \[in\] Number of entities.
- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **overall\_size**: \[in\] Total size of entity data.

**Return type**: void

<a id="classansys-dpf-propertyfield-1ab1245b64a580a13f74be20bc993eb403"></a>

### Function deep\_copy

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
PropertyField ansys::dpf::PropertyField::deep_copy(ansys::dpf::Client const *const client=nullptr) const

```

Make a deep copy on a given client.

**Parameters**:

- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client** = nullptr : \[in\] Remote client

**Return type**: PropertyField

<a id="classansys-dpf-propertyfield-1a695daa98db9128948db4c67ffc57eedd"></a>

### Function cloneToCustomTypeField

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
CustomTypeField ansys::dpf::PropertyField::cloneToCustomTypeField(ansys::dpf::Client const *const client=nullptr, bool const copy_ids=true, bool const copy_data_ptr=true, bool const copy_support=true) const

```

Creates a new custom type field object from current property field without its data.

**Parameters**:

- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client** = nullptr : \[in\] Remote client
- bool const **copy\_ids** = true : \[in\] Boolean to decide if scoping ids are to be copied
- bool const **copy\_data\_ptr** = true : \[in\] Boolean to decide if data pointer is to be copied
- bool const **copy\_support** = true : \[in\] Boolean to decide if the support reference is to be copied

**Return type**: [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield)

<a id="classansys-dpf-propertyfield-1ace579cbad593a985d56dfae75f3a50ba"></a>

### Function cloneToField

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
Field ansys::dpf::PropertyField::cloneToField(ansys::dpf::Client const *const client=nullptr, bool const copy_ids=true, bool const copy_data_ptr=true, bool const copy_support=true) const

```

Creates a new field object from current property field without its data.

**Parameters**:

- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client** = nullptr : \[in\] Remote client
- bool const **copy\_ids** = true : \[in\] Boolean to decide if scoping ids are to be copied
- bool const **copy\_data\_ptr** = true : \[in\] Boolean to decide if data pointer is to be copied
- bool const **copy\_support** = true : \[in\] Boolean to decide if the support reference is to be copied

**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field)

<a id="classansys-dpf-propertyfield-1a940bc0ea91ca4e1725abb112eee4c0e4"></a>

### Function cloneToPropertyField

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
PropertyField ansys::dpf::PropertyField::cloneToPropertyField(ansys::dpf::Client const *const client=nullptr, bool const copy_ids=true, bool const copy_data_ptr=true, bool const copy_support=true) const

```

Creates a new property field object from current property field without its data.

**Parameters**:

- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client** = nullptr : \[in\] Remote client
- bool const **copy\_ids** = true : \[in\] Boolean to decide if scoping ids are to be copied
- bool const **copy\_data\_ptr** = true : \[in\] Boolean to decide if data pointer is to be copied
- bool const **copy\_support** = true : \[in\] Boolean to decide if the support reference is to be copied

**Return type**: PropertyField

<a id="classansys-dpf-propertyfield-1aa9dc8cbf0e0bb1fd4efb704737ad2065"></a>

### Function getHeaderAsDataTree

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
DataTree ansys::dpf::PropertyField::getHeaderAsDataTree() const

```

Get the header of the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) as a [DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) object.

**Return type**: DataTree

<a id="classansys-dpf-propertyfield-1a9c5f2a9ad893a89b067fc93c72170d56"></a>

### Function setHeaderAsDataTree

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::PropertyField::setHeaderAsDataTree(const DataTree &datatree)

```

Set the header of the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) using a [DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) object.

**Parameters**:

- const DataTree &amp; **datatree**

**Return type**: void