scc 2025.09
SystemC components library
scc::hierarchy_dumper Class Reference

A SystemC module for dumping the hierarchy of objects in a specified format. More...

#include <hierarchy_dumper.h>

Inheritance diagram for scc::hierarchy_dumper:
Collaboration diagram for scc::hierarchy_dumper:

Public Types

enum  file_type { ELKT , JSON , D3JSON , DBGJSON }
 The supported file formats for dumping the hierarchy. More...

Public Member Functions

 hierarchy_dumper (const std::string &filename, file_type format)
 Constructs a hierarchy_dumper object with the specified file name and format.
virtual ~hierarchy_dumper ()
 Destroys the hierarchy_dumper object.

Detailed Description

A SystemC module for dumping the hierarchy of objects in a specified format.

The hierarchy_dumper class provides a method for dumping the hierarchy of SystemC objects to a file in various formats. It can be used to visualize the structure of a SystemC design or to analyze the interactions between different components.

Author
Your Name
Date
YYYY-MM-DD

Definition at line 37 of file hierarchy_dumper.h.

Member Enumeration Documentation

◆ file_type

The supported file formats for dumping the hierarchy.

Definition at line 42 of file hierarchy_dumper.h.

Constructor & Destructor Documentation

◆ hierarchy_dumper()

scc::hierarchy_dumper::hierarchy_dumper ( const std::string & filename,
file_type format )

Constructs a hierarchy_dumper object with the specified file name and format.

Parameters
filenameThe name of the file where the hierarchy will be dumped.
formatThe format in which the hierarchy will be dumped.

Definition at line 684 of file hierarchy_dumper.cpp.

◆ ~hierarchy_dumper()

scc::hierarchy_dumper::~hierarchy_dumper ( )
virtual

Destroys the hierarchy_dumper object.

Definition at line 689 of file hierarchy_dumper.cpp.


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