Skip to content

v1alpha8

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8 ¤

Conversion of electrical component enums from/to protobuf v1alpha8.

Functions¤

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8.electrical_component_category_from_proto ¤

electrical_component_category_from_proto(
    message: ValueType,
) -> ElectricalComponentCategory | int

Convert a protobuf ElectricalComponentCategory enum value to an enum member.

PARAMETER DESCRIPTION
message

A protobuf ElectricalComponentCategory enum value.

TYPE: ValueType

RETURNS DESCRIPTION
ElectricalComponentCategory | int

The corresponding ElectricalComponentCategory enum member, or the raw int if the protobuf value is not recognized.
Source code in src/frequenz/client/common/microgrid/electrical_components/proto/v1alpha8/_electrical_component.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
def electrical_component_category_from_proto(
    message: electrical_components_pb2.ElectricalComponentCategory.ValueType,
) -> ElectricalComponentCategory | int:
    """Convert a protobuf ElectricalComponentCategory enum value to an enum member.

    Args:
        message: A protobuf ElectricalComponentCategory enum value.

    Returns:
        The corresponding ElectricalComponentCategory enum member, or the raw `int`
            if the protobuf value is not recognized.
    """
    return enum_from_proto(message, ElectricalComponentCategory)

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8.electrical_component_category_to_proto ¤

electrical_component_category_to_proto(
    category: ElectricalComponentCategory,
) -> ValueType

Convert an ElectricalComponentCategory enum member to a protobuf enum value.

PARAMETER DESCRIPTION
category

An ElectricalComponentCategory enum member.

TYPE: ElectricalComponentCategory

RETURNS DESCRIPTION
ValueType

The corresponding protobuf ElectricalComponentCategory enum value.
Source code in src/frequenz/client/common/microgrid/electrical_components/proto/v1alpha8/_electrical_component.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def electrical_component_category_to_proto(
    category: ElectricalComponentCategory,
) -> electrical_components_pb2.ElectricalComponentCategory.ValueType:
    """Convert an ElectricalComponentCategory enum member to a protobuf enum value.

    Args:
        category: An ElectricalComponentCategory enum member.

    Returns:
        The corresponding protobuf ElectricalComponentCategory enum value.
    """
    return electrical_components_pb2.ElectricalComponentCategory.ValueType(
        category.value
    )

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8.electrical_component_diagnostic_code_from_proto ¤

electrical_component_diagnostic_code_from_proto(
    message: ValueType,
) -> ElectricalComponentDiagnosticCode | int

Convert a protobuf ElectricalComponentDiagnosticCode value to an enum member.

PARAMETER DESCRIPTION
message

A protobuf ElectricalComponentDiagnosticCode enum value.

TYPE: ValueType

RETURNS DESCRIPTION
ElectricalComponentDiagnosticCode | int

The corresponding ElectricalComponentDiagnosticCode enum member, or the raw int if the protobuf value is not recognized.
Source code in src/frequenz/client/common/microgrid/electrical_components/proto/v1alpha8/_electrical_component.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
def electrical_component_diagnostic_code_from_proto(
    message: electrical_components_pb2.ElectricalComponentDiagnosticCode.ValueType,
) -> ElectricalComponentDiagnosticCode | int:
    """Convert a protobuf ElectricalComponentDiagnosticCode value to an enum member.

    Args:
        message: A protobuf ElectricalComponentDiagnosticCode enum value.

    Returns:
        The corresponding ElectricalComponentDiagnosticCode enum member, or the raw
            `int` if the protobuf value is not recognized.
    """
    return enum_from_proto(message, ElectricalComponentDiagnosticCode)

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8.electrical_component_diagnostic_code_to_proto ¤

electrical_component_diagnostic_code_to_proto(
    diagnostic_code: ElectricalComponentDiagnosticCode,
) -> ValueType

Convert an ElectricalComponentDiagnosticCode enum member to a protobuf value.

PARAMETER DESCRIPTION
diagnostic_code

An ElectricalComponentDiagnosticCode enum member.

TYPE: ElectricalComponentDiagnosticCode

RETURNS DESCRIPTION
ValueType

The corresponding protobuf ElectricalComponentDiagnosticCode enum value.
Source code in src/frequenz/client/common/microgrid/electrical_components/proto/v1alpha8/_electrical_component.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def electrical_component_diagnostic_code_to_proto(
    diagnostic_code: ElectricalComponentDiagnosticCode,
) -> electrical_components_pb2.ElectricalComponentDiagnosticCode.ValueType:
    """Convert an ElectricalComponentDiagnosticCode enum member to a protobuf value.

    Args:
        diagnostic_code: An ElectricalComponentDiagnosticCode enum member.

    Returns:
        The corresponding protobuf ElectricalComponentDiagnosticCode enum value.
    """
    return electrical_components_pb2.ElectricalComponentDiagnosticCode.ValueType(
        diagnostic_code.value
    )

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8.electrical_component_state_code_from_proto ¤

electrical_component_state_code_from_proto(
    message: ValueType,
) -> ElectricalComponentStateCode | int

Convert a protobuf ElectricalComponentStateCode enum value to an enum member.

PARAMETER DESCRIPTION
message

A protobuf ElectricalComponentStateCode enum value.

TYPE: ValueType

RETURNS DESCRIPTION
ElectricalComponentStateCode | int

The corresponding ElectricalComponentStateCode enum member, or the raw int if the protobuf value is not recognized.
Source code in src/frequenz/client/common/microgrid/electrical_components/proto/v1alpha8/_electrical_component.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
def electrical_component_state_code_from_proto(
    message: electrical_components_pb2.ElectricalComponentStateCode.ValueType,
) -> ElectricalComponentStateCode | int:
    """Convert a protobuf ElectricalComponentStateCode enum value to an enum member.

    Args:
        message: A protobuf ElectricalComponentStateCode enum value.

    Returns:
        The corresponding ElectricalComponentStateCode enum member, or the raw `int`
            if the protobuf value is not recognized.
    """
    return enum_from_proto(message, ElectricalComponentStateCode)

frequenz.client.common.microgrid.electrical_components.proto.v1alpha8.electrical_component_state_code_to_proto ¤

electrical_component_state_code_to_proto(
    state_code: ElectricalComponentStateCode,
) -> ValueType

Convert an ElectricalComponentStateCode enum member to a protobuf enum value.

PARAMETER DESCRIPTION
state_code

An ElectricalComponentStateCode enum member.

TYPE: ElectricalComponentStateCode

RETURNS DESCRIPTION
ValueType

The corresponding protobuf ElectricalComponentStateCode enum value.
Source code in src/frequenz/client/common/microgrid/electrical_components/proto/v1alpha8/_electrical_component.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def electrical_component_state_code_to_proto(
    state_code: ElectricalComponentStateCode,
) -> electrical_components_pb2.ElectricalComponentStateCode.ValueType:
    """Convert an ElectricalComponentStateCode enum member to a protobuf enum value.

    Args:
        state_code: An ElectricalComponentStateCode enum member.

    Returns:
        The corresponding protobuf ElectricalComponentStateCode enum value.
    """
    return electrical_components_pb2.ElectricalComponentStateCode.ValueType(
        state_code.value
    )