## On this page

  

 

 # ansys::dpf::CustomTypeFieldsContainer Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inherits ansys::dpf::CollectionBase.

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

<a id="a43cc23b4378cbda69c2df6b40351e20c" name="a43cc23b4378cbda69c2df6b40351e20c"></a> **CustomTypeFieldsContainer** ([CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) const &amp;) <a id="a7d3eff103026eee8324abdf0874b9bc1" name="a7d3eff103026eee8324abdf0874b9bc1"></a> **CustomTypeFieldsContainer** ([CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) &amp;&amp;) noexcept  [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a6549470b067faacff7505e4304d80da5) (std::vector&lt; std::string &gt; const &amp;[labels](structansys_1_1dpf_1_1labels.xhtml)) <a id="aab7913584ae5fbd3ad88e74d1ce9ca10" name="aab7913584ae5fbd3ad88e74d1ce9ca10"></a>[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) &amp; **operator=** ([CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) const &amp;) <a id="a5ce7b298bcd14b03d2c620934c8d9f55" name="a5ce7b298bcd14b03d2c620934c8d9f55"></a>[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) &amp; **operator=** ([CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) &amp;&amp;) noexcept [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) [operator\[\]](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a78e5486305d5d2330143a82e3ab1cd64) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) index) [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) [at](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a2bb825ef745028ae124723664d1721f0) ([dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) index) const [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) [at](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a0d85df941eb94304aa713f31c203f6cb) ([dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) index) const void [update](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#ad6cd99e2c5c073ff3709c17657e59f0f) ([CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &amp;f, [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) index) void [add](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a898f0092958c0adb4b1fed0256293fa6) ([LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;[labels](structansys_1_1dpf_1_1labels.xhtml), [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;f) [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [getSizeFor](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a0c526ddb5e50c14c564b2c68ece091e4) ([LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;label\_space) const std::vector&lt; [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &gt; [getCustomTypeFields](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a43329515b1faf96f24540fb28876d9c9) ([LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;label\_space) const [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) [getCustomTypeField](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#afbb394c6a1124f023188c0fde3f77d3c) ([LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;label\_space) const <a id="aff4531367a6abed9b9884db0f49c519a" name="aff4531367a6abed9b9884db0f49c519a"></a>std::vector&lt; int &gt; **getCustomTypeFieldsIndices** ([LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;lab\_space) const <a id="a163d49e339c1df1dea9271f591f52ade" name="a163d49e339c1df1dea9271f591f52ade"></a>[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) **createSubCustomTypeFieldsContainer** ([LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;lab\_space) const create a [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) with all the CustomTypeFields corresponding to the label space in input   
 ## <a id="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) [emptyCustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml#a0c1698f9c74ae209656e11454723670d) () <a id="details" name="details"></a>## Detailed Description

Contains a group of custom type fields. The [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) 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_1_1dpf_1_1CustomTypeField.xhtml) [Using collections and labels](group__group__12.xhtml)

## Constructor &amp; Destructor Documentation

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

 ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer  ( std::vector&lt; std::string &gt; const &amp;  *labels*) 

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

Parameters \[in\]labelsLabels for group of CustomTypeFields. 



## Member Function Documentation

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

 void ansys::dpf::CustomTypeFieldsContainer::add  ( [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;  *labels*,    [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;  *f*   ) 

Add [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) with given label space.

Parameters \[in\]labels[Label](structansys_1_1dpf_1_1Label.xhtml) space for [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml). \[in\]f[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) to add. 



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

 [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) ansys::dpf::CustomTypeFieldsContainer::at  ( [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *index*) 

ReturnsCustomTypeFields for given index. Parameters \[in\]indexIndex of [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) to get. 



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

 const [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) ansys::dpf::CustomTypeFieldsContainer::at  ( [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *index*)  const

ReturnsCustomTypeFields for given index. Parameters \[in\]indexIndex of [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) to get. 



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

 static [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) ansys::dpf::CustomTypeFieldsContainer::emptyCustomTypeFieldsContainer  ( )   static 

Create an empty container.

ReturnsEmpty container. 



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

 [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) ansys::dpf::CustomTypeFieldsContainer::getCustomTypeField  ( [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;  *label\_space*)  const

ReturnsFirst [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) for given label space. Parameters \[in\]label\_space[Label](structansys_1_1dpf_1_1Label.xhtml) space for which to get [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml). 



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

 std::vector&lt; [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &gt; ansys::dpf::CustomTypeFieldsContainer::getCustomTypeFields  ( [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;  *label\_space*)  const

ReturnsVector of CustomTypeFields for given label space. Parameters \[in\]label\_space[Label](structansys_1_1dpf_1_1Label.xhtml) space for which to get CustomTypeFields. 



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

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::CustomTypeFieldsContainer::getSizeFor  ( [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;  *label\_space*)  const

ReturnsNumber of CustomTypeFields for given label space. Parameters \[in\]label\_space[Label](structansys_1_1dpf_1_1Label.xhtml) space for which to get number of entities. 



<a id="a78e5486305d5d2330143a82e3ab1cd64" name="a78e5486305d5d2330143a82e3ab1cd64"></a>## [◆ ](#a78e5486305d5d2330143a82e3ab1cd64)operator\[\]()

 [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) ansys::dpf::CustomTypeFieldsContainer::operator\[\]  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *index*) 

Returns[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) for given index. Parameters \[in\]indexIndex of CustomTypeFields within container. 



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

 void ansys::dpf::CustomTypeFieldsContainer::update  ( [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) &amp;  *f*,    [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *index*   ) 

Update a [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) at index.

Parameters \[in\]fNew [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml). \[in\]indexIndex of [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) to update.