Class ansys::dpf::CustomTypeFieldsContainer
Last update: 25.03.2026
Contains a group of custom type fields. The 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
Inherits from:
- ansys::dpf::CollectionBase
Members
- add
- addLabel
- addLabel
- addLabels
- at
- at
- callAPI
- createSubCustomTypeFieldsContainer
- CustomTypeFieldsContainer
- CustomTypeFieldsContainer
- CustomTypeFieldsContainer
- CustomTypeFieldsContainer
- describe
- empty
- emptyCustomTypeFieldsContainer
- getClient
- getCustomTypeField
- getCustomTypeFields
- getCustomTypeFieldsIndices
- getLabelSpace
- getMatchingCustomTypeField
- getMatchingCustomTypeFieldIndices
- getSizeFor
- hasBeenMovedLocally
- hasInternalObject
- hasLabel
- id
- isOnCommonAPI
- isSameObject
- labels
- labelScoping
- name
- operator=
- operator=
- operator[]
- reserve
- resize
- setId
- setName
- setSupport
- setSupport
- size
- support
- update
- ~CollectionBase
- ~CustomTypeFieldsContainer
- ~DpfTypes
Friends
Public functions
Function CustomTypeFieldsContainer
ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer()
Return type:
Function ~CustomTypeFieldsContainer
virtual ansys::dpf::CustomTypeFieldsContainer::~CustomTypeFieldsContainer()
Return type:
Function CustomTypeFieldsContainer
ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer(CustomTypeFieldsContainer const &)
Parameters:
- CustomTypeFieldsContainer const &
Return type:
Function CustomTypeFieldsContainer
ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer(CustomTypeFieldsContainer &&) noexcept
Parameters:
- CustomTypeFieldsContainer &&
Return type:
Function CustomTypeFieldsContainer
ansys::dpf::CustomTypeFieldsContainer::CustomTypeFieldsContainer(std::vector< std::string > const &labels)
Create container for a group of CustomTypeFields with the given labels.
Parameters:
- std::vector< std::string > const & labels: [in] Labels for group of CustomTypeFields.
Return type:
Function operator=
CustomTypeFieldsContainer & ansys::dpf::CustomTypeFieldsContainer::operator=(CustomTypeFieldsContainer const &)
Parameters:
- CustomTypeFieldsContainer const &
Return type: CustomTypeFieldsContainer &
Function operator=
CustomTypeFieldsContainer & ansys::dpf::CustomTypeFieldsContainer::operator=(CustomTypeFieldsContainer &&) noexcept
Parameters:
- CustomTypeFieldsContainer &&
Return type: CustomTypeFieldsContainer &
Function operator[]
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::operator[](dp_int index)
Returns:
CustomTypeField for given index.
Parameters:
- dp_int index: [in] Index of CustomTypeFields within container.
Return type: CustomTypeField
Function at
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::at(dp_index index)
Returns:
CustomTypeFields for given index.
Parameters:
- dp_index index: [in] Index of CustomTypeField to get.
Return type: CustomTypeField
Function at
const CustomTypeField ansys::dpf::CustomTypeFieldsContainer::at(dp_index index) const
Returns:
CustomTypeFields for given index.
Parameters:
- dp_index index: [in] Index of CustomTypeField to get.
Return type: const CustomTypeField
Function update
void ansys::dpf::CustomTypeFieldsContainer::update(CustomTypeField &f, dp_index index)
Update a CustomTypeField at index.
Parameters:
- CustomTypeField & f: [in] New CustomTypeField.
- dp_index index: [in] Index of CustomTypeField to update.
Return type: void
Function add
void ansys::dpf::CustomTypeFieldsContainer::add(LabelSpace const &labels, CustomTypeField const &f, bool can_replace=true)
Add CustomTypeField with given label space.
Parameters:
- LabelSpace const & labels: [in] Label space for CustomTypeField.
- CustomTypeField const & f: [in] 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
Function getSizeFor
dp_int ansys::dpf::CustomTypeFieldsContainer::getSizeFor(LabelSpace const &label_space) const
Returns:
Number of CustomTypeFields for given label space.
Parameters:
- LabelSpace const & label_space: [in] Label space for which to get number of entities.
Return type: dp_int
Function getCustomTypeFields
std::vector< CustomTypeField > ansys::dpf::CustomTypeFieldsContainer::getCustomTypeFields(LabelSpace const &label_space) const
Returns:
Vector of CustomTypeFields for given label space.
Parameters:
- LabelSpace const & label_space: [in] Label space for which to get CustomTypeFields.
Return type: std::vector< CustomTypeField >
Function getCustomTypeField
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::getCustomTypeField(LabelSpace const &label_space) const
Returns:
First CustomTypeField for given label space.
Parameters:
- LabelSpace const & label_space: [in] Label space for which to get CustomTypeField.
Return type: CustomTypeField
Function getCustomTypeFieldsIndices
std::vector< int > ansys::dpf::CustomTypeFieldsContainer::getCustomTypeFieldsIndices(LabelSpace const &lab_space) const
Parameters:
- LabelSpace const & lab_space
Return type: std::vector< int >
Function getMatchingCustomTypeField
CustomTypeField ansys::dpf::CustomTypeFieldsContainer::getMatchingCustomTypeField(LabelSpace const &label_space) const
Returns:
First matching CustomTypeField for given label space.
Parameters:
- LabelSpace const & label_space: [in] Label space for which to get Any.
Return type: CustomTypeField
Function getMatchingCustomTypeFieldIndices
DpfVector< dp_index > ansys::dpf::CustomTypeFieldsContainer::getMatchingCustomTypeFieldIndices(LabelSpace const &label_space) const
Returns:
Vector of matching CustomTypeField to the given label space.
Parameters:
- LabelSpace const & label_space: [in] Label space for which to get entries.
Return type: DpfVector< dp_index >
Function createSubCustomTypeFieldsContainer
CustomTypeFieldsContainer ansys::dpf::CustomTypeFieldsContainer::createSubCustomTypeFieldsContainer(LabelSpace const &lab_space) const
create a CustomTypeFieldsContainer with all the CustomTypeFields corresponding to the label space in input
Parameters:
- LabelSpace const & lab_space
Return type: CustomTypeFieldsContainer
Public static functions
Function emptyCustomTypeFieldsContainer
static CustomTypeFieldsContainer ansys::dpf::CustomTypeFieldsContainer::emptyCustomTypeFieldsContainer()
Create an empty container. Returns:
Empty container.
Return type: CustomTypeFieldsContainer