DataFlowVisualization Class Reference

class to visualize data flow between modules. More...

#include <DataFlowVisualization.h>

Collaboration diagram for DataFlowVisualization:

Public Member Functions
	DataFlowVisualization (const DependencyMap *dependencyMap)
	Constructor.
void	visualizePath (const std::string &filename, const Path &path)
	Create graphs with datastore inputs/outputs of each module in path. More...

Static Public Member Functions
static void	executeModuleAndCreateIOPlot (const std::string &module)
	Create independent I/O graph for a single module (without requiring a steering file). More...

Private Member Functions
void	generateModulePlot (std::ofstream &file, const Module &mod, bool steeringFileFlow=false)
	Create I/O graph for a single module (written to file).
bool	checkArrayUnknown (const std::string &name, const DependencyMap::ModuleInfo &info)
	If the given array name isn't found in any of info's fields, it is added to m_unknownArrays (and true returned).

Static Private Member Functions
static void	plotPath (std::ofstream &file, const Path &path, const std::string &pathName="")
	Create a subgraph for the given Path (including conditional paths).

Private Attributes
const DependencyMap *	m_map
	Stores information on inputs/outputs of each module, as obtained by require()/createEntry();.
std::set< std::string >	m_allInputs
	set of all inputs (including optionals), for steering file visualisation.
std::set< std::string >	m_allOutputs
	set of all outputs, for steering file visualisation.
std::set< std::string >	m_unknownArrays
	set of array only being used in relations, for steering file visualisation.
std::string	m_fillcolor [DependencyMap::c_NEntryTypes]
	fill colors.
std::string	m_arrowcolor [DependencyMap::c_NEntryTypes]
	arrow colors.

Detailed Description

class to visualize data flow between modules.

Definition at line 34 of file DataFlowVisualization.h.

Member Function Documentation

executeModuleAndCreateIOPlot()

void executeModuleAndCreateIOPlot ( const std::string &  module )

static

Create independent I/O graph for a single module (without requiring a steering file).

Output will be saved to ModuleName.dot.

Definition at line 167 of file DataFlowVisualization.cc.

{
  // construct given module and gearbox
  std::shared_ptr<Module> modulePtr = ModuleManager::Instance().registerModule(module);
  std::shared_ptr<Module> gearboxPtr = ModuleManager::Instance().registerModule("Gearbox");
 
  // call initialize() method
  //may throw some ERRORs, but that's OK.
  // TODO:(ignore missing inputs)
  gearboxPtr->initialize();
  DataStore::Instance().getDependencyMap().setModule(*modulePtr);
  modulePtr->initialize();
 
  // create plot
  const std::string filename = module + ".dot";
  DataFlowVisualization v(&DataStore::Instance().getDependencyMap());
  std::ofstream file(filename.c_str());
  v.generateModulePlot(file, *modulePtr, false);
 
  //clean up to avoid problems with ~TROOT
  modulePtr->terminate();
  gearboxPtr->terminate();
}

visualizePath()

void visualizePath	(	const std::string &	filename,
		const Path &	path
	)

Create graphs with datastore inputs/outputs of each module in path.

Parameters

filename	file saved to (in DOT format).
path	Path to visualize.

Definition at line 40 of file DataFlowVisualization.cc.

---

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

• framework/core/include/DataFlowVisualization.h
• framework/core/src/DataFlowVisualization.cc