#include <FFrEntryBase.H>

Inheritance diagram for FFrEntryBase:

[legend]

Collaboration diagram for FFrEntryBase:

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

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

template<class T >
int	readPositionedTimestepData (const T *values, int nvals) const
	Reads all variable reference data in the hierarhcy under this entry. More...

virtual void	printPosition (std::ostream &os) const =0
	Prints out the positioning data of 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 bool	isEmpty () const =0
	Returns true if this entry and all below it are empty. More...

virtual bool	isVariableFloat () const =0
	Returns true if the first variable referred is a float. More...

virtual void	removeContainers (const std::set< FFrResultContainer * > &cont)=0

virtual int	traverse (FFrResultContainer , FFrEntryBase , FFrEntryBase *&, int binPos)
	Traverses to build owner hierarchy and calculate binary sizes. More...

virtual bool	merge (FFrEntryBase *objToMergeFrom)=0

virtual bool	compare (const FFrEntryBase *) const

virtual bool	equal (const FFrEntryBase *obj) const =0

virtual bool	less (const FFrEntryBase *obj) const =0

virtual int	recursiveReadPosData (const double *vals, int nvals, int arrayPos) const =0

virtual int	recursiveReadPosData (const float *vals, int nvals, int arrayPos) const =0

virtual int	recursiveReadPosData (const int *vals, int nvals, int arrayPos) const =0

Private Attributes
FFrEntryBase *	myOwner
	Parent of this entry in the RDB hierchy. More...

bool	myGlobal
	Global (extractor-level) or local (container level) More...

Constructor & Destructor Documentation

◆ FFrEntryBase() [1/2]

FFrEntryBase::FFrEntryBase ( )

inline

Default constructor.

◆ FFrEntryBase() [2/2]

FFrEntryBase::FFrEntryBase ( const FFrEntryBase & obj )

inline

Copy constructor.

◆ ~FFrEntryBase()

virtual FFrEntryBase::~FFrEntryBase ( )

inlinevirtual

Empty destructor.

Member Function Documentation

◆ compare()

virtual bool FFrEntryBase::compare ( const FFrEntryBase * ) const

inlinevirtual

Reimplemented in FFrVariableReference, and FFrItemGroup.

◆ equal()

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

pure virtual

Implemented in FFrVariableReference, FFrItemGroup, and FFrFieldEntryBase.

◆ getBaseID()

virtual int FFrEntryBase::getBaseID ( ) const

inlinevirtual

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

Reimplemented in FFrObjectGroup.

◆ getDataFields()

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

inlinevirtual

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

Reimplemented in FFrFieldEntryBase.

◆ getDescription()

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

pure virtual

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

Implemented in FFrVariableReference, FFrSuperObjectGroup, FFrObjectGroup, and FFrItemGroup.

◆ getEntryDescription()

FFaResultDescription FFrEntryBase::getEntryDescription ( ) const

Returns the full path of this result entry.

◆ getOwner()

FFrEntryBase* FFrEntryBase::getOwner ( ) const

inline

Returns the owner of this entry in the hierarchy.

◆ getType()

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

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

Implemented in FFrVariableReference, FFrSuperObjectGroup, FFrObjectGroup, and FFrItemGroup.

◆ getUserID()

virtual int FFrEntryBase::getUserID ( ) const

inlinevirtual

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

Reimplemented in FFrObjectGroup, and FFrItemGroup.

◆ hasBaseID()

virtual bool FFrEntryBase::hasBaseID ( ) const

inlinevirtual

Reimplemented in FFrObjectGroup.

◆ hasDataFields()

virtual bool FFrEntryBase::hasDataFields ( ) const

inlinevirtual

Reimplemented in FFrFieldEntryBase.

◆ hasDescription()

virtual bool FFrEntryBase::hasDescription ( ) const

inlinevirtual

Reimplemented in FFrObjectGroup, and FFrItemGroup.

◆ hasUserID()

virtual bool FFrEntryBase::hasUserID ( ) const

inlinevirtual

Reimplemented in FFrObjectGroup, and FFrItemGroup.

◆ isEmpty()

virtual bool FFrEntryBase::isEmpty ( ) const

pure virtual

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

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ isGlobal()

bool FFrEntryBase::isGlobal ( ) const

inline

Check if this entry is in global scope.

◆ isIG()

virtual bool FFrEntryBase::isIG ( ) const

inlinevirtual

Reimplemented in FFrItemGroup.

◆ isOG()

virtual bool FFrEntryBase::isOG ( ) const

inlinevirtual

Reimplemented in FFrObjectGroup.

◆ isSOG()

virtual bool FFrEntryBase::isSOG ( ) const

inlinevirtual

Reimplemented in FFrSuperObjectGroup.

◆ isVariableFloat()

virtual bool FFrEntryBase::isVariableFloat ( ) const

pure virtual

Returns true if the first variable referred is a float.

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ isVarRef()

virtual bool FFrEntryBase::isVarRef ( ) const

inlinevirtual

Reimplemented in FFrVariableReference.

◆ less()

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

pure virtual

Implemented in FFrVariableReference, FFrItemGroup, and FFrFieldEntryBase.

◆ merge()

virtual bool FFrEntryBase::merge ( FFrEntryBase * objToMergeFrom )

pure virtual

Implemented in FFrFieldEntryBase, and FFrVariableReference.

◆ operator=()

FFrEntryBase& FFrEntryBase::operator= ( const FFrEntryBase & )

delete

Disable default assignment operator.

◆ printPosition()

virtual void FFrEntryBase::printPosition ( std::ostream & os ) const

pure virtual

Prints out the positioning data of this entry.

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ readPositionedTimestepData()

template<class T >

int FFrEntryBase::readPositionedTimestepData	(	const T *	values,
		int	nvals
	)		const

inline

Reads all variable reference data in the hierarhcy under this entry.

◆ recursiveReadPosData() [1/3]

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

pure virtual

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ recursiveReadPosData() [2/3]

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

pure virtual

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ recursiveReadPosData() [3/3]

virtual int FFrEntryBase::recursiveReadPosData	(	const int *	vals,
		int	nvals,
		int	arrayPos
	)		const

pure virtual

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ removeContainers()

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

pure virtual

Implemented in FFrVariableReference, and FFrFieldEntryBase.

◆ setGlobal()

virtual void FFrEntryBase::setGlobal ( )

inlinevirtual

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

Reimplemented in FFrItemGroup.

◆ setOwner()

void FFrEntryBase::setOwner ( FFrEntryBase * owner )

inline

Defines the owner of this entry in the hierarchy.

◆ traverse()

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

inlinevirtual

Traverses to build owner hierarchy and calculate binary sizes.

Reimplemented in FFrVariableReference, FFrObjectGroup, and FFrItemGroup.

Member Data Documentation

◆ myGlobal

bool FFrEntryBase::myGlobal

private

Global (extractor-level) or local (container level)

◆ myOwner

FFrEntryBase* FFrEntryBase::myOwner

private

Parent of this entry in the RDB hierchy.

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

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

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ FFrEntryBase() [1/2]

◆ FFrEntryBase() [2/2]

◆ ~FFrEntryBase()

Member Function Documentation

◆ compare()

◆ equal()

◆ getBaseID()

◆ getDataFields()

◆ getDescription()

◆ getEntryDescription()

◆ getOwner()

◆ getType()

◆ getUserID()

◆ hasBaseID()

◆ hasDataFields()

◆ hasDescription()

◆ hasUserID()

◆ isEmpty()

◆ isGlobal()

◆ isIG()

◆ isOG()

◆ isSOG()

◆ isVariableFloat()

◆ isVarRef()

◆ less()

◆ merge()

◆ operator=()

◆ printPosition()

◆ readPositionedTimestepData()

◆ recursiveReadPosData() [1/3]

◆ recursiveReadPosData() [2/3]

◆ recursiveReadPosData() [3/3]

◆ removeContainers()

◆ setGlobal()

◆ setOwner()

◆ traverse()

Member Data Documentation

◆ myGlobal

◆ myOwner