FFrObjectGroup Class Reference

#include <FFrObjectGroup.H>

Inheritance diagram for FFrObjectGroup:

Collaboration diagram for FFrObjectGroup:

Public Member Functions
	FFrObjectGroup ()
virtual	~FFrObjectGroup ()
int	fillObject (const std::vector< std::string > &tokens, FFrCreatorData &cd)
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
virtual bool	hasDescription () const
virtual const std::string &	getType () const
virtual int	getBaseID () const
	Returns baseID for objects that have a baseID. Returns 0 for other types. More...
virtual bool	hasBaseID () const
virtual int	getUserID () const
	Returns userID for objects that have a userID (OG and some IGs). More...
virtual bool	hasUserID () const
virtual bool	isOG () const
Public Member Functions inherited from FFrFieldEntryBase
	FFrFieldEntryBase ()
virtual	~FFrFieldEntryBase ()
void	sortDataFieldsByUserID ()
bool	resolve (const std::string &references, FFrCreatorData &cd, bool inlined=true)
virtual const std::vector< FFrEntryBase * > *	getDataFields () const
	Returns a pointer to the data fields if they are set, returns 0 if not. More...
virtual bool	hasDataFields () const
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)
virtual bool	merge (FFrEntryBase *objToMergeFrom)
virtual bool	equal (const FFrEntryBase *obj) const
virtual bool	less (const FFrEntryBase *obj) const
virtual void	printPosition (std::ostream &os) const
	Prints out the positioning data of this field. More...
Public 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...
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 all variable reference data in 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 (as opposed to container-scope). More...
bool	isGlobal () const
	Check if this entry is in global scope. More...
virtual bool	isSOG () const
virtual bool	isIG () const
virtual bool	isVarRef () const
virtual bool	compare (const FFrEntryBase *) const

Static Public Member Functions
static FFrStatus	create (FILE *varStream, FFrCreatorData &cd, bool dataBlocks)

Private Attributes
int	baseId
int	id
std::set< std::string >::const_iterator	typeIt
std::string	description

Additional Inherited Members
Public Attributes inherited from FFrFieldEntryBase
std::vector< FFrEntryBase * >	dataFields
Protected Member Functions inherited from FFrFieldEntryBase
virtual int	recursiveReadPosData (const double *vals, int nvals, int arrayPos) const
virtual int	recursiveReadPosData (const float *vals, int nvals, int arrayPos) const
virtual int	recursiveReadPosData (const int *vals, int nvals, int arrayPos) const

Constructor & Destructor Documentation

FFrObjectGroup()

FFrObjectGroup::FFrObjectGroup

(

)

~FFrObjectGroup()

FFrObjectGroup::~FFrObjectGroup ( )

virtual

Member Function Documentation

create()

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

static

fillObject()

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

Parses one variable entry.

getBaseID()

virtual int FFrObjectGroup::getBaseID ( ) const

inlinevirtual

Returns baseID for objects that have a baseID. Returns 0 for other types.

Reimplemented from FFrEntryBase.

getDescription()

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

inlinevirtual

Returns the description of the object, e.g., "Triad 12" for a triad. For variable references, it returns the variable name.

Implements FFrEntryBase.

getType()

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

inlinevirtual

Returns the referred object type (e.g., "Triad" for an object group representing triad data. For variable references, it returns the data type of the variable, e.g., SCALAR.

Implements FFrEntryBase.

getUserID()

virtual int FFrObjectGroup::getUserID ( ) const

inlinevirtual

Returns userID for objects that have a userID (OG and some IGs).

Reimplemented from FFrEntryBase.

hasBaseID()

virtual bool FFrObjectGroup::hasBaseID ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

hasDescription()

virtual bool FFrObjectGroup::hasDescription ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

hasUserID()

virtual bool FFrObjectGroup::hasUserID ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

isOG()

virtual bool FFrObjectGroup::isOG ( ) const

inlinevirtual

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

description

std::string FFrObjectGroup::description

private

id

int FFrObjectGroup::id

private

typeIt

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

private

---

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

• fedem-foundation/src/FFrLib/FFrObjectGroup.H
• fedem-foundation/src/FFrLib/FFrObjectGroup.C