#include <FFrVariableReference.H>

Inheritance diagram for FFrVariableReference:

Collaboration diagram for FFrVariableReference:

Public Types
typedef std::pair< FFrResultContainer *, size_t >	FFrResultContainerRef

Public Member Functions
	FFrVariableReference (FFrVariable *var)

virtual	~FFrVariableReference ()

virtual const std::string &	getDescription () const

virtual const std::string &	getType () const

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

virtual bool	isVarRef () const

virtual bool	isEmpty () const
	Returns true if this entry and all below it are empty. More...

FFaOperationBase *	getReadOperation ()

unsigned int	getTimeStamp () const
	Returns the (most recent) time stamp of this variable. More...

double	getDistanceFromResultPoint (const bool usePositionedKey=false) const

bool	hasDataForCurrentKey (const bool usePositionedKey=false) const

void	getValidKeys (std::set< double > &validValues) const

virtual void	printPosition (std::ostream &os) const
	Prints out the positioning data of this variable. More...

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

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

virtual bool	merge (FFrEntryBase *obj)

virtual bool	compare (const FFrEntryBase *obj) const

virtual bool	equal (const FFrEntryBase *obj) const

virtual bool	less (const FFrEntryBase *obj) const

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 bool	hasDescription () 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 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...

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

Public Attributes
union {
FFrVariable * variableDescr

FFrVariableReference * next

};

std::vector< FFrResultContainerRef >	containers

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

Private Member Functions
int	getNearestContainer () const
	Returns the index of the nearest container for the current setting. More...

Member Typedef Documentation

◆ FFrResultContainerRef

typedef std::pair<FFrResultContainer*,size_t> FFrVariableReference::FFrResultContainerRef

Constructor & Destructor Documentation

◆ FFrVariableReference()

FFrVariableReference::FFrVariableReference ( FFrVariable * var )

inline

◆ ~FFrVariableReference()

virtual FFrVariableReference::~FFrVariableReference ( )

inlinevirtual

Member Function Documentation

◆ compare()

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

inlinevirtual

Reimplemented from FFrEntryBase.

◆ equal()

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

virtual

Implements FFrEntryBase.

◆ getDescription()

const std::string & FFrVariableReference::getDescription ( ) const

virtual

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

Implements FFrEntryBase.

◆ getDistanceFromResultPoint()

double FFrVariableReference::getDistanceFromResultPoint ( const bool usePositionedKey = false ) const

◆ getNearestContainer()

int FFrVariableReference::getNearestContainer ( ) const

private

Returns the index of the nearest container for the current setting.

Returns -1 if no containers are found.

◆ getReadOperation()

FFaOperationBase * FFrVariableReference::getReadOperation ( )

◆ getTimeStamp()

unsigned int FFrVariableReference::getTimeStamp ( ) const

Returns the (most recent) time stamp of this variable.

◆ getType()

const std::string & FFrVariableReference::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.

◆ getValidKeys()

void FFrVariableReference::getValidKeys ( std::set< double > & validValues ) const

◆ hasDataForCurrentKey()

bool FFrVariableReference::hasDataForCurrentKey ( const bool usePositionedKey = false ) const

◆ isEmpty()

virtual bool FFrVariableReference::isEmpty ( ) const

inlinevirtual

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

Implements FFrEntryBase.

◆ isVariableFloat()

bool FFrVariableReference::isVariableFloat ( ) const

virtual

Returns true if the first variable referred is a float.

Implements FFrEntryBase.

◆ isVarRef()

virtual bool FFrVariableReference::isVarRef ( ) const

inlinevirtual

Reimplemented from FFrEntryBase.

◆ less()

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

virtual

Implements FFrEntryBase.

◆ merge()

bool FFrVariableReference::merge ( FFrEntryBase * obj )

virtual

Implements FFrEntryBase.

◆ printPosition()

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

virtual

Prints out the positioning data of this variable.

Implements FFrEntryBase.

◆ recursiveReadPosData() [1/3]

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

protectedvirtual

Implements FFrEntryBase.

◆ recursiveReadPosData() [2/3]

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

protectedvirtual

Implements FFrEntryBase.

◆ recursiveReadPosData() [3/3]

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

protectedvirtual

Implements FFrEntryBase.

◆ removeContainers()

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

virtual

Implements FFrEntryBase.

◆ traverse()

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

virtual

Traverses to build owner hierarchy and calculate binary sizes.

Reimplemented from FFrEntryBase.

Member Data Documentation

◆

union { ... }

◆ containers

std::vector<FFrResultContainerRef> FFrVariableReference::containers

◆ next

FFrVariableReference* FFrVariableReference::next

◆ variableDescr

FFrVariable* FFrVariableReference::variableDescr

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Member Typedef Documentation

◆ FFrResultContainerRef

Constructor & Destructor Documentation

◆ FFrVariableReference()

◆ ~FFrVariableReference()

Member Function Documentation

◆ compare()

◆ equal()

◆ getDescription()

◆ getDistanceFromResultPoint()

◆ getNearestContainer()

◆ getReadOperation()

◆ getTimeStamp()

◆ getType()

◆ getValidKeys()

◆ hasDataForCurrentKey()

◆ isEmpty()

◆ isVariableFloat()

◆ isVarRef()

◆ less()

◆ merge()

◆ printPosition()

◆ recursiveReadPosData() [1/3]

◆ recursiveReadPosData() [2/3]

◆ recursiveReadPosData() [3/3]

◆ removeContainers()

◆ traverse()

Member Data Documentation

◆

◆ containers

◆ next

◆ variableDescr