#include <FFrItemGroup.H>

Inheritance diagram for FFrItemGroup:

Collaboration diagram for FFrItemGroup:

Classes
struct	Less

Public Member Functions
	FFrItemGroup (bool inlined=false)

	FFrItemGroup (const FFrItemGroup &obj)

virtual	~FFrItemGroup ()

FFrItemGroup &	operator= (const FFrItemGroup &)=delete

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 bool	compare (const FFrEntryBase *obj) const

virtual bool	equal (const FFrEntryBase *obj) const

virtual bool	less (const FFrEntryBase *obj) const

virtual int	getUserID () const
	Returns userID for objects that have a userID (OG and some IGs). More...

virtual bool	hasUserID () const

virtual const std::string &	getType () const

virtual const std::string &	getDescription () const

virtual bool	hasDescription () const

virtual bool	isIG () const

virtual void	setGlobal ()
	Defines this as a global-scope entry (as opposed to container-scope). More...

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 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...

virtual int	getBaseID () const
	Returns baseID for objects that have a baseID. Returns 0 for other types. More...

virtual bool	hasBaseID () const

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...

bool	isGlobal () const
	Check if this entry is in global scope. More...

virtual bool	isOG () const

virtual bool	isSOG () const

virtual bool	isVarRef () const

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

Private Attributes
std::set< std::string >::const_iterator	myNameIt

union {
int myId

FFrItemGroup * next

};

bool	isInlined

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

◆ FFrItemGroup() [1/2]

FFrItemGroup::FFrItemGroup ( bool inlined = false )

◆ FFrItemGroup() [2/2]

FFrItemGroup::FFrItemGroup ( const FFrItemGroup & obj )

◆ ~FFrItemGroup()

FFrItemGroup::~FFrItemGroup ( )

virtual

Member Function Documentation

◆ compare()

bool FFrItemGroup::compare ( const FFrEntryBase * obj ) const

virtual

Reimplemented from FFrEntryBase.

◆ create()

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

static

◆ equal()

bool FFrItemGroup::equal ( const FFrEntryBase * obj ) const

virtual

Reimplemented from FFrFieldEntryBase.

◆ fillObject()

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

Puts the data into this item group. Returns -1 on error, and 0 if no id could be read [id;name/num;references]. That would mean an inlined item group which can occur both in the VARIABLES and in the DATABLOCKS section. It also resolves the references.

◆ getDescription()

virtual const std::string& FFrItemGroup::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()

const std::string & FFrItemGroup::getType ( ) const

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 the variable, e.g., SCALAR.

Implements FFrEntryBase.

◆ getUserID()

virtual int FFrItemGroup::getUserID ( ) const

inlinevirtual

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

Reimplemented from FFrEntryBase.

◆ hasDescription()

virtual bool FFrItemGroup::hasDescription ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

◆ hasUserID()

virtual bool FFrItemGroup::hasUserID ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

◆ isIG()

virtual bool FFrItemGroup::isIG ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

◆ less()

bool FFrItemGroup::less ( const FFrEntryBase * obj ) const

virtual

Reimplemented from FFrFieldEntryBase.

◆ operator=()

FFrItemGroup& FFrItemGroup::operator= ( const FFrItemGroup & )

delete

◆ setGlobal()

void FFrItemGroup::setGlobal ( )

virtual

Defines this as a global-scope entry (as opposed to container-scope).

Reimplemented from FFrEntryBase.

◆ traverse()

int FFrItemGroup::traverse	(	FFrResultContainer *	,
		FFrEntryBase *	,
		FFrEntryBase *&	,
		int	binPos
	)

virtual

Traverses to build owner hierarchy and calculate binary sizes.

Reimplemented from FFrEntryBase.

Member Data Documentation

◆

union { ... }

◆ isInlined

bool FFrItemGroup::isInlined

private

◆ myId

int FFrItemGroup::myId

◆ myNameIt

std::set<std::string>::const_iterator FFrItemGroup::myNameIt

private

◆ next

FFrItemGroup* FFrItemGroup::next

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

fedem-foundation/src/FFrLib/FFrItemGroup.H
fedem-foundation/src/FFrLib/FFrItemGroup.C

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FFrItemGroup() [1/2]

◆ FFrItemGroup() [2/2]

◆ ~FFrItemGroup()

Member Function Documentation

◆ compare()

◆ create()

◆ equal()

◆ fillObject()

◆ getDescription()

◆ getType()

◆ getUserID()

◆ hasDescription()

◆ hasUserID()

◆ isIG()

◆ less()

◆ operator=()

◆ setGlobal()

◆ traverse()

Member Data Documentation

◆

◆ isInlined

◆ myId

◆ myNameIt

◆ next