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

Class representing mechanism objects in a result file hierarchy. More...

#include <FFrObjectGroup.H>

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

Public Member Functions

 FFrObjectGroup ()
 The default constructor initializes its data members. More...
 
virtual ~FFrObjectGroup ()
 Empty destructor. More...
 
int fillObject (const std::vector< std::string > &tokens, FFrCreatorData &cd)
 Parses the object group definition from a list of strings. More...
 
virtual int traverse (FFrResultContainer *resultContainer, FFrEntryBase *owner, FFrEntryBase *&objToBeModified, int binPos)
 Traverses to build owner hierarchy and calculate binary sizes. More...
 
virtual const std::string & getDescription () const
 Returns the description of this object group. More...
 
virtual bool hasDescription () const
 Returns whether the entry has a description or not. More...
 
virtual const std::string & getType () const
 Returns the type name of the object represented by this entry. More...
 
virtual int getBaseID () const
 Returns the baseId for this entry. More...
 
virtual bool hasBaseID () const
 Returns whether this entry has a base ID or not. More...
 
virtual int getUserID () const
 Returns the userId for this entry. More...
 
virtual bool hasUserID () const
 Returns whether this entry has a user ID or not. More...
 
virtual bool isOG () const
 Returns true since this entry is an 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...
 
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 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 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...
 

Static Public Member Functions

static FFrStatus create (FILE *varStream, FFrCreatorData &cd, bool dataBlocks)
 Static method for parsing an object group definition from file. More...
 

Private Attributes

int baseId
 The base ID of the object represented by this object group. More...
 
int userId
 The user ID of the object represented by this object group. More...
 
std::set< std::string >::const_iterator typeIt
 Points to the type name of this entry, which is kept in a dictionary. More...
 
std::string description
 User-defined description of the object represented by this object group. 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 mechanism objects in a result file hierarchy.

An object group is a result database entry that corresponds to a mechanism object (Triad, Part, Spring, etc.) in a Fedem model. The result quantities associated with the object are then represented by item group and variable reference entries as data fields, held by the parent class FFrFieldEntryBase.

Constructor & Destructor Documentation

◆ FFrObjectGroup()

FFrObjectGroup::FFrObjectGroup ( )

The default constructor initializes its data members.

◆ ~FFrObjectGroup()

FFrObjectGroup::~FFrObjectGroup ( )
virtual

Empty destructor.

Member Function Documentation

◆ create()

FFrStatus FFrObjectGroup::create ( FILE *  varStream,
FFrCreatorData &  cd,
bool  dataBlocks 
)
static

Static method for parsing an object group definition from file.

◆ fillObject()

int FFrObjectGroup::fillObject ( const std::vector< std::string > &  tokens,
FFrCreatorData &  cd 
)

Parses the object group definition from a list of strings.

◆ getBaseID()

virtual int FFrObjectGroup::getBaseID ( ) const
inlinevirtual

Returns the baseId for this entry.

Reimplemented from FFrEntryBase.

◆ getDescription()

virtual const std::string& FFrObjectGroup::getDescription ( ) const
inlinevirtual

Returns the description of this object group.

Implements FFrEntryBase.

◆ getType()

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

Returns the type name of the object represented by this entry.

Implements FFrEntryBase.

◆ getUserID()

virtual int FFrObjectGroup::getUserID ( ) const
inlinevirtual

Returns the userId for this entry.

Reimplemented from FFrEntryBase.

◆ hasBaseID()

virtual bool FFrObjectGroup::hasBaseID ( ) const
inlinevirtual

Returns whether this entry has a base ID or not.

Reimplemented from FFrEntryBase.

◆ hasDescription()

virtual bool FFrObjectGroup::hasDescription ( ) const
inlinevirtual

Returns whether the entry has a description or not.

Reimplemented from FFrEntryBase.

◆ hasUserID()

virtual bool FFrObjectGroup::hasUserID ( ) const
inlinevirtual

Returns whether this entry has a user ID or not.

Reimplemented from FFrEntryBase.

◆ isOG()

virtual bool FFrObjectGroup::isOG ( ) const
inlinevirtual

Returns true since this entry is an Object Group.

Reimplemented from FFrEntryBase.

◆ traverse()

int FFrObjectGroup::traverse ( FFrResultContainer *  ,
FFrEntryBase *  ,
FFrEntryBase *&  ,
int  binPos 
)
virtual

Traverses to build owner hierarchy and calculate binary sizes.

Reimplemented from FFrEntryBase.

Member Data Documentation

◆ baseId

int FFrObjectGroup::baseId
private

The base ID of the object represented by this object group.

◆ description

std::string FFrObjectGroup::description
private

User-defined description of the object represented by this object group.

◆ typeIt

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

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

◆ userId

int FFrObjectGroup::userId
private

The user ID of the object represented by this object group.


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