Class WriteToFileStage

• Defined in File write_to_file.hpp

Base Type

• public mrc::pymrc::PythonNode< std::shared_ptr< MessageMeta >, std::shared_ptr< MessageMeta > >

class WriteToFileStage : public mrc::pymrc::PythonNode<std::shared_ptr<MessageMeta>, std::shared_ptr<MessageMeta>>

Write all messages to a file. Messages are written to a file by this class. This class does not maintain an open file or buffer messages.

Public Types

using base_t = mrc::pymrc::PythonNode<std::shared_ptr<MessageMeta>, std::shared_ptr<MessageMeta>>

Public Functions

WriteToFileStage(const std::string &filename, std::ios::openmode mode = std::ios::out, FileTypes file_type = FileTypes::Auto, bool include_index_col = true, bool flush = false)

Construct a new Write To File Stage object.

Parameters

• filename – : Reference to the name of the file to which the messages will be written

• mode – : Reference to the mode for opening a file

• file_type – : FileTypes

• include_index_col – : Write out the index as a column, by default true

• flush – : When true flush the output buffer to disk on each message.