hal::NetlistWriter Class Reference

#include <hal_core/netlist/netlist_writer/netlist_writer.h>

Inheritance diagram for hal::NetlistWriter:

Collaboration diagram for hal::NetlistWriter:

Public Member Functions
	NetlistWriter ()=default
virtual	~NetlistWriter ()=default
virtual Result< std::monostate >	write (Netlist *netlist, const std::filesystem::path &file_path)=0

Detailed Description

The base class for all netlist writers. A writer serializes a netlist into a file of the format that it implements.

Definition at line 44 of file netlist_writer.h.

Constructor & Destructor Documentation

NetlistWriter()

hal::NetlistWriter::NetlistWriter ( )

default

~NetlistWriter()

virtual hal::NetlistWriter::~NetlistWriter ( )

virtualdefault

Member Function Documentation

write()

virtual Result<std::monostate> hal::NetlistWriter::write ( Netlist *  netlist, const std::filesystem::path &  file_path  )

pure virtual

Write the netlist to a file at the provided location.

Parameters

[in]	netlist	- The netlist.
[in]	file_path	- The output path.

Returns

true on success, false otherwise.

Implemented in hal::VerilogWriter, and hal::GexfWriter.

---

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

• include/hal_core/netlist/netlist_writer/netlist_writer.h