FEDEM Solver  R8.0
Source code of the dynamics solver
FFrItemGroup.H
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: 2023 SAP SE
2 //
3 // SPDX-License-Identifier: Apache-2.0
4 //
5 // This file is part of FEDEM - https://openfedem.org
7 
13 #ifndef FFR_ITEM_GROUP_H
14 #define FFR_ITEM_GROUP_H
15 
17 #include "FFrLib/FFrEnums.H"
18 #include <cstdio>
19 
20 class FFrCreatorData;
21 
22 
28 {
29 public:
31  explicit FFrItemGroup(bool inlined = false);
33  FFrItemGroup(const FFrItemGroup& obj);
35  virtual ~FFrItemGroup();
36 
38  FFrItemGroup& operator=(const FFrItemGroup&) = delete;
39 
41  static FFrStatus create(FILE* varStream, FFrCreatorData& cd, bool dataBlocks);
42 
44  int fillObject(const std::vector<std::string>& tokens, FFrCreatorData& cd);
45 
46  virtual int traverse(FFrResultContainer* resultContainer,
47  FFrEntryBase* owner,
48  FFrEntryBase*& objToBeModified,
49  int binPos);
50 
51  virtual void setGlobal();
52 
53  virtual bool equal(const FFrEntryBase* obj) const;
54  virtual bool comp(const FFrEntryBase* obj) const;
55  virtual bool less(const FFrEntryBase* obj) const;
56 
57  virtual int getUserID() const { return myId; }
58  virtual bool hasUserID() const { return myId > 0; }
59 
61  virtual const std::string& getType() const;
63  virtual const std::string& getDescription() const { return this->getType(); }
65  virtual bool hasDescription() const { return true; }
66 
68  virtual bool isIG() const { return true; }
69 
70 private:
73  std::set<std::string>::const_iterator myNameIt;
74 
76  union {
77  int myId;
79  };
80  bool isInlined;
81 
82 #if FFR_DEBUG > 2
83  static long int count;
84 #endif
85 
86 public:
88  struct Less
89  {
91  bool operator()(const FFrItemGroup* first, const FFrItemGroup* sec) const;
92  };
93 
94 #ifdef FFR_NEWALLOC
96  // overloading the new & delete opers
97  static void* operator new(size_t size);
98  static void operator delete(void* deadObject, size_t size);
99 
100  static void releaseMemBlocks();
101 
102 private:
103  static size_t newed;
104  static FFrItemGroup* headOfFreeList;
105  static std::vector<FFrItemGroup*> memBlocks;
107 #endif
108 };
109 
110 
112 using ItemGroupSet = std::set<FFrItemGroup*,FFrItemGroup::Less>;
114 using ItemGroupSetCIt = ItemGroupSet::const_iterator;
116 using ItemGroupSetIt = ItemGroupSet::iterator;
117 
118 #endif
Enums that may be used by several FFrLib classes.
FFrStatus
Enum for different states while parsing a result database header.
Definition: FFrEnums.H:18
Generic base class for non-leaf result file entries.
ItemGroupSet::const_iterator ItemGroupSetCIt
Iterator over const item group container.
Definition: FFrItemGroup.H:114
ItemGroupSet::iterator ItemGroupSetIt
Iterator over item group container.
Definition: FFrItemGroup.H:116
std::set< FFrItemGroup *, FFrItemGroup::Less > ItemGroupSet
Data type alias for a sorted set of item groups.
Definition: FFrItemGroup.H:112
Base class for result file entries.
Definition: FFrEntryBase.H:42
Generic base class for non-leaf result file entries.
Definition: FFrFieldEntryBase.H:30
Class representng an item group in a result file hierarchy.
Definition: FFrItemGroup.H:28
std::set< std::string >::const_iterator myNameIt
Iterator pointing to the item group name.
Definition: FFrItemGroup.H:73
virtual bool hasDescription() const
Returns true since all item groups have a type name.
Definition: FFrItemGroup.H:65
FFrItemGroup * next
Used in memory management.
Definition: FFrItemGroup.H:78
virtual int getUserID() const
Returns the user ID for this entry.
Definition: FFrItemGroup.H:57
virtual bool hasUserID() const
Returns whether this entry has a user ID or not.
Definition: FFrItemGroup.H:58
int myId
The ID of this item group.
Definition: FFrItemGroup.H:77
int fillObject(const std::vector< std::string > &tokens, FFrCreatorData &cd)
Parses the item group definition from a list of strings.
Definition: FFrItemGroup.C:143
FFrItemGroup & operator=(const FFrItemGroup &)=delete
Deleted Assignment operator.
virtual void setGlobal()
Defines this as a global scope entry.
Definition: FFrItemGroup.C:233
virtual int traverse(FFrResultContainer *resultContainer, FFrEntryBase *owner, FFrEntryBase *&objToBeModified, int binPos)
Traverses to build owner hierarchy and calculate binary sizes.
Definition: FFrItemGroup.C:208
virtual const std::string & getDescription() const
Returns the type name of the item group.
Definition: FFrItemGroup.H:63
virtual bool less(const FFrEntryBase *obj) const
Returns true if *this is ordered before *obj.
Definition: FFrItemGroup.C:259
bool isInlined
If true, the item group has no name and no Id.
Definition: FFrItemGroup.H:80
virtual ~FFrItemGroup()
Empty destructor.
Definition: FFrItemGroup.C:52
FFrItemGroup(bool inlined=false)
Default constructor.
Definition: FFrItemGroup.C:22
static FFrStatus create(FILE *varStream, FFrCreatorData &cd, bool dataBlocks)
Static method for parsing an item group definition from file.
Definition: FFrItemGroup.C:71
virtual const std::string & getType() const
Returns either the given name or the ID of the item group.
Definition: FFrItemGroup.C:61
virtual bool comp(const FFrEntryBase *obj) const
Returns true if *this equals another specified entry.
Definition: FFrItemGroup.C:241
virtual bool equal(const FFrEntryBase *obj) const
Returns true if *this and *obj are considered equal.
Definition: FFrItemGroup.C:253
virtual bool isIG() const
Returns true since this entry is an Item Group.
Definition: FFrItemGroup.H:68
Class holding the data of a Fedem results file.
Definition: FFrResultContainer.H:71
Incapsulation of temporary data used during results file parsing.
Definition: FFrResultContainer.H:36
Functor for comparison of two item group definitions.
Definition: FFrItemGroup.H:89
bool operator()(const FFrItemGroup *first, const FFrItemGroup *sec) const
Returns true if *first is considered less than *sec.
Definition: FFrItemGroup.C:180