FFrEntryBase.H

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 SAP SE
//
// SPDX-License-Identifier: Apache-2.0
//
// This file is part of FEDEM - https://openfedem.org
 
#ifndef FFR_ENTRY_BASE_H
#define FFR_ENTRY_BASE_H
 
#ifdef FFR_LISTVIEW
#include "FFaLib/FFaDefinitions/FFaListViewItem.H"
#endif
#include <iostream>
#include <string>
#include <vector>
#include <set>
 
class FFrResultContainer;
class FFaResultDescription;
 
 
#ifdef FFR_LISTVIEW
class FFrEntryBase : public FFaListViewItem
#else
class FFrEntryBase
#endif
{
public:
  FFrEntryBase() : myOwner(NULL), myGlobal(false)
  {
#if FFR_DEBUG > 2
    myCount = 0;
#endif
  }
  FFrEntryBase(const FFrEntryBase& obj)
  {
    myOwner = obj.myOwner;
    myGlobal = obj.myGlobal;
#if FFR_DEBUG > 2
    myCount = 0;
#endif
  }
  FFrEntryBase& operator=(const FFrEntryBase&) = delete;
  virtual ~FFrEntryBase() {}
 
  FFaResultDescription getEntryDescription() const;
 
  virtual const std::string& getDescription() const = 0;
  virtual bool hasDescription() const { return false; }
 
  virtual const std::string& getType() const = 0;
 
#ifdef FFR_LISTVIEW
  // From FFaListViewItem
  virtual const char* getItemName() const { return this->getType().c_str(); }
  // The next two methods always return 0 to avoid that result items are sorted
  virtual std::string getItemDescr() const { return ""; }
  virtual int getItemID() const { return 0; }
  virtual int getItemBaseID() const { return this->getBaseID(); }
#endif
 
  virtual int  getBaseID() const { return 0; }
  virtual bool hasBaseID() const { return false; }
 
  virtual int  getUserID() const { return 0; }
  virtual bool hasUserID() const { return false; }
 
  virtual const std::vector<FFrEntryBase*>* getDataFields() const { return 0; }
  virtual bool hasDataFields() const { return false; }
 
  template<class T>
  int readPositionedTimestepData(const T* values, int nvals) const
  { return this->recursiveReadPosData(values, nvals, 0); }
 
  virtual void printPosition(std::ostream& os) const = 0;
#if FFR_DEBUG > 2
  void printID(std::ostream& os, bool EOL = true) const;
#endif
 
  FFrEntryBase* getOwner() const { return myOwner; }
#if FFR_DEBUG > 2
  void setOwner(FFrEntryBase* owner);
#else
  void setOwner(FFrEntryBase* owner) { myOwner = owner; }
#endif
  virtual void setGlobal() { myGlobal = true; }
  bool isGlobal() const { return myGlobal; }
 
  // Simple type checking
  virtual bool isOG() const     { return false; }
  virtual bool isSOG() const    { return false; }
  virtual bool isIG() const     { return false; }
  virtual bool isVarRef() const { return false; }
 
  virtual bool isEmpty() const = 0;
 
  virtual bool isVariableFloat() const = 0;
 
  // "Private" public methods
 
  virtual void removeContainers(const std::set<FFrResultContainer*>& cont) = 0;
 
  virtual int traverse(FFrResultContainer*, FFrEntryBase*, FFrEntryBase*&,
               int binPos) { return binPos; }
 
  virtual bool merge(FFrEntryBase* objToMergeFrom) = 0;
  virtual bool compare(const FFrEntryBase*) const { return false; }
  virtual bool equal(const FFrEntryBase* obj) const = 0;
  virtual bool less(const FFrEntryBase* obj) const = 0;
 
  virtual int recursiveReadPosData(const double* vals, int nvals, int arrayPos) const = 0;
  virtual int recursiveReadPosData(const float* vals, int nvals, int arrayPos) const = 0;
  virtual int recursiveReadPosData(const int* vals, int nvals, int arrayPos) const = 0;
 
private:
  FFrEntryBase* myOwner;  
  bool          myGlobal; 
 
#if FFR_DEBUG > 2
protected:
  long int myCount;
#endif
};
 
#endif