rule.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
"""
Created on Sat May  9 08:06:12 2020
 
@author: cd
"""
 
import abc
import numpy as np
from efo.time import TimeBase
 
# TODO: Create RuleStack class that sub-classes RuleBase - would need to figure out how set
# ...the qMin and qMax properties. Might be better to have RuleStack be it's own thing
 
 
class RuleBase(metaclass=abc.ABCMeta):
    # TODO: Subrule could also be passed as an optional initializer with a default val
    def __init__(self, name, time):
        self.namename = name
        self.subRulesubRule = None
        # TODO: Should use error handling instead
        if issubclass(type(time), TimeBase):
            self.TT = time
            self.releaserelease = np.zeros(time.nSteps)
        super().__init__()
        
    def set_subrule(self, subRule):
        self.subRulesubRule = subRule
 
    # @abc.abstractmethod
    def calc_release(self, rlsProposed, *, rlsPrev=None, rlsUnCtrl=None, stor=None, qIn=None):
        if self.subRulesubRule:
            rlsProposed = self.subRulesubRule.calc_release(rlsProposed, 
                                                    rlsPrev=rlsPrev, rlsUnCtrl=rlsUnCtrl, stor=stor, qIn=qIn)
        return rlsProposed
 
    @classmethod
    def __subclasshook__(cls, C):
        if cls is RuleBase:
            attrs = set(dir(C))
            if set(cls.__abstractmethods__) <= attrs:
                return True
        return NotImplemented
    
    
class RuleRlsSpecified(RuleBase):
    def __init__(self, name, time):
        # Call super class constructor
        super().__init__(name, time)
        
    def set_release(self, timeStep, rlsSpecified):
        iSpec = self.TT.steps == timeStep
        self.releaserelease[iSpec] = rlsSpecified
 
    # TODO: Why do rlsPrev and qIn have default vals but the other don't?
    # TODO: Seems like they should all have default vals
    def calc_release(self, rlsProposed, rlsUnCtrl, stor, rlsPrev=None, qIn=None):
        return self.releaserelease[self.TT.step]