facadesubsystem_interface.py

Go to the documentation of this file.

 
 
from abc import ABC, abstractmethod
from enum import Enum
 
 
class DeviceTypes(Enum):
    
    DEVICECONTROLLER = 0,
    
    CORE = 1,
    
    GTE = 2,
    
    PCH = 3,
    
    PMC = 4
 
 
#  <summary>
#  Represents a network of device chains and the low level access to that
#  network.  In general, the caller should take a lock on a device chain
#  before accessing it then release the lock when done.
#  Part of the @ref facade_pattern "Facade pattern" example.
#  </summary>
#  <remarks>
#  This interface makes it easier to contrast with the IDeviceNetworkHighLevel
#  interface.
#  </remarks>
class IDeviceNetworkLowLevel(ABC):
    
    @abstractmethod
    def GetNumChains(self) -> int:
        pass
 
    
    @abstractmethod
    def LockDeviceChain(self, chainIndex : int) -> bool:
        pass
 
    
    @abstractmethod
    def UnlockDeviceChain(self, chainIndex : int) -> bool:
        pass
 
    
    @abstractmethod
    def ResetDeviceChain(self, chainIndex : int) -> None:
        pass
 
    
    @abstractmethod
    def EnableDevicesInDeviceChain(self, chainIndex : int, devicesSelectMask : int) -> None:
        pass
 
    
    @abstractmethod
    def DisableDevicesInDeviceChain(self, chainIndex : int, devicesSelectMask : int) -> None:
        pass
 
    
    @abstractmethod
    def GetIdcodes(self, chainIndex : int) -> list:
        pass