CSVWriter Class Reference

#include <CSVWriter.h>

Collaboration diagram for CSVWriter:

Public Types
using	serializable_types = std::variant< size_t, int, double, std::string >
	The types that can be written to the CSV file. More...

Public Member Functions
	CSVWriter (std::filesystem::path file_path, const std::vector< std::string > &headers, bool append, std::string separator=";")
	Creates a new CSVWriter instance. More...
	CSVWriter (std::filesystem::path file_path, bool append, std::string separator=";")
	Creates a new CSVWriter instance. More...
	CSVWriter (const CSVWriter &)=delete
CSVWriter &	operator= (CSVWriter &)=delete
	CSVWriter (CSVWriter &&) noexcept
CSVWriter &	operator= (CSVWriter &&) noexcept
	~CSVWriter ()
void	initialize (const std::vector< std::string > &headers)
	Initializes the CSV file and writes the header row. More...
void	writeRow (const std::vector< serializable_types > &row)
	Writes a row to the CSV file. More...

Private Attributes
std::ofstream	file
	The file stream to write to. More...
std::filesystem::path	file_path
	The path to the CSV file to write to. More...
bool	append
	Whether to append to the CSV file or overwrite it. More...
std::vector< std::string >	headers
	The headers of the CSV file. More...
std::string	separator
	The separator to use between values. More...

Detailed Description

Definition at line 30 of file CSVWriter.h.

Member Typedef Documentation

serializable_types

using CSVWriter::serializable_types = std::variant<size_t, int, double, std::string>

The types that can be written to the CSV file.

Definition at line 35 of file CSVWriter.h.

Constructor & Destructor Documentation

CSVWriter() [1/4]

CSVWriter::CSVWriter	(	std::filesystem::path	file_path,
		const std::vector< std::string > &	headers,
		bool	append,
		std::string	separator = ";"
	)

Creates a new CSVWriter instance.

Parameters

file_path	The path to the CSV file to write to.
headers	The headers of the CSV file.
append	Whether to append to the CSV file or overwrite it.
separator	The separator to use between values.

Definition at line 17 of file CSVWriter.cpp.

    : file_path(std::move(file_path)), append(append), headers(headers), separator(std::move(separator)) {
    initialize(headers);
}

CSVWriter() [2/4]

CSVWriter::CSVWriter ( std::filesystem::path  file_path, bool  append, std::string  separator = ";"  )

explicit

Creates a new CSVWriter instance.

Parameters

file_path	The path to the CSV file to write to.
append	Whether to append to the CSV file or overwrite it.
separator	The separator to use between values.

Definition at line 21 of file CSVWriter.cpp.

    : file_path(std::move(file_path)), append(append), separator(std::move(separator)) {}

CSVWriter() [3/4]

CSVWriter::CSVWriter ( const CSVWriter &  )

delete

CSVWriter() [4/4]

CSVWriter::CSVWriter ( CSVWriter &&  rhs )

noexcept

Definition at line 24 of file CSVWriter.cpp.

                                             {
    this->file_path = std::move(rhs.file_path);
    this->headers = std::move(rhs.headers);
    this->separator = std::move(rhs.separator);
    this->file = std::move(rhs.file);
}

~CSVWriter()

CSVWriter::~CSVWriter

(

)

Definition at line 38 of file CSVWriter.cpp.

                      {
    Logger::logger->debug("Closing CSVWriter for file {}...", file_path.string());
    file.close();
}

Member Function Documentation

initialize()

void CSVWriter::initialize

(

const std::vector< std::string > &

headers

)

Initializes the CSV file and writes the header row.

Parameters

headers

The headers of the CSV file.

Definition at line 43 of file CSVWriter.cpp.

                                                              {
    Logger::logger->debug("Creating CSVWriter for file {}...", file_path.string());
 
    this->headers = headers;
 
    if (!std::filesystem::exists(file_path)) {
        std::filesystem::create_directories(file_path.parent_path());
    }
 
    if (append) {
        Logger::logger->warn("Appending to file {}...", file_path.string());
        file.open(file_path, std::ios_base::app);
    } else {
        Logger::logger->warn("Overwriting file {}...", file_path.string());
        file.open(file_path, std::ios_base::out);
    }
 
    if (!file.is_open()) {
        Logger::logger->error("Could not open file {} for writing!", file_path.string());
        throw std::runtime_error("Could not open file for writing!");
    }
 
    if (!append) {
        writeRow({headers.begin(), headers.end()});
    }
}

operator=() [1/2]

CSVWriter & CSVWriter::operator= ( CSVWriter &&  rhs )

noexcept

Definition at line 30 of file CSVWriter.cpp.

                                                        {
    this->file_path = std::move(rhs.file_path);
    this->headers = std::move(rhs.headers);
    this->separator = std::move(rhs.separator);
    this->file = std::move(rhs.file);
    return *this;
}

operator=() [2/2]

CSVWriter& CSVWriter::operator= ( CSVWriter &  )

delete

writeRow()

void CSVWriter::writeRow

(

const std::vector< serializable_types > &

row

)

Writes a row to the CSV file.

Parameters

row	The row to write.

Definition at line 70 of file CSVWriter.cpp.

                                                                          {
    if (row.size() != headers.size()) {
        Logger::logger->error("Row size ({}) does not match cols size ({})!", row.size(), headers.size());
        throw std::runtime_error("Row size does not match cols size!");
    }
 
    for (size_t i = 0; i < row.size(); i++) {
        if (i > 0) {
            file << separator;
        }
        std::visit([&](auto&& arg) { write_csv_element(file, arg); }, row[i]);
    }
    file << std::endl;
}

Member Data Documentation

append

bool CSVWriter::append

private

Whether to append to the CSV file or overwrite it.

Definition at line 94 of file CSVWriter.h.

file

std::ofstream CSVWriter::file

private

The file stream to write to.

Definition at line 84 of file CSVWriter.h.

file_path

std::filesystem::path CSVWriter::file_path

private

The path to the CSV file to write to.

Definition at line 89 of file CSVWriter.h.

headers

std::vector<std::string> CSVWriter::headers

private

The headers of the CSV file.

Definition at line 99 of file CSVWriter.h.

separator

std::string CSVWriter::separator

private

The separator to use between values.

Definition at line 104 of file CSVWriter.h.

---

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

• CSVWriter.h
• CSVWriter.cpp