hgps::ResultFileWriter Class Reference

Defines the results message file stream writer class. More...

#include <result_file_writer.h>

Inheritance diagram for hgps::ResultFileWriter:

Collaboration diagram for hgps::ResultFileWriter:

Public Member Functions
	ResultFileWriter ()=delete
	ResultFileWriter (const std::filesystem::path &file_name, ExperimentInfo info, bool write_income_csv=true, core::IncomeCategoryLayout income_category_layout={})
	Initialises an instance of the hgps::ResultFileWriter class.
	ResultFileWriter (const ResultFileWriter &)=delete
ResultFileWriter &	operator= (const ResultFileWriter &)=delete
	ResultFileWriter (ResultFileWriter &&other) noexcept
ResultFileWriter &	operator= (ResultFileWriter &&other) noexcept
	~ResultFileWriter ()
	Destroys a hgps::ResultFileWriter instance.
void	write (const hgps::ResultEventMessage &message) override
	Writes the hgps::ResultEventMessage contents to a stream.
Public Member Functions inherited from hgps::ResultWriter
virtual	~ResultWriter ()=default
	Destroys a hgps::ResultWriter instance.

Detailed Description

Defines the results message file stream writer class.

The message content are written to a JSON (JavaScript Object Notation) file, experiment information and global averages values, while time-series data is written to a associated CSV (Comma-separated Values) file with same name but different extension.

Constructor & Destructor Documentation

ResultFileWriter() [1/4]

hgps::ResultFileWriter::ResultFileWriter ( )

delete

ResultFileWriter() [2/4]

hgps::ResultFileWriter::ResultFileWriter	(	const std::filesystem::path &	file_name,
		ExperimentInfo	info,
		bool	write_income_csv = true,
		core::IncomeCategoryLayout	income_category_layout = {}
	)

Initialises an instance of the hgps::ResultFileWriter class.

Parameters

file_name	The JSON output file full name
info	The associated experiment information
write_income_csv	When true, write income-based CSV files (one per category). When false, do not.
income_category_layout	Final person.income buckets from project_requirements.

ResultFileWriter() [3/4]

hgps::ResultFileWriter::ResultFileWriter ( const ResultFileWriter &  )

delete

ResultFileWriter() [4/4]

hgps::ResultFileWriter::ResultFileWriter ( ResultFileWriter &&  other )

noexcept

~ResultFileWriter()

hgps::ResultFileWriter::~ResultFileWriter

(

)

Destroys a hgps::ResultFileWriter instance.

Member Function Documentation

operator=() [1/2]

ResultFileWriter & hgps::ResultFileWriter::operator= ( const ResultFileWriter &  )

delete

operator=() [2/2]

ResultFileWriter & hgps::ResultFileWriter::operator= ( ResultFileWriter &&  other )

noexcept

write()

void hgps::ResultFileWriter::write ( const hgps::ResultEventMessage &  message )

overridevirtual

Writes the hgps::ResultEventMessage contents to a stream.

Parameters

message

The message instance to process

Implements hgps::ResultWriter.

---

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

• HealthGPS.Console/result_file_writer.h
• HealthGPS.Console/result_file_writer.cpp