13 #ifndef FFR_ENTRY_BASE_H
14 #define FFR_ENTRY_BASE_H
79 virtual const std::string&
getType()
const = 0;
83 virtual const char* getItemName()
const {
return this->
getType().c_str(); }
85 virtual std::string getItemDescr()
const {
return ""; }
87 virtual int getItemID()
const {
return 0; }
89 virtual int getItemBaseID()
const {
return this->
getBaseID(); }
120 void printID(std::ostream& os,
bool EOL =
true)
const;
138 virtual bool isOG()
const {
return false; }
140 virtual bool isSOG()
const {
return false; }
142 virtual bool isIG()
const {
return false; }
159 int binPos) {
return binPos; }
171 virtual int readPosData(
const double* vals,
int nvals,
int pos = 0)
const = 0;
173 virtual int readPosData(
const float* vals,
int nvals,
int pos = 0)
const = 0;
175 virtual int readPosData(
const int* vals,
int nvals,
int pos = 0)
const = 0;
178 template<
class T>
bool readVar(T& value);
Base class for list view items.
std::vector< FFrEntryBase * > FFrEntries
Convenience type alias.
Definition: FFrEntryBase.H:28
Base class for list view items.
Definition: FFaListViewItem.H:31
Class representing a result variable description.
Definition: FFaResultDescription.H:31
Base class for result file entries.
Definition: FFrEntryBase.H:42
virtual bool merge(FFrEntryBase *objToMergeFrom)=0
Merges another entry into *this.
virtual bool hasUserID() const
Returns whether this entry has a user ID or not.
Definition: FFrEntryBase.H:103
virtual void removeContainers(const std::set< FFrResultContainer * > &cont)=0
Removes data associated with given containers for this entry.
bool readVar(T &value)
Reads a variable from the results container for current time step.
Definition: FFrEntryBase.C:84
virtual void setGlobal()
Defines this as a global scope entry.
Definition: FFrEntryBase.H:133
virtual int traverse(FFrResultContainer *, FFrEntryBase *, FFrEntryBase *&, int binPos)
Traverses to build owner hierarchy and calculate binary sizes.
Definition: FFrEntryBase.H:158
FFrEntryBase * getOwner() const
Returns the owner of this entry in the hierarchy.
Definition: FFrEntryBase.H:124
virtual bool hasBaseID() const
Returns whether this entry has a base ID or not.
Definition: FFrEntryBase.H:96
FFrEntryBase()
Default constructor.
Definition: FFrEntryBase.H:45
FFaResultDescription getEntryDescription() const
Returns the full path of this result entry.
Definition: FFrEntryBase.C:56
virtual bool isSOG() const
Returns whether this entry is a Super Object Group or not.
Definition: FFrEntryBase.H:140
virtual void printPosition(std::ostream &os) const =0
Prints out the positioning data of this entry.
virtual const FFrEntries * getDataFields() const
Returns a pointer to the data fields of this entry.
Definition: FFrEntryBase.H:107
virtual bool equal(const FFrEntryBase *obj) const =0
Returns true if *this and *obj are considered equal.
virtual int readPosData(const double *vals, int nvals, int pos=0) const =0
Reads double data from the hierarhcy under this entry.
virtual int getUserID() const
Returns the user ID for this entry.
Definition: FFrEntryBase.H:101
virtual bool hasDataFields() const
Returns whether this entry has data fields or not.
Definition: FFrEntryBase.H:109
virtual int getBaseID() const
Returns the base ID of the object if this entry is an Object Group.
Definition: FFrEntryBase.H:94
virtual bool isVariableFloat() const =0
Returns true if the first variable referred is a float.
virtual bool isEmpty() const =0
Returns true if this entry and all below it are empty.
virtual bool less(const FFrEntryBase *obj) const =0
Returns true if *this is ordered before *obj.
virtual const std::string & getDescription() const =0
Returns the description of this entry.
virtual ~FFrEntryBase()
Empty destructor.
Definition: FFrEntryBase.H:65
FFrEntryBase(const FFrEntryBase &obj)
Copy constructor.
Definition: FFrEntryBase.H:52
FFrEntryBase & operator=(const FFrEntryBase &)=delete
Disable default assignment operator.
virtual bool comp(const FFrEntryBase *) const
Returns true if *this equals another specified entry.
Definition: FFrEntryBase.H:164
virtual const std::string & getType() const =0
Returns the referred object type.
virtual int readPosData(const int *vals, int nvals, int pos=0) const =0
Reads integer data from the hierarhcy under this entry.
bool isGlobal() const
Check if this entry is in global scope or not.
Definition: FFrEntryBase.H:135
virtual bool isVarRef() const
Returns whether this entry is a Variable Reference or not.
Definition: FFrEntryBase.H:144
void setOwner(FFrEntryBase *owner)
Defines the owner of this entry in the hierarchy.
Definition: FFrEntryBase.H:129
virtual bool hasDescription() const
Returns whether the entry has a description or not.
Definition: FFrEntryBase.H:73
virtual bool isOG() const
Returns whether this entry is an Object Group or not.
Definition: FFrEntryBase.H:138
int readPositionedTimestepData(const T *values, int nvals) const
Reads variable reference data from the hierarhcy under this entry.
Definition: FFrEntryBase.H:113
bool myGlobal
Global (extractor-level) or local (container level)
Definition: FFrEntryBase.H:182
virtual bool isIG() const
Returns whether this entry is an Item Group or not.
Definition: FFrEntryBase.H:142
FFrEntryBase * myOwner
Parent of this entry in the RDB hierchy.
Definition: FFrEntryBase.H:181
virtual int readPosData(const float *vals, int nvals, int pos=0) const =0
Reads float data from the hierarhcy under this entry.
Class holding the data of a Fedem results file.
Definition: FFrResultContainer.H:71