DtFomSorter Class Reference

This is a class that sorts a user's FOM modules based on their dependencies, given that the FOM modules have been added in an arbitrary order. More...

Collaboration diagram for DtFomSorter:

Public Member Functions
virtual int	mapFomDepComplexity (const DtFomDepsPair &fedTarget)
	Takes a std::pair of a FOM name and its dependencies, figures out the "complexity" of the FOM (the longest chain of dependencies created from its list of associated dependencies), and maps this both ways to myComplexToFomsMMap and myFomToComplexMap.
virtual void	sortFomFileNames (std::vector< DtString > *fomFileNames)
	Sorts the list of FOM file names once FOM complexities have been mapped.
virtual void	insertFileToFomDepsPairMap (const DtString &key, const DtFomDepsPair &value)
	Wrapper for std::map::insert for myFileToDepsPairMap.
virtual void	insertFomToFileMap (const DtString &key, const DtString &value)
	Wrapper for std::map::insert for myFomToFileMap.
virtual const DtFomDepsPair &	atFileToFomDepsPairMap (const DtString &key)
	Wrapper for std::map::at for myFileToDepsPairMap.
virtual std::vector< DtString > &	allDependencies ()
	Returns list of all dependencies from FOMs.
virtual std::vector< DtString > &	allFomNames ()
	Returns list of all dependencies from FOMs.
virtual bool	isEachDependencyValid ()
	Returns true if all dependencies are valid.
virtual const DtFileToDepsPairMap &	fileToFomDepsPairMap ()
	Returns const reference to myFileToDepsPairMap.
virtual int	atFomToComplexMap (DtString &key)
	Wrapper for std::map::at for myFomToComplexMap.
virtual const DtFomToComplexMap &	fomToComplexMap ()
	Returns const reference to myFomToComplexMap.
virtual DtString	atFomToFileMap (DtString &key)
	Wrapper for std::map::at for myFomToFileMap.
virtual const DtFomToFileMap &	fomToFileMap ()
	Returns const reference to myFomToFileMap.

Static Public Member Functions
static DtFomSorter *	create ()

Protected Attributes
DtComplexToFomsMMap	myComplexToFomsMMap
DtFomToComplexMap	myFomToComplexMap
DtFileToDepsPairMap	myFileToDepsPairMap
DtFomToFileMap	myFomToFileMap
std::vector< DtString >	myAllDependencies
std::vector< DtString >	myAllFomNames

Detailed Description

This is a class that sorts a user's FOM modules based on their dependencies, given that the FOM modules have been added in an arbitrary order.

This only sorts a list of file names and does not actually perform any file merging.

Member Function Documentation

virtual std::vector<DtString>& DtFomSorter::allDependencies ( )

virtual

Returns list of all dependencies from FOMs.

virtual std::vector<DtString>& DtFomSorter::allFomNames ( )

virtual

Returns list of all dependencies from FOMs.

virtual const DtFomDepsPair& DtFomSorter::atFileToFomDepsPairMap ( const DtString &  key )

virtual

Wrapper for std::map::at for myFileToDepsPairMap.

virtual int DtFomSorter::atFomToComplexMap ( DtString &  key )

virtual

Wrapper for std::map::at for myFomToComplexMap.

virtual DtString DtFomSorter::atFomToFileMap ( DtString &  key )

virtual

Wrapper for std::map::at for myFomToFileMap.

static DtFomSorter* DtFomSorter::create ( )

static

virtual const DtFileToDepsPairMap& DtFomSorter::fileToFomDepsPairMap ( )

virtual

Returns const reference to myFileToDepsPairMap.

virtual const DtFomToComplexMap& DtFomSorter::fomToComplexMap ( )

virtual

Returns const reference to myFomToComplexMap.

virtual const DtFomToFileMap& DtFomSorter::fomToFileMap ( )

virtual

Returns const reference to myFomToFileMap.

virtual void DtFomSorter::insertFileToFomDepsPairMap ( const DtString &  key, const DtFomDepsPair &  value  )

virtual

Wrapper for std::map::insert for myFileToDepsPairMap.

virtual void DtFomSorter::insertFomToFileMap ( const DtString &  key, const DtString &  value  )

virtual

Wrapper for std::map::insert for myFomToFileMap.

virtual bool DtFomSorter::isEachDependencyValid ( )

virtual

Returns true if all dependencies are valid.

virtual int DtFomSorter::mapFomDepComplexity ( const DtFomDepsPair &  fedTarget )

virtual

Takes a std::pair of a FOM name and its dependencies, figures out the "complexity" of the FOM (the longest chain of dependencies created from its list of associated dependencies), and maps this both ways to myComplexToFomsMMap and myFomToComplexMap.

virtual void DtFomSorter::sortFomFileNames ( std::vector< DtString > *  fomFileNames )

virtual

Sorts the list of FOM file names once FOM complexities have been mapped.

Member Data Documentation

std::vector<DtString> DtFomSorter::myAllDependencies

protected

std::vector<DtString> DtFomSorter::myAllFomNames

protected

DtComplexToFomsMMap DtFomSorter::myComplexToFomsMMap

protected

DtFileToDepsPairMap DtFomSorter::myFileToDepsPairMap

protected

DtFomToComplexMap DtFomSorter::myFomToComplexMap

protected

DtFomToFileMap DtFomSorter::myFomToFileMap

protected

---

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

• fomSorter.h