# MIT License
# Copyright (c) 2019, INRIA
# Copyright (c) 2019, University of Lille
# All rights reserved.
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

from . import EnergyDevice, EnergyDomain
from ..exception import PyJoulesException


class NvidiaGPUDomain(EnergyDomain):

    def __init__(self, device_id):
        EnergyDomain.__init__(self)
        self.device_id = device_id

    def __repr__(self):
        raise NotImplementedError()


class GPUDoesNotSupportEnergyMonitoringError(PyJoulesException):
    """
    Exception raised when a NvidiaDevice is created but the GPU does not support energy monitoring
    """


class NvidiaDevice(EnergyDevice):
    """
    Interface to get energy consumption of GPUs
    """

    def __init__(self):
        """
        :raise NoSuchEnergyDeviceError: if no Nvidia API is available on this machine
        :raise GPUDoesNotSupportEnergyMonitoringError: if the GPU does not support energy monitoring
        """

    @staticmethod
    def gpu(gpu_id: int) -> str:
        """
        Get the domain string name for the given GPU
        :param gpu_id: the GPU id to get the power consumption
        :return: the domain string name for the given GPU
        """
        raise NotImplementedError()
