FEDEM Solver  R8.0
Source code of the dynamics solver
FFrFieldEntryBase.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_FIELD_ENTRY_BASE_H
14 #define FFR_FIELD_ENTRY_BASE_H
15 
16 #include "FFrLib/FFrEntryBase.H"
17 
18 class FFrCreatorData;
19 
20 
30 {
31 public:
33  virtual ~FFrFieldEntryBase();
34 
37 
39  bool resolve(const std::string& references, FFrCreatorData& cd,
40  bool inlined = true);
41 
42  virtual const FFrEntries* getDataFields() const { return &dataFields; }
43  virtual bool hasDataFields() const { return !dataFields.empty(); }
44 
45  virtual bool isEmpty() const;
46  virtual bool isVariableFloat() const;
47 
48  virtual void removeContainers(const std::set<FFrResultContainer*>& cont);
49 
50  virtual bool merge(FFrEntryBase* objToMergeFrom);
51  virtual bool equal(const FFrEntryBase* obj) const;
52  virtual bool less(const FFrEntryBase* obj) const;
53 
55  virtual void printPosition(std::ostream& os) const;
56 
58 
59 protected:
60  virtual int readPosData(const double* vals, int nvals, int pos) const;
61  virtual int readPosData(const float* vals, int nvals, int pos) const;
62  virtual int readPosData(const int* vals, int nvals, int pos) const;
63 };
64 
65 #endif
Base class for result file entries.
std::vector< FFrEntryBase * > FFrEntries
Convenience type alias.
Definition: FFrEntryBase.H:28
Base class for result file entries.
Definition: FFrEntryBase.H:42
Generic base class for non-leaf result file entries.
Definition: FFrFieldEntryBase.H:30
void sortDataFieldsByUserID()
Sorts the data fields based on their user ID.
Definition: FFrFieldEntryBase.C:160
FFrEntries dataFields
List of data fields referred by this entry.
Definition: FFrFieldEntryBase.H:57
bool resolve(const std::string &references, FFrCreatorData &cd, bool inlined=true)
Resolves a string of references into datafield entries.
Definition: FFrFieldEntryBase.C:56
virtual bool equal(const FFrEntryBase *obj) const
Returns true if *this and *obj are considered equal.
Definition: FFrFieldEntryBase.C:233
virtual void printPosition(std::ostream &os) const
Prints out the positioning data of this field.
Definition: FFrFieldEntryBase.C:289
virtual bool merge(FFrEntryBase *objToMergeFrom)
Merges another entry into *this.
Definition: FFrFieldEntryBase.C:173
virtual const FFrEntries * getDataFields() const
Returns a pointer to the data fields of this entry.
Definition: FFrFieldEntryBase.H:42
virtual ~FFrFieldEntryBase()
The destructor deletes the heap-allocated data fields.
Definition: FFrFieldEntryBase.C:22
virtual bool isEmpty() const
Returns true if this entry and all below it are empty.
Definition: FFrFieldEntryBase.C:30
virtual bool isVariableFloat() const
Returns true if the first variable referred is a float.
Definition: FFrFieldEntryBase.C:40
virtual void removeContainers(const std::set< FFrResultContainer * > &cont)
Removes data associated with given containers for this entry.
Definition: FFrFieldEntryBase.C:141
virtual int readPosData(const double *vals, int nvals, int pos) const
Reads double data from the hierarhcy under this entry.
Definition: FFrFieldEntryBase.C:264
virtual bool hasDataFields() const
Returns whether this entry has data fields or not.
Definition: FFrFieldEntryBase.H:43
virtual bool less(const FFrEntryBase *obj) const
Returns true if *this is ordered before *obj.
Definition: FFrFieldEntryBase.C:249
Incapsulation of temporary data used during results file parsing.
Definition: FFrResultContainer.H:36