FFrFieldEntryBase Class Reference

#include <FFrFieldEntryBase.H>

Inheritance diagram for FFrFieldEntryBase:

Collaboration diagram for FFrFieldEntryBase:

Public Member Functions
	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...
virtual const std::string &	getDescription () const =0
virtual bool	hasDescription () const
virtual const std::string &	getType () const =0
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
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	isOG () const
virtual bool	isSOG () const
virtual bool	isIG () const
virtual bool	isVarRef () const
virtual int	traverse (FFrResultContainer *, FFrEntryBase *, FFrEntryBase *&, int binPos)
	Traverses to build owner hierarchy and calculate binary sizes. More...
virtual bool	compare (const FFrEntryBase *) const

Public Attributes
std::vector< FFrEntryBase * >	dataFields

Protected Member Functions
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

FFrFieldEntryBase()

FFrFieldEntryBase::FFrFieldEntryBase ( )

inline

~FFrFieldEntryBase()

FFrFieldEntryBase::~FFrFieldEntryBase ( )

virtual

Member Function Documentation

equal()

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

virtual

Implements FFrEntryBase.

Reimplemented in FFrItemGroup.

getDataFields()

virtual const std::vector<FFrEntryBase*>* FFrFieldEntryBase::getDataFields ( ) const

inlinevirtual

Returns a pointer to the data fields if they are set, returns 0 if not.

Reimplemented from FFrEntryBase.

hasDataFields()

virtual bool FFrFieldEntryBase::hasDataFields ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

isEmpty()

bool FFrFieldEntryBase::isEmpty ( ) const

virtual

Returns true if this entry and all below it are empty.

Implements FFrEntryBase.

isVariableFloat()

bool FFrFieldEntryBase::isVariableFloat ( ) const

virtual

Returns true if the first variable referred is a float.

Implements FFrEntryBase.

less()

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

virtual

Implements FFrEntryBase.

Reimplemented in FFrItemGroup.

merge()

bool FFrFieldEntryBase::merge ( FFrEntryBase *  objToMergeFrom )

virtual

Implements FFrEntryBase.

printPosition()

void FFrFieldEntryBase::printPosition ( std::ostream &  os ) const

virtual

Prints out the positioning data of this field.

Implements FFrEntryBase.

recursiveReadPosData() [1/3]

int FFrFieldEntryBase::recursiveReadPosData ( const double *  vals, int  nvals, int  arrayPos  ) const

protectedvirtual

Implements FFrEntryBase.

recursiveReadPosData() [2/3]

int FFrFieldEntryBase::recursiveReadPosData ( const float *  vals, int  nvals, int  arrayPos  ) const

protectedvirtual

Implements FFrEntryBase.

recursiveReadPosData() [3/3]

int FFrFieldEntryBase::recursiveReadPosData ( const int *  vals, int  nvals, int  arrayPos  ) const

protectedvirtual

Implements FFrEntryBase.

removeContainers()

void FFrFieldEntryBase::removeContainers ( const std::set< FFrResultContainer * > &  cont )

virtual

Implements FFrEntryBase.

resolve()

bool FFrFieldEntryBase::resolve	(	const std::string &	references,
		FFrCreatorData &	cd,
		bool	inlined = true
	)

Resolves the references string (the last string in object- and item groups) to variable references or item group references.

sortDataFieldsByUserID()

void FFrFieldEntryBase::sortDataFieldsByUserID

(

)

Member Data Documentation

dataFields

std::vector<FFrEntryBase*> FFrFieldEntryBase::dataFields

---

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

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