save_composite()

bool MayaFlux::IO::IOManager::save_composite	(	const std::shared_ptr< Kakshya::CompositeContainer > &	container,
		const std::string &	filepath
	)

Save a complete CompositeContainer in a supported format.

The write is synchronous, unlike the queued save_image, save_mesh, and save_volume. For bounded writes of large data, use open_composite_writer() and supply slices directly. A partial file may remain on failure.

Parameters

container	Source container.
filepath	Destination CSV or TSV path.

Returns

True only if every element was written and the file closed.

Definition at line 860 of file IOManager.cpp.

{
    if (!container) {
        MF_ERROR(Journal::Component::API, Journal::Context::FileIO,
            "IOManager::save_composite: null container");
        return false;
    }
 
    const auto& array = container->get_data();
    auto writer = open_composite_writer(filepath, array.layout());
    if (!writer)
        return false;
 
    const auto rows = array.slice(0, array.size());
    const bool written = rows && writer->write_rows(*rows);
    const std::string write_error = !rows
        ? "could not access the container's elements"
        : writer->get_last_error();
    const bool closed = writer->close();
 
    if (!written || !closed) {
        MF_ERROR(Journal::Component::API, Journal::Context::FileIO,
            "IOManager::save_composite: failed to write '{}' because {}",
            filepath, written ? writer->get_last_error() : write_error);
        return false;
    }
 
    MF_INFO(Journal::Component::API, Journal::Context::FileIO,
        "IOManager::save_composite: wrote '{}'",
        std::filesystem::path(filepath).filename().string());
 
    return true;
}

References MayaFlux::Journal::API, MayaFlux::Journal::FileIO, MF_ERROR, MF_INFO, open_composite_writer(), and rows.

Here is the call graph for this function: