|
FEDEM Solver
R8.0
Source code of the dynamics solver
|
Base class for result file entries. More...
#include <FFrEntryBase.H>


Public Member Functions | |
| virtual | ~FFrEntryBase () |
| Empty destructor. More... | |
| FFaResultDescription | getEntryDescription () const |
| Returns the full path of this result entry. More... | |
| virtual const std::string & | getDescription () const =0 |
| Returns the description of this entry. More... | |
| virtual bool | hasDescription () const |
| Returns whether the entry has a description or not. More... | |
| virtual const std::string & | getType () const =0 |
| Returns the referred object type. More... | |
| virtual int | getBaseID () const |
| Returns the base ID of the object if this entry is an Object Group. More... | |
| virtual bool | hasBaseID () const |
| Returns whether this entry has a base ID or not. More... | |
| virtual int | getUserID () const |
| Returns the user ID for this entry. More... | |
| virtual bool | hasUserID () const |
| Returns whether this entry has a user ID or not. More... | |
| virtual const FFrEntries * | getDataFields () const |
| Returns a pointer to the data fields of this entry. More... | |
| virtual bool | hasDataFields () const |
| Returns whether this entry has data fields or not. More... | |
| template<class T > | |
| int | readPositionedTimestepData (const T *values, int nvals) const |
| Reads variable reference data from the hierarhcy under this entry. More... | |
| virtual void | printPosition (std::ostream &os) const =0 |
| Prints out the positioning data of this entry. More... | |
| FFrEntryBase * | getOwner () const |
| Returns the owner of this entry in the hierarchy. More... | |
| void | setOwner (FFrEntryBase *owner) |
| Defines the owner of this entry in the hierarchy. More... | |
| virtual void | setGlobal () |
| Defines this as a global scope entry. More... | |
| bool | isGlobal () const |
| Check if this entry is in global scope or not. More... | |
| virtual bool | isOG () const |
| Returns whether this entry is an Object Group or not. More... | |
| virtual bool | isSOG () const |
| Returns whether this entry is a Super Object Group or not. More... | |
| virtual bool | isIG () const |
| Returns whether this entry is an Item Group or not. More... | |
| virtual bool | isVarRef () const |
| Returns whether this entry is a Variable Reference or not. More... | |
| virtual bool | isEmpty () const =0 |
| Returns true if this entry and all below it are empty. More... | |
| virtual bool | isVariableFloat () const =0 |
| Returns true if the first variable referred is a float. More... | |
| virtual void | removeContainers (const std::set< FFrResultContainer * > &cont)=0 |
| Removes data associated with given containers for this entry. More... | |
| virtual int | traverse (FFrResultContainer *, FFrEntryBase *, FFrEntryBase *&, int binPos) |
| Traverses to build owner hierarchy and calculate binary sizes. More... | |
| virtual bool | merge (FFrEntryBase *objToMergeFrom)=0 |
| Merges another entry into *this. More... | |
| virtual bool | comp (const FFrEntryBase *) const |
| Returns true if *this equals another specified entry. More... | |
| virtual bool | equal (const FFrEntryBase *obj) const =0 |
| Returns true if *this and *obj are considered equal. More... | |
| virtual bool | less (const FFrEntryBase *obj) const =0 |
| Returns true if *this is ordered before *obj. More... | |
| virtual int | readPosData (const double *vals, int nvals, int pos=0) const =0 |
| Reads double data from the hierarhcy under this entry. More... | |
| virtual int | readPosData (const float *vals, int nvals, int pos=0) const =0 |
| Reads float data from the hierarhcy under this entry. More... | |
| virtual int | readPosData (const int *vals, int nvals, int pos=0) const =0 |
| Reads integer data from the hierarhcy under this entry. More... | |
| template<class T > | |
| bool | readVar (T &value) |
| Reads a variable from the results container for current time step. More... | |
Protected Member Functions | |
| FFrEntryBase () | |
| Default constructor. More... | |
| FFrEntryBase (const FFrEntryBase &obj) | |
| Copy constructor. More... | |
| FFrEntryBase & | operator= (const FFrEntryBase &)=delete |
| Disable default assignment operator. More... | |
Private Attributes | |
| FFrEntryBase * | myOwner |
| Parent of this entry in the RDB hierchy. More... | |
| bool | myGlobal |
| Global (extractor-level) or local (container level) More... | |
Base class for result file entries.
This is an abstract interface for various result file entry types. It contains many pure virtual methods to be implemented by sub-classes.
|
inlineprotected |
Default constructor.
|
inlineprotected |
Copy constructor.
|
inlinevirtual |
Empty destructor.
|
inlinevirtual |
Returns true if *this equals another specified entry.
Reimplemented in FFrVariableReference, and FFrItemGroup.
|
pure virtual |
Returns true if *this and *obj are considered equal.
Implemented in FFrVariableReference, FFrItemGroup, and FFrFieldEntryBase.
|
inlinevirtual |
Returns the base ID of the object if this entry is an Object Group.
The method returns 0 for other entry types.
Reimplemented in FFrObjectGroup.
|
inlinevirtual |
Returns a pointer to the data fields of this entry.
A null pointer is returned if the data fields are not set.
Reimplemented in FFrFieldEntryBase.
|
pure virtual |
Returns the description of this entry.
Implemented in FFrVariableReference, FFrSuperObjectGroup, FFrObjectGroup, and FFrItemGroup.
| FFaResultDescription FFrEntryBase::getEntryDescription | ( | ) | const |
Returns the full path of this result entry.
|
inline |
Returns the owner of this entry in the hierarchy.
|
pure virtual |
Returns the referred object type.
E.g., "Triad" for an object group representing triad data. For variable references, it returns the data type of that variable, e.g., SCALAR.
Implemented in FFrVariableReference, FFrSuperObjectGroup, FFrObjectGroup, and FFrItemGroup.
|
inlinevirtual |
Returns the user ID for this entry.
Object group and item group entries have a user ID. For other types (e.g., variable references) zero is returned.
Reimplemented in FFrObjectGroup, and FFrItemGroup.
|
inlinevirtual |
Returns whether this entry has a base ID or not.
Reimplemented in FFrObjectGroup.
|
inlinevirtual |
Returns whether this entry has data fields or not.
Reimplemented in FFrFieldEntryBase.
|
inlinevirtual |
Returns whether the entry has a description or not.
Reimplemented in FFrObjectGroup, and FFrItemGroup.
|
inlinevirtual |
Returns whether this entry has a user ID or not.
Reimplemented in FFrObjectGroup, and FFrItemGroup.
|
pure virtual |
Returns true if this entry and all below it are empty.
Implemented in FFrVariableReference, and FFrFieldEntryBase.
|
inline |
Check if this entry is in global scope or not.
|
inlinevirtual |
Returns whether this entry is an Item Group or not.
Reimplemented in FFrItemGroup.
|
inlinevirtual |
Returns whether this entry is an Object Group or not.
Reimplemented in FFrObjectGroup.
|
inlinevirtual |
Returns whether this entry is a Super Object Group or not.
Reimplemented in FFrSuperObjectGroup.
|
pure virtual |
Returns true if the first variable referred is a float.
Implemented in FFrVariableReference, and FFrFieldEntryBase.
|
inlinevirtual |
Returns whether this entry is a Variable Reference or not.
Reimplemented in FFrVariableReference.
|
pure virtual |
Returns true if *this is ordered before *obj.
Implemented in FFrVariableReference, FFrItemGroup, and FFrFieldEntryBase.
|
pure virtual |
Merges another entry into *this.
Implemented in FFrFieldEntryBase, and FFrVariableReference.
|
protecteddelete |
Disable default assignment operator.
|
pure virtual |
Prints out the positioning data of this entry.
Implemented in FFrVariableReference, and FFrFieldEntryBase.
|
pure virtual |
Reads double data from the hierarhcy under this entry.
Implemented in FFrFieldEntryBase, and FFrVariableReference.
|
pure virtual |
Reads float data from the hierarhcy under this entry.
Implemented in FFrFieldEntryBase, and FFrVariableReference.
|
pure virtual |
Reads integer data from the hierarhcy under this entry.
Implemented in FFrFieldEntryBase, and FFrVariableReference.
|
inline |
Reads variable reference data from the hierarhcy under this entry.
| template bool FFrEntryBase::readVar< Vec3Vec > | ( | T & | value | ) |
Reads a variable from the results container for current time step.
|
pure virtual |
Removes data associated with given containers for this entry.
Implemented in FFrVariableReference, and FFrFieldEntryBase.
|
inlinevirtual |
Defines this as a global scope entry.
By default, all entries are considered to be in container scope.
Reimplemented in FFrItemGroup.
|
inline |
Defines the owner of this entry in the hierarchy.
|
inlinevirtual |
Traverses to build owner hierarchy and calculate binary sizes.
Reimplemented in FFrVariableReference, FFrObjectGroup, and FFrItemGroup.
|
private |
Global (extractor-level) or local (container level)
|
private |
Parent of this entry in the RDB hierchy.