open()

bool MayaFlux::IO::DelimitedTextWriter::open ( const std::string &  filepath, const Kakshya::CompositeLayout &  layout  )

overridevirtual

Create or truncate a CSV or TSV file.

Parameters

filepath	Output path; a relative path resolves through resolve_write_path().
layout	Field names and exact types for every written element.

Returns

True when ready to accept row slices.

Implements MayaFlux::IO::CompositeWriter.

Definition at line 187 of file DelimitedTextWriter.cpp.

{
    if (is_open()) {
        m_last_error = "Close the current file before opening another";
        return false;
    }
 
    m_last_error.clear();
 
    if (!can_write(filepath)) {
        m_last_error = "Expected a .csv or .tsv output path";
        return false;
    }
 
    if (layout.fields().empty()) {
        m_last_error = "Composite output requires at least one field";
        return false;
    }
 
    for (const auto& field : layout.fields()) {
        if (!supported_type(field.type)) {
            m_last_error = "Unsupported Composite field: " + field.name;
            return false;
        }
    }
 
    Kakshya::CompositeArray empty(layout);
    m_layout = empty.layout();
    m_active_delimiter = m_delimiter != '\0'
        ? m_delimiter
        : (extension_of(filepath) == ".tsv" ? '\t' : ',');
 
    m_file.open(resolve_write_path(filepath),
        std::ios::binary | std::ios::out | std::ios::trunc);
 
    if (!m_file) {
        m_last_error = "Cannot open delimited text output";
        m_layout.reset();
        return false;
    }
 
    m_rows_written = 0;
 
    if (m_write_header) {
        const auto& fields = m_layout->fields();
 
        for (size_t i = 0; i < fields.size(); ++i) {
            if (i != 0)
                m_file.put(m_active_delimiter);
 
            if (!write_cell(fields[i].name, false)) {
                close();
                return false;
            }
        }
 
        m_file.put('\n');
 
        if (!m_file) {
            m_last_error = "Failed to write delimited text header";
            close();
            return false;
        }
    }
 
    return true;
}

References can_write(), close(), MayaFlux::Kakshya::CompositeLayout::fields(), is_open(), MayaFlux::Kakshya::CompositeArray::layout(), m_active_delimiter, m_delimiter, m_file, m_last_error, m_layout, m_rows_written, m_write_header, name, MayaFlux::IO::resolve_write_path(), and write_cell().

Here is the call graph for this function: