sparta::statistics::StatisticsHierRootNodes< StorageT > Class Template Reference

Utility class that holds onto statistics node hierarchies, accessible by a name that you choose. More...

#include <StatisticsHierRootNodes.hpp>

Public Member Functions
void	addHierarchyRoot (const std::string &storage_name, std::shared_ptr< StorageT > &root)
	Append a statistics hierarchy root node to this set.
std::vector< std::string >	getRootNames () const
	Access the root node names in this set.
void	mapRootNameToReportFilename (const std::string &root_name, const std::string &report_filename) const
StorageT *	getRootByName (const std::string &root_name)

Detailed Description

template<class StorageT>
class sparta::statistics::StatisticsHierRootNodes< StorageT >

Utility class that holds onto statistics node hierarchies, accessible by a name that you choose.

Definition at line 18 of file StatisticsHierRootNodes.hpp.

Constructor & Destructor Documentation

~StatisticsHierRootNodes()

template<class StorageT >

virtual sparta::statistics::StatisticsHierRootNodes< StorageT >::~StatisticsHierRootNodes ( )

inlinevirtual

Definition at line 21 of file StatisticsHierRootNodes.hpp.

Member Function Documentation

addHierarchyRoot()

template<class StorageT >

void sparta::statistics::StatisticsHierRootNodes< StorageT >::addHierarchyRoot ( const std::string &  storage_name, std::shared_ptr< StorageT > &  root  )

inline

Append a statistics hierarchy root node to this set.

Definition at line 24 of file StatisticsHierRootNodes.hpp.

getRootByName()

template<class StorageT >

StorageT * sparta::statistics::StatisticsHierRootNodes< StorageT >::getRootByName ( const std::string &  root_name )

inline

Ask for a hierarchy root node by name. The name should be one that you originally gave to addHierarchyRoot(), or this method will return null.

Definition at line 59 of file StatisticsHierRootNodes.hpp.

Here is the call graph for this function:

getRootNames()

template<class StorageT >

std::vector< std::string > sparta::statistics::StatisticsHierRootNodes< StorageT >::getRootNames ( ) const

inline

Access the root node names in this set.

Definition at line 36 of file StatisticsHierRootNodes.hpp.

mapRootNameToReportFilename()

template<class StorageT >

void sparta::statistics::StatisticsHierRootNodes< StorageT >::mapRootNameToReportFilename ( const std::string &  root_name, const std::string &  report_filename  ) const

inline

Maintain a mapping from report filenames like 'out.csv' to the equivalent root name like 'out_csv'. This is to support tab completion for Python shell users (Python won't allow dots in node names).

Definition at line 50 of file StatisticsHierRootNodes.hpp.

---

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

• /github/workspace/sparta/sparta/statistics/dispatch/StatisticsHierRootNodes.hpp