mufem.ReportMonitor

class mufem.ReportMonitor

Bases: MonitorTrait

Class representing a monitor for a report.

__init__(self: mufem.ReportMonitor, name: str, report_name: str) → None

Creates a ReportMonitor with the specified name and report name.

Args:

name (str): Name of the monitor. report_name (str): Name of the report.

Methods

__init__(self, name, report_name)	Creates a ReportMonitor with the specified name and report name.
evaluate(self, event_value)	Evaluates the monitor with the given event value.
get_name(self)	Retrieves the name of the ReportMonitor.
get_values(self)	Retrieves the values of the ReportMonitor.

evaluate(self: mufem.ReportMonitor, event_value: float) → None

Evaluates the monitor with the given event value.

Args:

event_value (double): The value associated with the event.

get_name(self: mufem.ReportMonitor) → str

Retrieves the name of the ReportMonitor.

Returns:

str: The name of the monitor.

get_values(self: mufem.ReportMonitor) → List[Tuple[float, Value]]

Retrieves the values of the ReportMonitor.

Returns:

List of pairs (double, Value): The values recorded by the monitor, each represented as a time-value pair.