    

 ## On this page

  

 

 # Class ansys::dpf::CustomTypeFieldsContainer

 Last update: 25.03.2026 

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

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

Contains a group of custom type fields. The [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) is designed as a set of custom type fields ordered through labels and ids. Labels identify how the fields are filtered.

**See also**: [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield)

**Inherits from**:

- ansys::dpf::CollectionBase

## Members

- [add](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a85eb626dd45ca5e3a1a8347ca73bdf59)
- [addLabel](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a623a0b168512a4621fb7af8084f9872b)
- [addLabel](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ac6ce7bc876d6a94a97996d5febba5116)
- [addLabels](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ae97480559c14c59e830559582c1f2cd5)
- [at](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a2bb825ef745028ae124723664d1721f0)
- [at](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a0d85df941eb94304aa713f31c203f6cb)
- [callAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aea34d37e0c080126eff70db34bf46597)
- [createSubCustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a163d49e339c1df1dea9271f591f52ade)
- [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a43fb73f6e8e6bdbc109777f5a42e39f6)
- [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a43cc23b4378cbda69c2df6b40351e20c)
- [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a7d3eff103026eee8324abdf0874b9bc1)
- [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a6549470b067faacff7505e4304d80da5)
- [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2)
- [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459)
- [emptyCustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a0c1698f9c74ae209656e11454723670d)
- [getClient](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a968afd9daa0b0f13b65a2ac61369d73a)
- [getCustomTypeField](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1afbb394c6a1124f023188c0fde3f77d3c)
- [getCustomTypeFields](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a43329515b1faf96f24540fb28876d9c9)
- [getCustomTypeFieldsIndices](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1aff4531367a6abed9b9884db0f49c519a)
- [getLabelSpace](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a66d62492d07889a95a5d10f9d827cd11)
- [getMatchingCustomTypeField](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a9a2fc0eca540a4ee8fc7682302093110)
- [getMatchingCustomTypeFieldIndices](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a15fe40c6913c4df3853af4bee4d6375b)
- [getSizeFor](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a0c526ddb5e50c14c564b2c68ece091e4)
- [hasBeenMovedLocally](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a1a5634202c15404b6b24e8f50e51cb66)
- [hasInternalObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ae198f89868d85c7db6dc1a934a1d3c15)
- [hasLabel](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a82ac9433fd3963b37b07989ef05de331)
- [id](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a5e8d2dd8b9b6cf273985ce3ead392830)
- [isOnCommonAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9f9789ff61cc9d400a2a344830706b73)
- [isSameObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aa64d5f8fcd7d85ad6ebf708494dbefd7)
- [labels](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a2c1bb3718e1a96d3f40b64794eb25f91)
- [labelScoping](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ac61aef82ffe249c95dd10cf40de7c910)
- [name](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a691450ab7c89db80f39d6bb2d10eace4)
- [operator=](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1aab7913584ae5fbd3ad88e74d1ce9ca10)
- [operator=](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a5ce7b298bcd14b03d2c620934c8d9f55)
- [operator\[\]](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a78e5486305d5d2330143a82e3ab1cd64)
- [reserve](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a98ab98c9a6b91b886fd600ed7d9e633b)
- [resize](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ac88664d3e1d22abb74a95c8223b1e771)
- [setId](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a93ebbfe9396dd1c4f447e799db6cbf3b)
- [setName](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a44394f964c6130dcbaed446cec3b0197)
- [setSupport](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ae6f7683496d153ed944856d42b97dc82)
- [setSupport](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ada2a037068417557fd7d410577a7fbb9)
- [size](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a69e6878d2d691807f8a45ddfbda42f9e)
- [support](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a9830a03b992af391bf03acad90eac372)
- [update](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1ad6cd99e2c5c073ff3709c17657e59f0f)
- [~CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a99e04439d35f26b89f4d66813d74035b)
- [~CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer-1a931ed37182b866a94576dda67fde3265)
- [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f)

## Friends

## Public functions

<a id="classansys-dpf-customtypefieldscontainer-1a43fb73f6e8e6bdbc109777f5a42e39f6"></a>

### Function CustomTypeFieldsContainer

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

```cpp
ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer()

```

**Return type**:

<a id="classansys-dpf-customtypefieldscontainer-1a931ed37182b866a94576dda67fde3265"></a>

### Function ~CustomTypeFieldsContainer

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

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

```

**Return type**:

<a id="classansys-dpf-customtypefieldscontainer-1a43cc23b4378cbda69c2df6b40351e20c"></a>

### Function CustomTypeFieldsContainer

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

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

```

**Parameters**:

- CustomTypeFieldsContainer const &amp;

**Return type**:

<a id="classansys-dpf-customtypefieldscontainer-1a7d3eff103026eee8324abdf0874b9bc1"></a>

### Function CustomTypeFieldsContainer

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

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

```

**Parameters**:

- CustomTypeFieldsContainer &amp;&amp;

**Return type**:

<a id="classansys-dpf-customtypefieldscontainer-1a6549470b067faacff7505e4304d80da5"></a>

### Function CustomTypeFieldsContainer

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

```cpp
ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer(std::vector< std::string > const &labels)

```

Create container for a group of CustomTypeFields with the given labels.

**Parameters**:

- std::vector&lt; std::string &gt; const &amp; **labels**: \[in\] Labels for group of CustomTypeFields.

**Return type**:

<a id="classansys-dpf-customtypefieldscontainer-1aab7913584ae5fbd3ad88e74d1ce9ca10"></a>

### Function operator=

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

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

```

**Parameters**:

- CustomTypeFieldsContainer const &amp;

**Return type**: CustomTypeFieldsContainer &amp;

<a id="classansys-dpf-customtypefieldscontainer-1a5ce7b298bcd14b03d2c620934c8d9f55"></a>

### Function operator=

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

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

```

**Parameters**:

- CustomTypeFieldsContainer &amp;&amp;

**Return type**: CustomTypeFieldsContainer &amp;

<a id="classansys-dpf-customtypefieldscontainer-1a78e5486305d5d2330143a82e3ab1cd64"></a>

### Function operator\[\]

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

```cpp
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::operator[](dp_int index)

```

**Returns**:

[CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) for given index.

**Parameters**:

- [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **index**: \[in\] Index of CustomTypeFields within container.

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

<a id="classansys-dpf-customtypefieldscontainer-1a2bb825ef745028ae124723664d1721f0"></a>

### Function at

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

```cpp
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::at(dp_index index)

```

**Returns**:

CustomTypeFields for given index.

**Parameters**:

- [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: \[in\] Index of [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) to get.

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

<a id="classansys-dpf-customtypefieldscontainer-1a0d85df941eb94304aa713f31c203f6cb"></a>

### Function at

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

```cpp
const CustomTypeField ansys::dpf::CustomTypeFieldsContainer::at(dp_index index) const

```

**Returns**:

CustomTypeFields for given index.

**Parameters**:

- [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: \[in\] Index of [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) to get.

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

<a id="classansys-dpf-customtypefieldscontainer-1ad6cd99e2c5c073ff3709c17657e59f0f"></a>

### Function update

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

```cpp
void ansys::dpf::CustomTypeFieldsContainer::update(CustomTypeField &f, dp_index index)

```

Update a [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) at index.

**Parameters**:

- [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) &amp; **f**: \[in\] New [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield).
- [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: \[in\] Index of [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) to update.

**Return type**: void

<a id="classansys-dpf-customtypefieldscontainer-1a85eb626dd45ca5e3a1a8347ca73bdf59"></a>

### Function add

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

```cpp
void ansys::dpf::CustomTypeFieldsContainer::add(LabelSpace const &labels, CustomTypeField const &f, bool can_replace=true)

```

Add [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) with given label space.

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **labels**: \[in\] [Label](structansys-dpf-label.md#structansys-dpf-label) space for [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield).
- [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) const &amp; **f**: \[in\] [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) to add.
- bool **can\_replace** = true : \[in\] if can\_replace is false, then, the entity is pushed back without checking if the label space already exists.

**Return type**: void

<a id="classansys-dpf-customtypefieldscontainer-1a0c526ddb5e50c14c564b2c68ece091e4"></a>

### Function getSizeFor

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

```cpp
dp_int ansys::dpf::CustomTypeFieldsContainer::getSizeFor(LabelSpace const &label_space) const

```

**Returns**:

Number of CustomTypeFields for given label space.

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **label\_space**: \[in\] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get number of entities.

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

<a id="classansys-dpf-customtypefieldscontainer-1a43329515b1faf96f24540fb28876d9c9"></a>

### Function getCustomTypeFields

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

```cpp
std::vector< CustomTypeField > ansys::dpf::CustomTypeFieldsContainer::getCustomTypeFields(LabelSpace const &label_space) const

```

**Returns**:

Vector of CustomTypeFields for given label space.

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **label\_space**: \[in\] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get CustomTypeFields.

**Return type**: std::vector&lt; [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) &gt;

<a id="classansys-dpf-customtypefieldscontainer-1afbb394c6a1124f023188c0fde3f77d3c"></a>

### Function getCustomTypeField

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

```cpp
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::getCustomTypeField(LabelSpace const &label_space) const

```

**Returns**:

First [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) for given label space.

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **label\_space**: \[in\] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield).

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

<a id="classansys-dpf-customtypefieldscontainer-1aff4531367a6abed9b9884db0f49c519a"></a>

### Function getCustomTypeFieldsIndices

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

```cpp
std::vector< int > ansys::dpf::CustomTypeFieldsContainer::getCustomTypeFieldsIndices(LabelSpace const &lab_space) const

```

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **lab\_space**

**Return type**: std::vector&lt; int &gt;

<a id="classansys-dpf-customtypefieldscontainer-1a9a2fc0eca540a4ee8fc7682302093110"></a>

### Function getMatchingCustomTypeField

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

```cpp
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::getMatchingCustomTypeField(LabelSpace const &label_space) const

```

**Returns**:

First matching [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) for given label space.

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **label\_space**: \[in\] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get [Any](classansys-dpf-any.md#classansys-dpf-any).

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

<a id="classansys-dpf-customtypefieldscontainer-1a15fe40c6913c4df3853af4bee4d6375b"></a>

### Function getMatchingCustomTypeFieldIndices

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

```cpp
DpfVector< dp_index > ansys::dpf::CustomTypeFieldsContainer::getMatchingCustomTypeFieldIndices(LabelSpace const &label_space) const

```

**Returns**:

Vector of matching [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) to the given label space.

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **label\_space**: \[in\] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get entries.

**Return type**: [DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)&lt; [dp\_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) &gt;

<a id="classansys-dpf-customtypefieldscontainer-1a163d49e339c1df1dea9271f591f52ade"></a>

### Function createSubCustomTypeFieldsContainer

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

```cpp
CustomTypeFieldsContainer ansys::dpf::CustomTypeFieldsContainer::createSubCustomTypeFieldsContainer(LabelSpace const &lab_space) const

```

create a [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) with all the CustomTypeFields corresponding to the label space in input

**Parameters**:

- [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const &amp; **lab\_space**

**Return type**: CustomTypeFieldsContainer

## Public static functions

<a id="classansys-dpf-customtypefieldscontainer-1a0c1698f9c74ae209656e11454723670d"></a>

### Function emptyCustomTypeFieldsContainer

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

```cpp
static CustomTypeFieldsContainer ansys::dpf::CustomTypeFieldsContainer::emptyCustomTypeFieldsContainer()

```

Create an empty container. **Returns**:

Empty container.

**Return type**: CustomTypeFieldsContainer