FEDEM Solver  R8.0
Source code of the dynamics solver
FFrObjectGroup.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_OBJECT_GROUP_H
14 #define FFR_OBJECT_GROUP_H
15 
17 #include "FFrLib/FFrEnums.H"
18 #include <cstdio>
19 
20 class FFrCreatorData;
21 
22 
33 {
34 public:
38  virtual ~FFrObjectGroup();
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 
52  virtual const std::string& getDescription() const { return description; }
53  virtual bool hasDescription() const { return !description.empty(); }
54 
56  virtual const std::string& getType() const { return *typeIt; }
57 
59  virtual int getBaseID() const { return baseId; }
60  virtual bool hasBaseID() const { return baseId != 0; }
61 
63  virtual int getUserID() const { return userId; }
64  virtual bool hasUserID() const { return userId != 0; }
65 
67  virtual bool isOG() const { return true; }
68 
69 private:
70  int baseId;
71  int userId;
72 
74  std::set<std::string>::const_iterator typeIt;
76  std::string description;
77 
78 #if FFR_DEBUG > 2
79  static long int count;
80 #endif
81 };
82 
83 #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.
Base class for result file entries.
Definition: FFrEntryBase.H:42
Generic base class for non-leaf result file entries.
Definition: FFrFieldEntryBase.H:30
Class representing mechanism objects in a result file hierarchy.
Definition: FFrObjectGroup.H:33
std::set< std::string >::const_iterator typeIt
Points to the type name of this entry, which is kept in a dictionary.
Definition: FFrObjectGroup.H:74
int fillObject(const std::vector< std::string > &tokens, FFrCreatorData &cd)
Parses the object group definition from a list of strings.
Definition: FFrObjectGroup.C:69
FFrObjectGroup()
The default constructor initializes its data members.
Definition: FFrObjectGroup.C:22
virtual int getUserID() const
Returns the userId for this entry.
Definition: FFrObjectGroup.H:63
int baseId
The base ID of the object represented by this object group.
Definition: FFrObjectGroup.H:70
virtual bool hasUserID() const
Returns whether this entry has a user ID or not.
Definition: FFrObjectGroup.H:64
std::string description
User-defined description of the object represented by this object group.
Definition: FFrObjectGroup.H:76
virtual int getBaseID() const
Returns the baseId for this entry.
Definition: FFrObjectGroup.H:59
virtual ~FFrObjectGroup()
Empty destructor.
Definition: FFrObjectGroup.C:36
virtual int traverse(FFrResultContainer *resultContainer, FFrEntryBase *owner, FFrEntryBase *&objToBeModified, int binPos)
Traverses to build owner hierarchy and calculate binary sizes.
Definition: FFrObjectGroup.C:96
static FFrStatus create(FILE *varStream, FFrCreatorData &cd, bool dataBlocks)
Static method for parsing an object group definition from file.
Definition: FFrObjectGroup.C:45
virtual const std::string & getDescription() const
Returns the description of this object group.
Definition: FFrObjectGroup.H:52
virtual const std::string & getType() const
Returns the type name of the object represented by this entry.
Definition: FFrObjectGroup.H:56
virtual bool hasDescription() const
Returns whether the entry has a description or not.
Definition: FFrObjectGroup.H:53
int userId
The user ID of the object represented by this object group.
Definition: FFrObjectGroup.H:71
virtual bool hasBaseID() const
Returns whether this entry has a base ID or not.
Definition: FFrObjectGroup.H:60
virtual bool isOG() const
Returns true since this entry is an Object Group.
Definition: FFrObjectGroup.H:67
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