hal::HGLParser Class Reference

#include </home/runner/work/hal/hal/plugins/hgl_parser/include/hgl_parser/hgl_parser.h>

Inheritance diagram for hal::HGLParser:

Collaboration diagram for hal::HGLParser:

Public Member Functions
	HGLParser ()=default
	~HGLParser ()=default
Result< std::unique_ptr< GateLibrary > >	parse (const std::filesystem::path &file_path) override
Public Member Functions inherited from hal::GateLibraryParser
	GateLibraryParser ()
virtual	~GateLibraryParser ()

Additional Inherited Members
Public Types inherited from hal::GateLibraryParser
enum class	ParseStatus { NoError , NeedsUpgrade , UnknownError }
Static Public Member Functions inherited from hal::GateLibraryParser
static ParseStatus	get_parse_status ()
static void	request_upgrade ()
Static Protected Member Functions inherited from hal::GateLibraryParser
static void	set_parse_status (ParseStatus status)
static bool	is_upgrade_requested ()

Detailed Description

A gate library parser for HAL's own HGL gate library format.

Definition at line 43 of file hgl_parser.h.

Constructor & Destructor Documentation

HGLParser()

hal::HGLParser::HGLParser ( )

default

~HGLParser()

hal::HGLParser::~HGLParser ( )

default

Member Function Documentation

parse()

Result< std::unique_ptr< GateLibrary > > hal::HGLParser::parse ( const std::filesystem::path &  file_path )

overridevirtual

Deserializes a gate library in HGL format from the string stream into a gate library object.

Parameters

[in]

file_path

- Path to the file containing the gate library definition.

Returns

The gate library or a nullptr on failure.

Implements hal::GateLibraryParser.

Definition at line 20 of file hgl_parser.cpp.

References ERR, ERR_APPEND, hal::GateLibraryParser::NoError, OK, and hal::GateLibraryParser::set_parse_status().

---

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

• plugins/hgl_parser/include/hgl_parser/hgl_parser.h
• plugins/hgl_parser/src/hgl_parser.cpp