ih_muse.proto.metric

Protocol definitions for Metrics messages.

Module Contents

Classes

MetricDefinition	Definition of a metric.
MetricPayload	Definition of a metric payloadi.
MetricQuery	Definition of a metric.

API

class ih_muse.proto.metric.MetricDefinition(code: str, name: str, description: str)

Definition of a metric.

Initialization

Initialize MetricDefinition.

_metric_def: ih_muse.ih_muse.PyMetricDefinition

None

class ih_muse.proto.metric.MetricPayload(time: int, element_id: int, metric_ids: list[int], values: list[Optional[float]])

Definition of a metric payloadi.

Initialization

Initialize MetricPayload.

_metric_payload: ih_muse.ih_muse.PyMetricPayload

None

classmethod from_py_metric_payload(py_metric_payload: ih_muse.ih_muse.PyMetricPayload) → ih_muse.proto.metric.MetricPayload

Create a MetricPayload from a PyMetricPayload.

Parameters:

py_metric_payload (PyMetricPayload) – The PyMetricPayload to convert.

Returns:

A corresponding MetricPayload instance.

property time: int

Retrieve the timestamp of the metric payload.

Returns:

The time in milliseconds since epoch.

property element_id: int

Retrieve the element ID associated with the metric payload.

Returns:

The element ID as an integer.

property metric_ids: list[int]

Retrieve the list of metric IDs.

Returns:

A list of integers representing metric IDs.

property values: list[Optional[float]]

Retrieve the list of metric values.

Returns:

A list of floats or None for each metric value.

class ih_muse.proto.metric.MetricQuery(start_time: Optional[int] = None, end_time: Optional[int] = None, element_id: Optional[int] = None, parent_id: Optional[int] = None, metric_id: Optional[float] = None)

Definition of a metric.

Initialization

Initialize MetricQuery.

_metric_query: ih_muse.ih_muse.PyMetricQuery

None