This class contains helper functions and methods that can be used to roll up property data based on the true aggregate state property structure. More...

Classes
struct	AverageItem

Public Types
typedef std::map< std::string, DtRollUpFunction >	RollUpRules

Public Member Functions
	DtTrueAggregateRollUpHelper ()

virtual	~DtTrueAggregateRollUpHelper ()

virtual void	installCustomRules ()
	Call to install custom roll up rules needed to roll up aggregate information. More...

virtual void	rollUp (const std::vector< DtRwProperties * > &, DtRwProperties &result, const std::set< DtString > &ignore=std::set< DtString >()) const
	Rolls up the given properties and returns the single rolled up result. More...

virtual void	setRollUpRules (const DtAssembliesReaderWriter::RwRootNode &)
	Sets roll up rules that are read from the rollUpRules.mtl file. More...

virtual bool	loadRollUpRules (const DtFilename &)
	Loads roll up rules from the given file. More...

virtual void	updateAverages (DtRwProperties &, int totalContributors) const

virtual void	restore ()
	Call this to restore backed up values due to override by installing custom rules and general construction of this object. More...


virtual void	addRollUpFunction (const std::string &, DtRollUpFunction)

const RollUpRules &	rollUpRules () const

RollUpRules &	rollUpRules ()

virtual bool	sumFunction (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path, const std::map< std::string, std::string > &)

virtual bool	minimumFunction (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path, const std::map< std::string, std::string > &)

virtual bool	maximumFunction (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path, const std::map< std::string, std::string > &)

virtual bool	averageFunction (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path, const std::map< std::string, std::string > &)

virtual bool	moppLevelFunction (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path, const std::map< std::string, std::string > &)

virtual bool	stringFunction (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path)

Protected Types
typedef std::map< std::string, AverageItem >	AverageItems

Protected Member Functions
virtual bool	rollUpValues (const DtReaderWriter source, DtReaderWriter destination, const DtMergePath &path)
	Will use the roll up rules as defined in the additional scenario data to roll up values. More...

virtual double	averageContributionFrom (const DtReaderWriter *item, const DtMergePath &path, const std::map< std::string, std::string > &atr) const

Protected Attributes
RollUpRules	myRollUpRules

DtPropertyRollUpFunction	myOriginalDefaultRule

DtReaderWriterPropertyFactory::RollUpRules	myOriginalRollUpRules

AverageItems	myAverageItems

std::set< DtString >	myAverageTotals

DtAssembliesReaderWriter	myAssemblyReaderWriter

Detailed Description

This class contains helper functions and methods that can be used to roll up property data based on the true aggregate state property structure.

Member Typedef Documentation

typedef std::map<std::string, DtRollUpFunction> DtTrueAggregateRollUpHelper::RollUpRules

typedef std::map<std::string, AverageItem> DtTrueAggregateRollUpHelper::AverageItems

protected

Constructor & Destructor Documentation

DtTrueAggregateRollUpHelper::DtTrueAggregateRollUpHelper ( )

virtual DtTrueAggregateRollUpHelper::~DtTrueAggregateRollUpHelper ( )

virtual

Member Function Documentation

virtual void DtTrueAggregateRollUpHelper::installCustomRules ( )

virtual

Call to install custom roll up rules needed to roll up aggregate information.

virtual void DtTrueAggregateRollUpHelper::addRollUpFunction	(	const std::string &	,
		DtRollUpFunction
	)

virtual

Roll up rule functions

const RollUpRules& DtTrueAggregateRollUpHelper::rollUpRules ( ) const

inline

RollUpRules& DtTrueAggregateRollUpHelper::rollUpRules ( )

inline

virtual bool DtTrueAggregateRollUpHelper::sumFunction	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path,
		const std::map< std::string, std::string > &
	)

virtual

virtual bool DtTrueAggregateRollUpHelper::minimumFunction	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path,
		const std::map< std::string, std::string > &
	)

virtual

virtual bool DtTrueAggregateRollUpHelper::maximumFunction	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path,
		const std::map< std::string, std::string > &
	)

virtual

virtual bool DtTrueAggregateRollUpHelper::averageFunction	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path,
		const std::map< std::string, std::string > &
	)

virtual

virtual bool DtTrueAggregateRollUpHelper::moppLevelFunction	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path,
		const std::map< std::string, std::string > &
	)

virtual

virtual bool DtTrueAggregateRollUpHelper::stringFunction	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path
	)

virtual

virtual void DtTrueAggregateRollUpHelper::rollUp	(	const std::vector< DtRwProperties * > &	,
		DtRwProperties &	result,
		const std::set< DtString > &	ignore = `std::set< DtString >()`
	)		const

virtual

Rolls up the given properties and returns the single rolled up result.

virtual void DtTrueAggregateRollUpHelper::setRollUpRules ( const DtAssembliesReaderWriter::RwRootNode & )

virtual

Sets roll up rules that are read from the rollUpRules.mtl file.

virtual bool DtTrueAggregateRollUpHelper::loadRollUpRules ( const DtFilename & )

virtual

Loads roll up rules from the given file.

virtual void DtTrueAggregateRollUpHelper::updateAverages	(	DtRwProperties &	,
		int	totalContributors
	)		const

virtual

virtual void DtTrueAggregateRollUpHelper::restore ( )

virtual

Call this to restore backed up values due to override by installing custom rules and general construction of this object.

Only call this if you are expecting to no longer use the true aggregate roll up rules

virtual bool DtTrueAggregateRollUpHelper::rollUpValues	(	const DtReaderWriter *	source,
		DtReaderWriter *	destination,
		const DtMergePath &	path
	)

protectedvirtual

Will use the roll up rules as defined in the additional scenario data to roll up values.

virtual double DtTrueAggregateRollUpHelper::averageContributionFrom	(	const DtReaderWriter *	item,
		const DtMergePath &	path,
		const std::map< std::string, std::string > &	atr
	)		const

protectedvirtual

Member Data Documentation

RollUpRules DtTrueAggregateRollUpHelper::myRollUpRules

protected

DtPropertyRollUpFunction DtTrueAggregateRollUpHelper::myOriginalDefaultRule

protected

DtReaderWriterPropertyFactory::RollUpRules DtTrueAggregateRollUpHelper::myOriginalRollUpRules

protected

AverageItems DtTrueAggregateRollUpHelper::myAverageItems

mutableprotected

std::set<DtString> DtTrueAggregateRollUpHelper::myAverageTotals

mutableprotected

DtAssembliesReaderWriter DtTrueAggregateRollUpHelper::myAssemblyReaderWriter

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfutil/trueAggregateRollUpHelper.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation