Source code for outlets.OutletTemplate

#!/usr/bin/env python
""" Ockle PDU and servers manager
Template for an outlet object that all other outlets extend
Created on Mar 7, 2012

@author: Guy Sheffer <guy.sheffer at mail.huji.ac.il>
"""
from common.common import OpState
class OutletOpState(OpState):
    INIT=-1 #: Did not start yet

    
class OutletTemplate(object):
    ''' Template for an outlet object that all other outlets extend
    
    :ivar data: Holds a dict of the data from the outlet'''
    
    ''' Constructor Class
    
    :param outletConfigDict: a dictionary with the params specified in the ini config file, sections. Its a dict of sections with a dict of variables
    :param outletParams: A dictionary of the server-specific params specified in the outlet section on the server config file
    '''
    def __init__(self,name,outletConfigDict={},outletParams={}):
        self.data={} #data information from the port
        self.setName(name)
        
        self.updateState()
        self.updateOpState()
        return
    
    def getName(self):
        ''' Get outlet's name
        
        :return: the outlets name
        '''
        return self.name
    
    def setName(self,name):
        ''' Get outlet's name
        
        :param name: The outlets name to be set
        '''
        self.name = name
    
    def _setOutletState(self,state):
        ''' To be implemented by the child, sets the outlet's state 
        
        :param bool state: The state to set '''
        pass
    
    def updateOpState(self):
        ''' Update the op state to on or off according to the on/off state of the outlet
        
        :return: the new opState
        '''
        if self.getState():
            self.setOpState(OutletOpState.OK)
        else:
            self.setOpState(OutletOpState.OFF)
        return self.getState()
    
    def setState(self,state):
        '''set the current OpState
        
        :param state: The state of the outlet to set
        :return: True if the setting was successful 
        '''
        self._setOutletState(state)
        self.updateState()
        #TODO: make this more robust?
        if self.getState() == state:
            return True
        else:
            return False
    
    def getState(self):
        return self.state
    
    def updateState(self):
        self.state=self._getOutletState()
        
    def _getOutletState(self):
        ''' To be implemented by the child, sets the outlet's state
        
        :return: The current outlet state ''' 
        pass
    
    def setOpState(self,state):
        self.opState=state
    def getOpState(self):
        return self.opState
    
    def getOutletType(self):
        ''' Returns the type name of the outlet
        :return: The outlet type name
        '''
        return self.__class__.__name__
    
    def getData(self):
        self.updateData()
        return self.data
    
    def updateData(self):
        '''To  be Implemented in the child, updates the ``self.data`` variable
        '''
        pass