Template Struct MonitorStageInterfaceProxy#

Struct Documentation#

template<typename MessageT>
struct MonitorStageInterfaceProxy#

Interface proxy, used to insulate python bindings.

Public Static Functions

static std::shared_ptr<mrc::segment::Object<MonitorStage<MessageT>>> init(
mrc::segment::Builder &builder,
const std::string &name,
const std::string &description,
const std::string &unit,
indicators::Color color = indicators::Color::cyan,
indicators::FontStyle font_style = indicators::FontStyle::bold,
std::optional<std::function<size_t(typename MonitorStage<MessageT>::sink_type_t)>> determine_count_fn = std::nullopt
)#

Create and initialize a MonitorStage, and return the result.

Parameters:

  • builder – : Pipeline context object reference

  • name – : Name of a stage reference

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

  • unit – : the unit of message count

  • text_color – : the text color of progress bars

  • font_style – : the font style of progress bars

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

Returns:

std::shared_ptr<mrc::segment::Object<MonitorStage<MessageT>>>