lal::io::treebank_collection_report Class Reference

Report on a treebank collection. More...

#include <treebank_collection_report.hpp>

Public Types
typedef std::vector< treebank_collection_report_location >	error_list
	The list of reports of errors of the treebanks within the collection.

Public Member Functions
	treebank_collection_report () noexcept=default
	Default constructor.
	treebank_collection_report (const treebank_collection_report &) noexcept=default
	Default copy constructor.
	treebank_collection_report (treebank_collection_report &&) noexcept=default
	Default move constructor.
	treebank_collection_report (const treebank_file_error &err) noexcept
	Constructor with treebank error.
	treebank_collection_report (treebank_file_error &&err) noexcept
	Constructor with a single head vector error.
	~treebank_collection_report () noexcept=default
	Default destructor.
treebank_collection_report &	operator= (const treebank_collection_report &) noexcept=default
	Default copy assignment.
treebank_collection_report &	operator= (treebank_collection_report &&) noexcept=default
	Default move assignment.
void	add_report (const uint64_t line_number, const std::string &treebank_file_name, const std::string &treebank_id, const treebank_file_report &err) noexcept
	Adds a report on a treebank file.
void	add_report (const uint64_t line_number, std::string &&treebank_file_name, std::string &&treebank_id, treebank_file_report &&err) noexcept
	Adds a report on a treebank file.
void	set_treebank_error (const treebank_file_error &err) noexcept
	Sets the error concerning the main file of the collection.
void	set_treebank_error (treebank_file_error &&err) noexcept
	Sets the error concerning the main file of the collection.
std::size_t	get_num_errors () const noexcept
	Returns the number of errors in this report.
const error_list &	get_treebank_reports () const noexcept
	Returns the list of error reports for every treebank file.
const treebank_file_error &	get_treebank_error () const noexcept
	Returns the only treebank error concerning the file (if any).

Private Attributes
error_list	m_reports
	The error in the head vector and the line number where it happened.
treebank_file_error	m_treebank_error
	A treebank error.

Detailed Description

Report on a treebank collection.

Stores a list of reports on the treebank files within a collection. If the main file of the collection could not be opened, then the treebank error is set (see m_treebank_error and lal::io::treebank_file_error::is_error).

Only when the treebank could be opened (and thus the treebank error is never set) does this class contain a valid (possibly empty) list of reports on its treebank files (see m_reports).

Member Function Documentation

get_treebank_error()

const treebank_file_error & lal::io::treebank_collection_report::get_treebank_error ( ) const

inlinenodiscardnoexcept

Returns the only treebank error concerning the file (if any).

Returns

An error that informs that the file does not exist or that it could not be opened.

get_treebank_reports()

const error_list & lal::io::treebank_collection_report::get_treebank_reports ( ) const

inlinenodiscardnoexcept

Returns the list of error reports for every treebank file.

If the list returned is empty, then there were no errors.

---

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

• lal/io/treebank_collection_report.hpp