Printer to produce a dot representation of the current state of the graph. More...

#include "dot_printer.h"

Inheritance diagram for hh::DotPrinter:

Collaboration diagram for hh::DotPrinter:

Public Member Functions
	DotPrinter (std::filesystem::path const &dotFilePath, ColorScheme colorScheme, StructureOptions structureOptions, DebugOptions debugOptions, core::CoreNode *graph)
	DotPrinter constructor, opens the file for writing. More...

	~DotPrinter () override
	Destructor, close the file.

void	printNodeInformation (core::CoreNode *node) final
	Print node main information. More...

void	printGraphHeader (core::CoreNode const *node) final
	Print header for the graph. More...

void	printClusterHeader (core::CoreNode const *clusterNode) final
	Print the header of a cluster. More...

void	printClusterFooter () final
	Print the footer of a task cluster.

void	printGraphFooter (core::CoreNode const *graph) final
	Print the graph footer. More...

void	printClusterEdge (core::CoreNode const *clusterNode) final
	Print the inside edges of a cluster for a task. More...

void	printExecutionPipelineHeader (core::CoreNode epNode, core::CoreNode switchNode) override
	Print the execution pipeline header. More...

void	printExecutionPipelineFooter () override
	Print the footer for the execution pipeline.

void	printEdgeSwitchGraphs (core::CoreNode *to, std::string const &idSwitch, std::string_view const &edgeType, size_t const &queueSize, size_t const &maxQueueSize, bool isMemoryManaged) override
	Print an edge between the switch and a graph's input node. More...

void	printEdge (core::CoreNode const from, core::CoreNode const to, std::string_view const &edgeType, size_t const &queueSize, size_t const &maxQueueSize, bool isMemoryManaged) final
	Create an edge between from and to. More...

Public Member Functions inherited from hh::AbstractPrinter
	AbstractPrinter ()=default
	Default constructor.

virtual	~AbstractPrinter ()=default
	Default destructor.

bool	hasNotBeenVisited (core::CoreNode const *node)
	Accessor to check if a node has been visited by the printer. More...

Private Member Functions
std::string	getNodeInformation (core::CoreNode *node)
	Extract and create node information. More...

std::string	getRGBFromRange (uint64_t const &val, uint64_t const &min, uint64_t const &range)
	Return a RGB color for a value knowing the minimum value and the range, blue least, red highest. More...

std::string	getExecRGB (uint64_t val)
	Get the rgb color for the execution time value. More...

std::string	getWaitRGB (uint64_t val)
	Get the rgb color for the wait time value. More...

std::string	durationPrinter (uint64_t duration)
	Print a duration with the good unit. More...

Private Attributes
std::vector< std::string >	edges_ = {}
	List of gathered edges definition.

std::ofstream	outputFile_ = {}
	Output file stream.

ColorScheme	colorScheme_ = {}
	Color scheme chosen.

StructureOptions	structureOptions_ = {}
	Structure options chosen.

DebugOptions	debugOptions_ = {}
	Debug option chosen.

uint64_t	maxExecutionTime_ = {}
	Maximum execution time measured in all inside graph's nodes.

uint64_t	minExecutionTime_ = {}
	Minimum execution time measured in all inside graph's nodes.

uint64_t	rangeExecutionTime_ = {}
	Difference between maximum and minimum execution time.

uint64_t	maxWaitTime_ = {}
	Maximum wait time measured in all inside graph's nodes.

uint64_t	minWaitTime_ = {}
	Minimum wait time measured in all inside graph's nodes.

uint64_t	rangeWaitTime_ = {}
	Difference between maximum and minimum wait time.

uint64_t	graphExecutionDuration_ = {}
	Execution duration.

Detailed Description

Printer to produce a dot representation of the current state of the graph.

https://www.graphviz.org/doc/info/lang.html

Definition at line 59 of file dot_printer.h.

Constructor & Destructor Documentation

◆ DotPrinter()

hh::DotPrinter::DotPrinter	(	std::filesystem::path const &	dotFilePath,
		ColorScheme	colorScheme,
		StructureOptions	structureOptions,
		DebugOptions	debugOptions,
		core::CoreNode *	graph
	)

inlineexplicit

DotPrinter constructor, opens the file for writing.

Parameters

dotFilePath	File's path to store the dot file
colorScheme	Color scheme chosen
structureOptions	Structure option chosen
debugOptions	Debug option chosen
graph	Graph to visit and create dot file

Definition at line 84 of file dot_printer.h.

Member Function Documentation

◆ durationPrinter()

std::string hh::DotPrinter::durationPrinter ( uint64_t duration )

inlineprivate

Print a duration with the good unit.

Parameters

duration Duration to print

Returns: std::string with the duration and the unit

Definition at line 561 of file dot_printer.h.

◆ getExecRGB()

std::string hh::DotPrinter::getExecRGB ( uint64_t val )

inlineprivate

Get the rgb color for the execution time value.

Parameters

val	Execution value to get the RGB color

Returns: RGB color for val

Definition at line 547 of file dot_printer.h.

◆ getNodeInformation()

std::string hh::DotPrinter::getNodeInformation ( core::CoreNode * node )

inlineprivate

Extract and create node information.

Parameters

node	Node to exploit

Returns: std::string with node information

Definition at line 393 of file dot_printer.h.

Here is the call graph for this function:

◆ getRGBFromRange()

std::string hh::DotPrinter::getRGBFromRange	(	uint64_t const &	val,
		uint64_t const &	min,
		uint64_t const &	range
	)

inlineprivate

Return a RGB color for a value knowing the minimum value and the range, blue least, red highest.

Parameters

val	Value to get the color
min	Minimum value
range	Range value

Returns: RGB color associated with the value

Definition at line 529 of file dot_printer.h.

◆ getWaitRGB()

std::string hh::DotPrinter::getWaitRGB ( uint64_t val )

inlineprivate

Get the rgb color for the wait time value.

Parameters

val	Execution value to get the RGB color

Returns: RGB color for val

Definition at line 554 of file dot_printer.h.

◆ printClusterEdge()

void hh::DotPrinter::printClusterEdge ( core::CoreNode const * clusterNode )

inlinefinalvirtual

Print the inside edges of a cluster for a task.

Parameters

clusterNode Task part of a cluster

Implements hh::AbstractPrinter.

Definition at line 218 of file dot_printer.h.

◆ printClusterHeader()

void hh::DotPrinter::printClusterHeader ( core::CoreNode const * clusterNode )

inlinefinalvirtual

Print the header of a cluster.

Parameters

clusterNode Cluster main node

Implements hh::AbstractPrinter.

Definition at line 181 of file dot_printer.h.

◆ printEdge()

void hh::DotPrinter::printEdge	(	core::CoreNode const *	from,
		core::CoreNode const *	to,
		std::string_view const &	edgeType,
		size_t const &	queueSize,
		size_t const &	maxQueueSize,
		bool	isMemoryManaged
	)

inlinefinalvirtual

Create an edge between from and to.

Parameters

from	Edge origin node
to	Edge destination node
edgeType	Edge type
queueSize	Current queue size
maxQueueSize	Current maximum queue size
isMemoryManaged	Flag to determine if the edge data is memory managed

Implements hh::AbstractPrinter.

Definition at line 314 of file dot_printer.h.

◆ printEdgeSwitchGraphs()

void hh::DotPrinter::printEdgeSwitchGraphs	(	core::CoreNode *	to,
		std::string const &	idSwitch,
		std::string_view const &	edgeType,
		size_t const &	queueSize,
		size_t const &	maxQueueSize,
		bool	isMemoryManaged
	)

inlineoverridevirtual

Print an edge between the switch and a graph's input node.

Parameters

to	Graph's input node
idSwitch	Switch id
edgeType	Edge's type
queueSize	Current queue size
maxQueueSize	Current max queue size
isMemoryManaged	Flag to tag if the data is memory managed

Implements hh::AbstractPrinter.

Definition at line 254 of file dot_printer.h.

Here is the call graph for this function:

◆ printExecutionPipelineHeader()

void hh::DotPrinter::printExecutionPipelineHeader	(	core::CoreNode *	epNode,
		core::CoreNode *	switchNode
	)

inlineoverridevirtual

Print the execution pipeline header.

Parameters

epNode	Execution pipeline to print
switchNode	Switch bound to the execution pipeline

Implements hh::AbstractPrinter.

Definition at line 231 of file dot_printer.h.

Here is the call graph for this function:

◆ printGraphFooter()

void hh::DotPrinter::printGraphFooter ( core::CoreNode const * graph )

inlinefinalvirtual

Print the graph footer.

Parameters

graph Core graph node

Implements hh::AbstractPrinter.

Definition at line 205 of file dot_printer.h.

◆ printGraphHeader()

void hh::DotPrinter::printGraphHeader ( core::CoreNode const * node )

inlinefinalvirtual

Print header for the graph.

Parameters

node	Graph to print

Implements hh::AbstractPrinter.

Definition at line 156 of file dot_printer.h.

◆ printNodeInformation()

void hh::DotPrinter::printNodeInformation ( core::CoreNode * node )

inlinefinalvirtual

Print node main information.

Parameters

node	Node to print information

Implements hh::AbstractPrinter.

Definition at line 134 of file dot_printer.h.

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

/home/tjb3/work/hedgehog-nist/hedgehog/api/printer/dot_printer.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DotPrinter()

Member Function Documentation

◆ durationPrinter()

◆ getExecRGB()

◆ getNodeInformation()

◆ getRGBFromRange()

◆ getWaitRGB()

◆ printClusterEdge()

◆ printClusterHeader()

◆ printEdge()

◆ printEdgeSwitchGraphs()

◆ printExecutionPipelineHeader()

◆ printGraphFooter()

◆ printGraphHeader()

◆ printNodeInformation()