Template Class MonitorStage#

Inheritance Relationships#

Base Type#

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

Class Documentation#

template<typename MessageT>
class MonitorStage : public mrc::pymrc::PythonNode<std::shared_ptr<MessageT>, std::shared_ptr<MessageT>>#

Displays descriptive progress bars including throughput metrics for the messages passing through the pipeline.

Public Types

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

Public Functions

MonitorStage(
const std::string &description,
const std::string &unit = "messages",
indicators::Color = indicators::Color::cyan,
indicators::FontStyle font_style = indicators::FontStyle::bold,
std::optional<std::function<size_t(sink_type_t)>> determine_count_fn = std::nullopt
)#

Construct a new Monitor Stage object.

Parameters:

  • description – : A text label displayed on the left side of the progress bars

  • unit – : the unit of message count

  • determine_count_fn – : A function that computes the count for each incoming message