DtRollUpManager Class Reference

Inheritance diagram for DtRollUpManager:

Public Types
typedef boost::function< void(const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &, const std::set< DtString > &validElements)>	RollUpFunction

Public Member Functions
	DtRollUpManager (makVrv::DtDe &)
	default constructor
virtual	~DtRollUpManager ()
virtual bool	loadDataFiles (const DtFilename &)
virtual bool	loadAdditionalDataFiles (const DtFilename &)
	Additional data files are read-only but can be used for key mapping.
virtual std::map< std::string, std::string >	ammunition () const
virtual std::map< std::string, std::string >	equipment () const
virtual std::map< std::string, std::string >	variables () const
virtual std::map< std::string, std::string >	weapons () const
virtual std::map< std::string, std::string >	assemblies () const
virtual std::map< std::string, std::string >	combinedAmmunition () const
	Combined of additional data and this data.
virtual std::map< std::string, std::string >	combinedEquipment () const
virtual std::map< std::string, std::string >	combinedWeapons () const
virtual std::map< std::string, std::string >	combinedAssemblies () const
virtual std::map< std::string, std::string >	combinedVariables () const
const DtAssembliesReaderWriter &	assembliesReaderWriter () const
DtAssembliesReaderWriter &	assembliesReaderWriter ()
DtRollUpManager *	additionalData ()
const DtRollUpManager *	additionalData () const
const DtRwKeywordValuePairsReader &	keywordValuePairs () const
virtual void	rollUpAndReselect (const std::vector< DtObjectType > &)
	Rolls up the given object types and then reselects them for updated value display.
virtual void	rollUp (std::vector< DtObjectType >, bool reselect=false)
	Rolls up objects and reselects if flag is true.
virtual void	rollUp (const DtObjectType &)
	Roll up given object and place the results in the modified entry of parameter-data.
virtual std::set< DtString >	resetRollUpVariables (const DtObjectType &, const DtRwPropertiesMap *assemblies)
	Resets all the variables that could potentiall be rolled up.
virtual void	resetRollUpVariables (const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &, std::set< DtString > &)
virtual void	resetRollUpVariable (const DtObjectType &, const std::string &, std::set< DtString > &)
	Resets the roll up variable of the given name.
virtual void	addMappedElementsFromAssembly (const DtObjectType &, DtRwPropertiesMap *, int, const DtAssembliesReaderWriter::RwRootNode &)
	Adds the elements from the supplied values into the given map by keyword and any values that might be present.
virtual void	addSystemsFromAssembly (const DtObjectType &, int, const DtAssembliesReaderWriter::RwRootNode &)
	Adds all the systems found in the assembly into the modified systems for the given object.
virtual void	addSystem (const DtObjectType &, const DtFilename &systemFilename, const DtComponentSystemDefinition *, int, const DtAssembliesReaderWriter::RwRootNode &)
virtual void	addRollUpFunction (const std::string &function, RollUpFunction)
	Adds a function that will be used to execute a roll up type.
virtual const std::set < DtString > &	availableVariables ()
	Returns the list of variables that are available (from all platform files) to include in roll-up.
virtual const std::set < DtString > &	availableSystems ()
	Returns the list of systems that are available (from all platform files) to include in roll-up.
virtual void	resetSystems (const DtObjectType &)
	Resets all systems that were added by roll-up by removing them.
virtual void	rollUpAll ()
	Iterates over all entities and any entities that have assemblies, rolls them up.
virtual bool	hasRollUpItems () const
	Returns true if there are any items to roll up.
virtual void	clear ()
	Clears data.
virtual void	combinedRollUpRules (DtAssembliesReaderWriter::RwRootNode &) const
	Returns roll up rules that are combined of the current rules and the additional data. Current rules will override additional data.
virtual DtAssembliesReaderWriter::RwRootNode *	rootNodeFor (const std::string &) const
	Returns the root node in our data or additional data.
virtual DtAssembliesReaderWriter::RwRootNode *	rootNodeFor (const std::string &type, const std::string &) const
virtual DtAssembliesReaderWriter::RwRootNode *	rootNodeFor (const DtAssembliesReaderWriter &, const std::string &type, const std::string &) const
virtual DtAssembliesReaderWriter::RwRootNode *	assemblyNodeFor (const std::string &) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtRollUpManager &	instance (makVrv::DtDe &)
	Instance of this class if not registered.
static void	registerInstance (makVrv::DtDe &, DtRollUpManager *)
	Registers a new instance of the creator.

Protected Types
typedef boost::function< void(double, double, DtReaderWriter *)>	CollectionFunction
typedef std::map< std::string, RollUpFunction >	RollUpFunctions

Protected Member Functions
virtual void	collect (const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &itemsToCollect, const std::set< DtString > &validElements)
virtual void	sum (double count, double value, DtReaderWriter *)
virtual void	sumFunction (const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &itemsToSum, const std::set< DtString > &validElements)
virtual void	minimum (double count, double value, DtReaderWriter *)
virtual void	minimumFunction (const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &itemsToSum, const std::set< DtString > &validElements)
virtual void	maximum (double count, double value, DtReaderWriter *)
virtual void	maximumFunction (const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &itemsToSum, const std::set< DtString > &validElements)
virtual void	averageFunction (const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &itemsToSum, const std::set< DtString > &validElements)
virtual void	calculateAverage (const DtRwPropertiesMap *, const DtObjectType &, const std::string &propertyToAverage, const DtAssembliesReaderWriter::RwRootNode &itemsToSum, const std::set< DtString > &validElements)
virtual void	singleValueRollUp (const DtRwPropertiesMap *, const DtObjectType &, const DtAssembliesReaderWriter::RwRootNode &, const std::set< DtString > &validElements, CollectionFunction func)
virtual void	extractVariables (DtReaderWriter *, std::set< DtString > &vars) const
virtual std::string	valueForVariable (const DtAssembliesReaderWriter::RwRootNode &variables, const std::string &keyword) const
virtual std::map< std::string, std::string >	combine (const std::map< std::string, std::string > &base, const std::map< std::string, std::string > &takeFrom) const

Protected Attributes
makVrv::DtDe &	myDe
DtAssembliesReaderWriter	myAssembliesReaderWriter
RollUpFunctions	myRollUpFunctions
bool	myNeedsAvailableVariablesCheck
std::set< DtString >	myAvailableVariables
std::set< DtString >	myAvailableSystems
DtRollUpManager *	myAdditionalData
DtRwKeywordValuePairsReader	myKeywordValuePairsReaderWriter

Private Member Functions
	DtRollUpManager (const DtRollUpManager &)
DtRollUpManager &	operator= (const DtRollUpManager &)

Member Typedef Documentation

typedef boost::function<void (const DtRwPropertiesMap*, const DtObjectType&, const DtAssembliesReaderWriter::RwRootNode&, const std::set<DtString>& validElements)> DtRollUpManager::RollUpFunction

typedef boost::function<void (double, double, DtReaderWriter*)> DtRollUpManager::CollectionFunction

protected

typedef std::map<std::string, RollUpFunction> DtRollUpManager::RollUpFunctions

protected

Constructor & Destructor Documentation

DtRollUpManager::DtRollUpManager

(

makVrv::DtDe &

)

default constructor

virtual DtRollUpManager::~DtRollUpManager ( )

virtual

DtRollUpManager::DtRollUpManager ( const DtRollUpManager &  )

private

Member Function Documentation

virtual bool DtRollUpManager::loadDataFiles ( const DtFilename &  )

virtual

virtual bool DtRollUpManager::loadAdditionalDataFiles ( const DtFilename &  )

virtual

Additional data files are read-only but can be used for key mapping.

static DtRollUpManager& DtRollUpManager::instance ( makVrv::DtDe &  )

static

Instance of this class if not registered.

static void DtRollUpManager::registerInstance ( makVrv::DtDe &  , DtRollUpManager *    )

static

Registers a new instance of the creator.

virtual std::map<std::string, std::string> DtRollUpManager::ammunition ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::equipment ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::variables ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::weapons ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::assemblies ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::combinedAmmunition ( ) const

virtual

Combined of additional data and this data.

virtual std::map<std::string, std::string> DtRollUpManager::combinedEquipment ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::combinedWeapons ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::combinedAssemblies ( ) const

virtual

virtual std::map<std::string, std::string> DtRollUpManager::combinedVariables ( ) const

virtual

const DtAssembliesReaderWriter& DtRollUpManager::assembliesReaderWriter ( ) const

inline

DtAssembliesReaderWriter& DtRollUpManager::assembliesReaderWriter ( )

inline

DtRollUpManager* DtRollUpManager::additionalData ( )

inline

const DtRollUpManager* DtRollUpManager::additionalData ( ) const

inline

const DtRwKeywordValuePairsReader& DtRollUpManager::keywordValuePairs ( ) const

inline

virtual void DtRollUpManager::rollUpAndReselect ( const std::vector< DtObjectType > &  )

virtual

Rolls up the given object types and then reselects them for updated value display.

Will set to the de's post tick to kick off the roll up

virtual void DtRollUpManager::rollUp ( std::vector< DtObjectType >  , bool  reselect = false  )

virtual

Rolls up objects and reselects if flag is true.

virtual void DtRollUpManager::rollUp ( const DtObjectType &  )

virtual

Roll up given object and place the results in the modified entry of parameter-data.

virtual std::set<DtString> DtRollUpManager::resetRollUpVariables ( const DtObjectType &  , const DtRwPropertiesMap *  assemblies  )

virtual

Resets all the variables that could potentiall be rolled up.

virtual void DtRollUpManager::resetRollUpVariables ( const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  , std::set< DtString > &    )

virtual

virtual void DtRollUpManager::resetRollUpVariable ( const DtObjectType &  , const std::string &  , std::set< DtString > &    )

virtual

Resets the roll up variable of the given name.

If there is a . (period) in the name will iterate over the elements to find the root item

virtual void DtRollUpManager::addMappedElementsFromAssembly ( const DtObjectType &  , DtRwPropertiesMap *  , int  , const DtAssembliesReaderWriter::RwRootNode &    )

virtual

Adds the elements from the supplied values into the given map by keyword and any values that might be present.

Will take into account the count of the number of assembly items and the count supplied by the assembled item

virtual void DtRollUpManager::addSystemsFromAssembly ( const DtObjectType &  , int  , const DtAssembliesReaderWriter::RwRootNode &    )

virtual

Adds all the systems found in the assembly into the modified systems for the given object.

virtual void DtRollUpManager::addSystem ( const DtObjectType &  , const DtFilename &  systemFilename, const DtComponentSystemDefinition *  , int  , const DtAssembliesReaderWriter::RwRootNode &    )

virtual

virtual void DtRollUpManager::addRollUpFunction ( const std::string &  function, RollUpFunction    )

virtual

Adds a function that will be used to execute a roll up type.

virtual const std::set<DtString>& DtRollUpManager::availableVariables ( )

virtual

Returns the list of variables that are available (from all platform files) to include in roll-up.

virtual const std::set<DtString>& DtRollUpManager::availableSystems ( )

virtual

Returns the list of systems that are available (from all platform files) to include in roll-up.

virtual void DtRollUpManager::resetSystems ( const DtObjectType &  )

virtual

Resets all systems that were added by roll-up by removing them.

virtual void DtRollUpManager::rollUpAll ( )

virtual

Iterates over all entities and any entities that have assemblies, rolls them up.

virtual bool DtRollUpManager::hasRollUpItems ( ) const

virtual

Returns true if there are any items to roll up.

virtual void DtRollUpManager::clear ( )

virtual

Clears data.

virtual void DtRollUpManager::combinedRollUpRules ( DtAssembliesReaderWriter::RwRootNode &  ) const

virtual

Returns roll up rules that are combined of the current rules and the additional data. Current rules will override additional data.

virtual DtAssembliesReaderWriter::RwRootNode* DtRollUpManager::rootNodeFor ( const std::string &  ) const

virtual

Returns the root node in our data or additional data.

virtual DtAssembliesReaderWriter::RwRootNode* DtRollUpManager::rootNodeFor ( const std::string &  type, const std::string &    ) const

virtual

virtual DtAssembliesReaderWriter::RwRootNode* DtRollUpManager::rootNodeFor ( const DtAssembliesReaderWriter &  , const std::string &  type, const std::string &    ) const

virtual

virtual DtAssembliesReaderWriter::RwRootNode* DtRollUpManager::assemblyNodeFor ( const std::string &  ) const

virtual

virtual void DtRollUpManager::collect ( const DtRwPropertiesMap *  , const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  itemsToCollect, const std::set< DtString > &  validElements  )

protectedvirtual

virtual void DtRollUpManager::sum ( double  count, double  value, DtReaderWriter *    )

protectedvirtual

virtual void DtRollUpManager::sumFunction ( const DtRwPropertiesMap *  , const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  itemsToSum, const std::set< DtString > &  validElements  )

protectedvirtual

virtual void DtRollUpManager::minimum ( double  count, double  value, DtReaderWriter *    )

protectedvirtual

virtual void DtRollUpManager::minimumFunction ( const DtRwPropertiesMap *  , const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  itemsToSum, const std::set< DtString > &  validElements  )

protectedvirtual

virtual void DtRollUpManager::maximum ( double  count, double  value, DtReaderWriter *    )

protectedvirtual

virtual void DtRollUpManager::maximumFunction ( const DtRwPropertiesMap *  , const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  itemsToSum, const std::set< DtString > &  validElements  )

protectedvirtual

virtual void DtRollUpManager::averageFunction ( const DtRwPropertiesMap *  , const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  itemsToSum, const std::set< DtString > &  validElements  )

protectedvirtual

virtual void DtRollUpManager::calculateAverage ( const DtRwPropertiesMap *  , const DtObjectType &  , const std::string &  propertyToAverage, const DtAssembliesReaderWriter::RwRootNode &  itemsToSum, const std::set< DtString > &  validElements  )

protectedvirtual

virtual void DtRollUpManager::singleValueRollUp ( const DtRwPropertiesMap *  , const DtObjectType &  , const DtAssembliesReaderWriter::RwRootNode &  , const std::set< DtString > &  validElements, CollectionFunction  func  )

protectedvirtual

virtual void DtRollUpManager::extractVariables ( DtReaderWriter *  , std::set< DtString > &  vars  ) const

protectedvirtual

virtual std::string DtRollUpManager::valueForVariable ( const DtAssembliesReaderWriter::RwRootNode &  variables, const std::string &  keyword  ) const

protectedvirtual

virtual std::map<std::string, std::string> DtRollUpManager::combine ( const std::map< std::string, std::string > &  base, const std::map< std::string, std::string > &  takeFrom  ) const

protectedvirtual

DtRollUpManager& DtRollUpManager::operator= ( const DtRollUpManager &  )

private

Member Data Documentation

makVrv::DtDe& DtRollUpManager::myDe

protected

DtAssembliesReaderWriter DtRollUpManager::myAssembliesReaderWriter

protected

RollUpFunctions DtRollUpManager::myRollUpFunctions

protected

bool DtRollUpManager::myNeedsAvailableVariablesCheck

protected

std::set<DtString> DtRollUpManager::myAvailableVariables

protected

std::set<DtString> DtRollUpManager::myAvailableSystems

protected

DtRollUpManager* DtRollUpManager::myAdditionalData

protected

DtRwKeywordValuePairsReader DtRollUpManager::myKeywordValuePairsReaderWriter

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/entityEditorImpl/rollUpManager.h