FEDEM Solver  R8.0
Source code of the dynamics solver
Public Member Functions | Private Attributes | List of all members
FFrSuperObjectGroup Class Reference

Class representing top level entries in a result file hierarchy. More...

#include <FFrSuperObjectGroup.H>

Inheritance diagram for FFrSuperObjectGroup:
Inheritance graph
[legend]
Collaboration diagram for FFrSuperObjectGroup:
Collaboration graph
[legend]

Public Member Functions

 FFrSuperObjectGroup (const std::string &name, std::set< std::string > &dict)
 The constructor inserts its name in the dictionary. More...
 
virtual ~FFrSuperObjectGroup ()
 Empty destructor. More...
 
virtual const std::string & getDescription () const
 Returns the type name with additonal '(s)' formatting. More...
 
virtual const std::string & getType () const
 Returns the type name without any modifications. More...
 
virtual bool isSOG () const
 Returns true since this entry is as Super Object Group. More...
 
- Public Member Functions inherited from FFrFieldEntryBase
virtual ~FFrFieldEntryBase ()
 The destructor deletes the heap-allocated data fields. More...
 
void sortDataFieldsByUserID ()
 Sorts the data fields based on their user ID. More...
 
bool resolve (const std::string &references, FFrCreatorData &cd, bool inlined=true)
 Resolves a string of references into datafield entries. 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...
 
virtual bool isEmpty () const
 Returns true if this entry and all below it are empty. More...
 
virtual bool isVariableFloat () const
 Returns true if the first variable referred is a float. More...
 
virtual void removeContainers (const std::set< FFrResultContainer * > &cont)
 Removes data associated with given containers for this entry. More...
 
virtual bool merge (FFrEntryBase *objToMergeFrom)
 Merges another entry into *this. More...
 
virtual bool equal (const FFrEntryBase *obj) const
 Returns true if *this and *obj are considered equal. More...
 
virtual bool less (const FFrEntryBase *obj) const
 Returns true if *this is ordered before *obj. More...
 
virtual void printPosition (std::ostream &os) const
 Prints out the positioning data of this field. More...
 
- Public Member Functions inherited from FFrEntryBase
virtual ~FFrEntryBase ()
 Empty destructor. More...
 
FFaResultDescription getEntryDescription () const
 Returns the full path of this result entry. More...
 
virtual bool hasDescription () const
 Returns whether the entry has a description or not. 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...
 
template<class T >
int readPositionedTimestepData (const T *values, int nvals) const
 Reads variable reference data from the hierarhcy under 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 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 int traverse (FFrResultContainer *, FFrEntryBase *, FFrEntryBase *&, int binPos)
 Traverses to build owner hierarchy and calculate binary sizes. More...
 
virtual bool comp (const FFrEntryBase *) const
 Returns true if *this equals another specified entry. More...
 
template<class T >
bool readVar (T &value)
 Reads a variable from the results container for current time step. More...
 

Private Attributes

std::set< std::string >::const_iterator typeIt
 Points to the type name of this entry, which is kept in a dictionary. More...
 

Additional Inherited Members

- Public Attributes inherited from FFrFieldEntryBase
FFrEntries dataFields
 List of data fields referred by this entry. More...
 
- Protected Member Functions inherited from FFrFieldEntryBase
virtual int readPosData (const double *vals, int nvals, int pos) const
 Reads double data from the hierarhcy under this entry. More...
 
virtual int readPosData (const float *vals, int nvals, int pos) const
 Reads float data from the hierarhcy under this entry. More...
 
virtual int readPosData (const int *vals, int nvals, int pos) const
 Reads integer data from the hierarhcy under this entry. More...
 
- Protected Member Functions inherited from FFrEntryBase
 FFrEntryBase ()
 Default constructor. More...
 
 FFrEntryBase (const FFrEntryBase &obj)
 Copy constructor. More...
 
FFrEntryBase & operator= (const FFrEntryBase &)=delete
 Disable default assignment operator. More...
 

Detailed Description

Class representing top level entries in a result file hierarchy.

Constructor & Destructor Documentation

◆ FFrSuperObjectGroup()

FFrSuperObjectGroup::FFrSuperObjectGroup ( const std::string &  name,
std::set< std::string > &  dict 
)

The constructor inserts its name in the dictionary.

◆ ~FFrSuperObjectGroup()

FFrSuperObjectGroup::~FFrSuperObjectGroup ( )
virtual

Empty destructor.

Member Function Documentation

◆ getDescription()

const std::string & FFrSuperObjectGroup::getDescription ( ) const
virtual

Returns the type name with additonal '(s)' formatting.

Implements FFrEntryBase.

◆ getType()

virtual const std::string& FFrSuperObjectGroup::getType ( ) const
inlinevirtual

Returns the type name without any modifications.

Implements FFrEntryBase.

◆ isSOG()

virtual bool FFrSuperObjectGroup::isSOG ( ) const
inlinevirtual

Returns true since this entry is as Super Object Group.

Reimplemented from FFrEntryBase.

Member Data Documentation

◆ typeIt

std::set<std::string>::const_iterator FFrSuperObjectGroup::typeIt
private

Points to the type name of this entry, which is kept in a dictionary.


The documentation for this class was generated from the following files: