write_metadata()

bool MayaFlux::IO::SpatialCache::write_metadata	(	const std::string &	stream_name,
		const std::unordered_map< std::string, std::string > &	tags
	)

Queue object-level metadata tags for a named stream.

Must be called before that stream_name's first write() call: Alembic MetaData is fixed at object creation and cannot be changed afterward. A call arriving after the stream's object already exists is logged and has no effect.

Parameters

stream_name	Stream these tags apply to.
tags	Key-value pairs, e.g. run parameters (gravity, bounds, rule shader name).

Returns

True if queued. False only if the stream's object was already created before this call.

Definition at line 374 of file SpatialCache.cpp.

{
    std::lock_guard lock(m_impl->mutex);
 
    if (m_impl->vertex_streams.contains(stream_name) || m_impl->curves_streams.contains(stream_name)) {
        set_error("write_metadata: stream '" + stream_name
            + "' already created; call write_metadata before its first write() call");
        MF_ERROR(Journal::Component::IO, Journal::Context::FileIO, "{}", get_last_error());
        return false;
    }
 
    auto& md = m_impl->pending_metadata[stream_name];
    for (const auto& [key, value] : tags) {
        md.set(key, value);
    }
    return true;
}

References MayaFlux::Journal::FileIO, get_last_error(), MayaFlux::Journal::IO, m_impl, MF_ERROR, set_error(), and value.

Here is the call graph for this function: