Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::AnyItem::Family Class Reference

AnyItem family (flyweight pattern) Aggregation of groups to describe variables / partial variables Copy by reference. More...

#include <arcane/core/anyitem/AnyItemFamily.h>

Collaboration diagram for Arcane::AnyItem::Family:

Public Member Functions

 Family (const Family &f)
bool operator== (const Family &f) const
 Comparisons.
bool operator!= (const Family &f) const
Family & operator= (const Family &f)
Family & operator<< (GroupBuilder builder)
 Add a group to the family.
bool contains (const ItemGroup &group) const
 Returns true if the family contains the group.
bool isPartial (const ItemGroup &group) const
 Returns true if the group is associated with a partial variable.
Group allItems ()
 Group of all items.
Integer groupIndex (const ItemGroup &group) const
 Position of the group in the family.
Integer firstLocalId (const ItemGroup &group) const
 Position in the family of the first localId of this group.
template<typename AnyItemT>
Item item (const AnyItemT &any_item) const
 Returns the concrete item associated with this AnyItem.
Integer groupSize () const
 Size of the family, i.e., number of groups.
Integer maxLocalId () const
 Number of items in this family.
ItemGroup group (Integer i) const
 Accessor for the i-th group of the family.
void clear ()
 Clear the family.
void registerObserver (IFamilyObserver &observer) const
 Register an observer.
void removeObserver (IFamilyObserver &observer) const
 Remove an observer.
FamilyInternal * internal () const

Private Attributes

SharedPtrT< FamilyInternal > m_internal
 Internal family.

Detailed Description

AnyItem family (flyweight pattern) Aggregation of groups to describe variables / partial variables Copy by reference.

Definition at line 239 of file AnyItemFamily.h.

Constructor & Destructor Documentation

◆ Family() [1/2]

Arcane::AnyItem::Family::Family ( )
inline

Definition at line 243 of file AnyItemFamily.h.

◆ Family() [2/2]

Arcane::AnyItem::Family::Family ( const Family & f)
inline

Definition at line 246 of file AnyItemFamily.h.

◆ ~Family()

Arcane::AnyItem::Family::~Family ( )
inline

Definition at line 249 of file AnyItemFamily.h.

Member Function Documentation

◆ allItems()

Group Arcane::AnyItem::Family::allItems ( )
inline

Group of all items.

Definition at line 283 of file AnyItemFamily.h.

References m_internal.

◆ clear()

void Arcane::AnyItem::Family::clear ( )
inline

Clear the family.

Definition at line 327 of file AnyItemFamily.h.

References m_internal.

◆ contains()

bool Arcane::AnyItem::Family::contains ( const ItemGroup & group) const
inline

Returns true if the family contains the group.

Definition at line 271 of file AnyItemFamily.h.

References group(), and m_internal.

Here is the call graph for this function:

◆ firstLocalId()

Integer Arcane::AnyItem::Family::firstLocalId ( const ItemGroup & group) const
inline

Position in the family of the first localId of this group.

Definition at line 295 of file AnyItemFamily.h.

References group(), and m_internal.

Here is the call graph for this function:

◆ group()

ItemGroup Arcane::AnyItem::Family::group ( Integer i) const
inline

Accessor for the i-th group of the family.

Definition at line 321 of file AnyItemFamily.h.

References m_internal.

Referenced by contains(), firstLocalId(), groupIndex(), and isPartial().

Here is the caller graph for this function:

◆ groupIndex()

Integer Arcane::AnyItem::Family::groupIndex ( const ItemGroup & group) const
inline

Position of the group in the family.

Definition at line 289 of file AnyItemFamily.h.

References group(), and m_internal.

Here is the call graph for this function:

◆ groupSize()

Integer Arcane::AnyItem::Family::groupSize ( ) const
inline

Size of the family, i.e., number of groups.

Definition at line 308 of file AnyItemFamily.h.

References m_internal.

◆ internal()

FamilyInternal * Arcane::AnyItem::Family::internal ( ) const
inline

Definition at line 344 of file AnyItemFamily.h.

◆ isPartial()

bool Arcane::AnyItem::Family::isPartial ( const ItemGroup & group) const
inline

Returns true if the group is associated with a partial variable.

Definition at line 277 of file AnyItemFamily.h.

References group(), and m_internal.

Here is the call graph for this function:

◆ item()

template<typename AnyItemT>
Item Arcane::AnyItem::Family::item ( const AnyItemT & any_item) const
inline

Returns the concrete item associated with this AnyItem.

Definition at line 302 of file AnyItemFamily.h.

References m_internal.

◆ maxLocalId()

Integer Arcane::AnyItem::Family::maxLocalId ( ) const
inline

Number of items in this family.

Sum of the size of all groups composing it

Definition at line 315 of file AnyItemFamily.h.

References m_internal.

◆ operator!=()

bool Arcane::AnyItem::Family::operator!= ( const Family & f) const
inline

Definition at line 255 of file AnyItemFamily.h.

◆ operator<<()

Family & Arcane::AnyItem::Family::operator<< ( GroupBuilder builder)
inline

Add a group to the family.

Definition at line 264 of file AnyItemFamily.h.

References m_internal.

◆ operator=()

Family & Arcane::AnyItem::Family::operator= ( const Family & f)
inline

Definition at line 257 of file AnyItemFamily.h.

◆ operator==()

bool Arcane::AnyItem::Family::operator== ( const Family & f) const
inline

Comparisons.

Definition at line 254 of file AnyItemFamily.h.

References m_internal.

◆ registerObserver()

void Arcane::AnyItem::Family::registerObserver ( IFamilyObserver & observer) const
inline

Register an observer.

Definition at line 333 of file AnyItemFamily.h.

References m_internal.

◆ removeObserver()

void Arcane::AnyItem::Family::removeObserver ( IFamilyObserver & observer) const
inline

Remove an observer.

Definition at line 339 of file AnyItemFamily.h.

References m_internal.

Member Data Documentation

◆ m_internal

SharedPtrT<FamilyInternal> Arcane::AnyItem::Family::m_internal
private

Internal family.

Definition at line 352 of file AnyItemFamily.h.

Referenced by allItems(), clear(), contains(), firstLocalId(), group(), groupIndex(), groupSize(), isPartial(), item(), maxLocalId(), operator<<(), operator==(), registerObserver(), and removeObserver().

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