AnyItemUserGroup.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* AnyItemUserGroup.h                                          (C) 2000-2025 */
/*                                                                           */
/* Aggregated user group of arbitrary types.                                 */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ANYITEM_ANYITEMUSERGROUP_H
#define ARCANE_CORE_ANYITEM_ANYITEMUSERGROUP_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/Exception.h"
 
#include "arcane/core/anyitem/AnyItemGlobal.h"
#include "arcane/core/anyitem/AnyItemPrivate.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::AnyItem
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class UserGroup
: public Group
, public IFamilyObserver
{
 private:
 
  typedef Private::GroupIndexMapping GroupIndexMapping;
 
 public:
 
  UserGroup(const Family& family)
  : Group(m_currents)
  , m_family(family)
  {
    m_family.registerObserver(*this);
  }
 
  ~UserGroup()
  {
    arcaneCallFunctionAndTerminateIfThrow([&]() { m_family.removeObserver(*this); });
  }

  inline UserGroup& operator<<(GroupBuilder builder)
  {
    ItemGroup group = builder.group();
    if (m_groups.findGroupInfo(group.internal()) != NULL)
      throw FatalErrorException(String::format("Group '{0}' in user group already registered", group.name()));
 
    const Private::GroupIndexInfo* info = m_family.internal()->findGroupInfo(group);
    if (info == NULL)
      throw FatalErrorException(String::format("Group '{0}' in user group not registered in family", group.name()));
 
    if (builder.isPartial() != info->is_partial)
      throw FatalErrorException(String::format("Group '{0}' in user group is not same in family", group.name()));
 
    m_currents.add(*info);
    return *this;
  }

  inline void clear()
  {
    m_currents.clear();
  }

  inline void notifyFamilyIsInvalidate()
  {
    // If the family changes, the group is invalidated
    clear();
  }

  inline void notifyFamilyIsIncreased()
  {
    // Nothing is done in this case
  }
 
 private:

  const Family m_family;

  GroupIndexMapping m_currents;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::AnyItem
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif