Source code for nrel.hive.model.vehicle.mechatronics.powertrain.powertrain

from __future__ import annotations

from abc import abstractmethod, ABC
from dataclasses import dataclass
from typing import Any, Dict

from nrel.hive.model.roadnetwork.route import Route
from nrel.hive.util.units import Unit


@dataclass(frozen=True)
class PowertrainMixin:
    speed_units: Unit
    distance_units: Unit
    energy_units: Unit


class PowertrainABC(ABC):
    """
    a powertrain has the behavior where it calculate energy consumption in KwH
    """

    @abstractmethod
    def energy_cost(self, route: Route) -> float:
        """
        (estimated) energy cost to traverse this route


        :param route: a route, either experienced, or, estimated
        :return: energy cost of this route
        """

    @classmethod
    @abstractmethod
    def from_data(cls, data: Dict[str, Any]) -> Powertrain:
        """
        Build a Powertrain from a data dictionary
        """


class Powertrain(PowertrainMixin, PowertrainABC):
    """"""