source: src/mlx/rpccommon.py@ 1178:cd1b4199e2e2

# Some common objects for RPC communication

#------------------------------------------------------------------------------

from . import const
from .gates import lhbpGates

#------------------------------------------------------------------------------

class Plane(object):
    """Information about an airplane in the fleet."""
    _jsonAttributes = ["tailNumber", "aircraftType",
                       "dow", "dowNumCabinCrew", "maxPassengers",
                       "fuselageLength", "wingSpan"]

    @staticmethod
    def str2status(letter):
        """Convert the given letter into a plane status."""
        return const.PLANE_HOME if letter=="H" else \
               const.PLANE_AWAY if letter=="A" else \
               const.PLANE_PARKING if letter=="P" else \
               const.PLANE_UNKNOWN

    @staticmethod
    def status2str(status):
        """Convert the given status into the corresponding letter code."""
        return "H" if status==const.PLANE_HOME else \
               "A" if status==const.PLANE_AWAY else \
               "P" if status==const.PLANE_PARKING else ""

    @staticmethod
    def fromJSON(data):
        """Create a Plane object from the given JSON data."""
        plane = Plane()

        for attributeName in Plane._jsonAttributes:
            setattr(plane, attributeName, data[attributeName])
        plane.status = const.PLANE_AWAY
        plane.gateNumber = "-"

        return plane

    @property
    def hasStairs(self):
        """Indicate if the plane has its own stairs."""
        return self.aircraftType in [const.AIRCRAFT_YK40,
                                     const.AIRCRAFT_CRJ2,
                                     const.AIRCRAFT_F70,
                                     const.AIRCRAFT_DH8D]

    def toJSON(self):
        """Create a JSON representation of the Plane object from the given JSON data."""
        data = {}
        for attributeName in Plane._jsonAttributes:
            data[attributeName] = getattr(self, attributeName)
        return data

    def _setStatus(self, letter):
        """Set the status from the given letter."""
        self.status = Plane.str2status(letter)

    def __repr__(self):
        """Get the representation of the plane object."""
        s = "<Plane: %s %s" % (self.tailNumber,
                               "home" if self.status==const.PLANE_HOME else \
                               "away" if self.status==const.PLANE_AWAY else \
                               "parking" if self.status==const.PLANE_PARKING \
                               else "unknown")
        if self.gateNumber is not None:
            s += " (gate " + self.gateNumber + ")"
        s += ">"
        return s

#------------------------------------------------------------------------------

class Fleet(object):
    """Information about the whole fleet."""
    @staticmethod
    def fromJSON(data):
        """Load the fleet data from the given JSON file."""
        fleet = Fleet()
        for planeData in data:
            fleet._addPlane(Plane.fromJSON(planeData))
        return fleet

    def __init__(self):
        """Construct the fleet information by reading the given file object."""
        self._planes = {}

    def isGateConflicting(self, plane):
        """Check if the gate of the given plane conflicts with another plane's
        position."""
        gate = lhbpGates.find(plane.gateNumber)
        for p in self._planes.values():
            if p.tailNumber!=plane.tailNumber and \
               p.status==const.PLANE_HOME:
                if p.gateNumber==plane.gateNumber:
                    return True
                if gate is not None and not gate.isAvailable(plane,
                                                             lhbpGates,
                                                             [p.gateNumber]):
                    return True

        return False

    def getOccupiedGateNumbers(self):
        """Get a set containing the numbers of the gates occupied by planes."""
        gateNumbers = set()
        for p in self._planes.values():
            if p.status==const.PLANE_HOME and p.gateNumber:
                gateNumbers.add(p.gateNumber)
        return gateNumbers

    def iterAvailableLHBPGates(self, tailNumber):
        """Iterate over the available gates at LHBP."""
        occupiedGateNumbers = self.getOccupiedGateNumbers()
        plane = self.__getitem__(tailNumber)
        for gate in lhbpGates.gates:
            if gate.isAvailable(plane, lhbpGates, occupiedGateNumbers):
                yield gate

    def updatePlane(self, tailNumber, status, gateNumber = None):
        """Update the status of the given plane."""
        if tailNumber in self._planes:
            plane = self._planes[tailNumber]
            plane.status = status
            plane.gateNumber = gateNumber

    def toJSON(self):
        """Convert the fleet into a JSON data."""
        return [plane.toJSON() for plane in self._planes.values()]

    def _addPlane(self, plane):
        """Add the given plane to the fleet."""
        self._planes[plane.tailNumber] = plane

    def __iter__(self):
        """Get an iterator over the planes."""
        for plane in self._planes.values():
            yield plane

    def __getitem__(self, tailNumber):
        """Get the plane with the given tail number.

        If the plane is not in the fleet, None is returned."""
        return self._planes[tailNumber] if tailNumber in self._planes else None

    def __repr__(self):
        """Get the representation of the fleet object."""
        return self._planes.__repr__()