Health-GPS  1.2.2.0
Global Health Policy Simulation model (Health-GPS)
host::ResultFileWriter Class Referencefinal

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

#include <result_file_writer.h>

Inheritance diagram for host::ResultFileWriter:
[legend]
Collaboration diagram for host::ResultFileWriter:
[legend]

Public Member Functions

 ResultFileWriter ()=delete
 
 ResultFileWriter (const std::filesystem::path file_name, const ExperimentInfo info)
 Initialises an instance of the host::ResultFileWriter class. More...
 
 ResultFileWriter (const ResultFileWriter &)=delete
 
ResultFileWriteroperator= (const ResultFileWriter &)=delete
 
 ResultFileWriter (ResultFileWriter &&other) noexcept
 
ResultFileWriteroperator= (ResultFileWriter &&other) noexcept
 
 ~ResultFileWriter ()
 Destroys a host::ResultFileWriter instance. More...
 
void write (const hgps::ResultEventMessage &message) override
 Writes the hgps::ResultEventMessage contents to a stream. More...
 
- Public Member Functions inherited from host::ResultWriter
virtual ~ResultWriter ()=default
 Destroys a host::ResultWriter instance. More...
 

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]

host::ResultFileWriter::ResultFileWriter ( )
delete

◆ ResultFileWriter() [2/4]

host::ResultFileWriter::ResultFileWriter ( const std::filesystem::path  file_name,
const ExperimentInfo  info 
)

Initialises an instance of the host::ResultFileWriter class.

Parameters
file_nameThe JSON output file full name
infoThe associated experiment information

◆ ResultFileWriter() [3/4]

host::ResultFileWriter::ResultFileWriter ( const ResultFileWriter )
delete

◆ ResultFileWriter() [4/4]

host::ResultFileWriter::ResultFileWriter ( ResultFileWriter &&  other)
noexcept

◆ ~ResultFileWriter()

host::ResultFileWriter::~ResultFileWriter ( )

Destroys a host::ResultFileWriter instance.

Member Function Documentation

◆ operator=() [1/2]

ResultFileWriter& host::ResultFileWriter::operator= ( const ResultFileWriter )
delete

◆ operator=() [2/2]

ResultFileWriter & host::ResultFileWriter::operator= ( ResultFileWriter &&  other)
noexcept

◆ write()

void host::ResultFileWriter::write ( const hgps::ResultEventMessage message)
overridevirtual

Writes the hgps::ResultEventMessage contents to a stream.

Parameters
messageThe message instance to process

Implements host::ResultWriter.


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