Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IItemFamilyModifier Class Referenceabstract

Interface for modifying a family. More...

#include <arcane/core/IItemFamilyModifier.h>

Inheritance diagram for Arcane::IItemFamilyModifier:
Collaboration diagram for Arcane::IItemFamilyModifier:

Public Member Functions

virtual ~IItemFamilyModifier ()
ItemInternalallocOne (Int64 uid, ItemTypeInfo *type, mesh::MeshInfos &mesh_info)
ItemInternalfindOrAllocOne (Int64 uid, ItemTypeInfo *type, mesh::MeshInfos &mesh_info, bool &is_alloc)
virtual Item allocOne (Int64 uid, ItemTypeId type_id, mesh::MeshInfos &mesh_info)=0
 Allocates an element in the family and updates the corresponding mesh_info.
virtual Item findOrAllocOne (Int64 uid, ItemTypeId type_id, mesh::MeshInfos &mesh_info, bool &is_alloc)=0
virtual IItemFamilyfamily ()=0

Detailed Description

Interface for modifying a family.

This class allows for the generic modification of items within a family. It is used in the family modification workflow based on the dependency graph (IItemFamilyNetwork). It is only implemented in mesh item families (i.e., everything except ParticleFamily and DoFFamily, where it is not necessary)

Definition at line 46 of file IItemFamilyModifier.h.

Constructor & Destructor Documentation

◆ ~IItemFamilyModifier()

virtual Arcane::IItemFamilyModifier::~IItemFamilyModifier ( )
inlinevirtual

Class destructor

Definition at line 51 of file IItemFamilyModifier.h.

Member Function Documentation

◆ allocOne() [1/2]

virtual Item Arcane::IItemFamilyModifier::allocOne ( Int64 uid,
ItemTypeId type_id,
mesh::MeshInfos & mesh_info )
pure virtual

Allocates an element in the family and updates the corresponding mesh_info.

Implemented in Arcane::mesh::CellFamily, Arcane::mesh::DoFFamily, Arcane::mesh::EdgeFamily, Arcane::mesh::FaceFamily, and Arcane::mesh::NodeFamily.

◆ allocOne() [2/2]

ItemInternal * Arcane::IItemFamilyModifier::allocOne ( Int64 uid,
ItemTypeInfo * type,
mesh::MeshInfos & mesh_info )

Definition at line 224 of file InterfaceImpl.cc.

◆ findOrAllocOne() [1/2]

virtual Item Arcane::IItemFamilyModifier::findOrAllocOne ( Int64 uid,
ItemTypeId type_id,
mesh::MeshInfos & mesh_info,
bool & is_alloc )
pure virtual

◆ findOrAllocOne() [2/2]

ItemInternal * Arcane::IItemFamilyModifier::findOrAllocOne ( Int64 uid,
ItemTypeInfo * type,
mesh::MeshInfos & mesh_info,
bool & is_alloc )

Definition at line 233 of file InterfaceImpl.cc.


The documentation for this class was generated from the following files: