[ae3ce4e] | 1 | #!/usr/bin/env python |
---|
[ae60f86] | 2 | """ |
---|
| 3 | Provide base functionality for all model components |
---|
[ae3ce4e] | 4 | """ |
---|
| 5 | |
---|
| 6 | # imports |
---|
| 7 | import copy |
---|
| 8 | |
---|
| 9 | class BaseComponent: |
---|
[ae60f86] | 10 | """ |
---|
| 11 | Basic model component |
---|
[ae3ce4e] | 12 | |
---|
[ae60f86] | 13 | Since version 0.5.0, basic operations are no longer supported. |
---|
[ae3ce4e] | 14 | """ |
---|
| 15 | |
---|
| 16 | def __init__(self): |
---|
| 17 | """ Initialization""" |
---|
| 18 | |
---|
| 19 | ## Name of the model |
---|
| 20 | self.name = "BaseComponent" |
---|
| 21 | |
---|
| 22 | ## Parameters to be accessed by client |
---|
| 23 | self.params = {} |
---|
[3db3895] | 24 | self.details = {} |
---|
[d30fdde] | 25 | ## Dictionary used to store the dispersity/averaging |
---|
| 26 | # parameters of dispersed/averaged parameters. |
---|
| 27 | self.dispersion = {} |
---|
[ae3ce4e] | 28 | |
---|
| 29 | def __str__(self): |
---|
[ae60f86] | 30 | """ |
---|
[ae3ce4e] | 31 | @return: string representation |
---|
| 32 | """ |
---|
| 33 | return self.name |
---|
| 34 | |
---|
[ae60f86] | 35 | def run(self, x): return NotImplemented |
---|
| 36 | def runXY(self, x): return NotImplemented |
---|
[ae3ce4e] | 37 | |
---|
| 38 | def clone(self): |
---|
| 39 | """ Returns a new object identical to the current object """ |
---|
| 40 | |
---|
| 41 | obj = copy.deepcopy(self) |
---|
[ae60f86] | 42 | obj.params = copy.deepcopy(self.params) |
---|
| 43 | obj.details = copy.deepcopy(self.details) |
---|
| 44 | obj.dispersion = copy.deepcopy(self.dispersion) |
---|
[ae3ce4e] | 45 | |
---|
| 46 | return obj |
---|
| 47 | |
---|
| 48 | def setParam(self, name, value): |
---|
[ae60f86] | 49 | """ |
---|
| 50 | Set the value of a model parameter |
---|
[ae3ce4e] | 51 | |
---|
| 52 | @param name: name of the parameter |
---|
| 53 | @param value: value of the parameter |
---|
| 54 | """ |
---|
[ae60f86] | 55 | # Look for dispersion parameters |
---|
| 56 | toks = name.split('.') |
---|
| 57 | if len(toks)==2: |
---|
| 58 | for item in self.dispersion.keys(): |
---|
| 59 | if item.lower()==toks[0].lower(): |
---|
| 60 | for par in self.dispersion[item]: |
---|
| 61 | if par.lower() == toks[1].lower(): |
---|
| 62 | self.dispersion[item][par] = value |
---|
| 63 | return |
---|
| 64 | else: |
---|
| 65 | # Look for standard parameter |
---|
| 66 | for item in self.params.keys(): |
---|
| 67 | if item.lower()==name.lower(): |
---|
| 68 | self.params[item] = value |
---|
| 69 | return |
---|
| 70 | |
---|
| 71 | raise ValueError, "Model does not contain parameter %s" % name |
---|
[ae3ce4e] | 72 | |
---|
| 73 | |
---|
[ae60f86] | 74 | def _setParam(self, name, value): |
---|
[ae3ce4e] | 75 | """ |
---|
[ae60f86] | 76 | Set the value of a model parameter |
---|
| 77 | |
---|
[ae3ce4e] | 78 | @param name: name of the parameter |
---|
| 79 | @param value: value of the parameter |
---|
| 80 | """ |
---|
[ae60f86] | 81 | # Look for dispersion parameters |
---|
[ae3ce4e] | 82 | toks = name.split('.') |
---|
[ae60f86] | 83 | if len(toks)==2 and toks[0] in self.dispersion: |
---|
| 84 | # Setting a dispersion model parameter |
---|
| 85 | if toks[1] in self.dispersion[toks[0]]: |
---|
| 86 | self.dispersion[toks[0]][toks[1]] = value |
---|
| 87 | return |
---|
[ae3ce4e] | 88 | else: |
---|
[ae60f86] | 89 | raise ValueError, "Model does not contain parameter %s.%s" % (toks[0], toks[1]) |
---|
[ae3ce4e] | 90 | |
---|
[ae60f86] | 91 | if name in self.params.keys(): |
---|
| 92 | self.params[name] = value |
---|
| 93 | else: |
---|
| 94 | raise ValueError, "Model does not contain parameter %s" % name |
---|
| 95 | |
---|
| 96 | def _getParam(self, name): |
---|
| 97 | """ |
---|
| 98 | Set the value of a model parameter |
---|
[ae3ce4e] | 99 | |
---|
| 100 | @param name: name of the parameter |
---|
| 101 | """ |
---|
[ae60f86] | 102 | # Look for dispersion parameters |
---|
| 103 | toks = name.split('.') |
---|
| 104 | if len(toks)==2 and toks[0] in self.dispersion: |
---|
| 105 | # Setting a dispersion model parameter |
---|
| 106 | if toks[1] in self.dispersion[toks[0]]: |
---|
| 107 | return self.dispersion[toks[0]][toks[1]] |
---|
| 108 | else: |
---|
| 109 | raise ValueError, "Model does not contain parameter %s.%s" % (toks[0], toks[1]) |
---|
| 110 | |
---|
| 111 | if name in self.params.keys(): |
---|
| 112 | return self.params[name] |
---|
| 113 | else: |
---|
[ae3ce4e] | 114 | raise ValueError, "Model does not contain parameter %s" % name |
---|
| 115 | |
---|
[ae60f86] | 116 | def getParam(self, name): |
---|
| 117 | """ |
---|
| 118 | Set the value of a model parameter |
---|
| 119 | |
---|
[ae3ce4e] | 120 | @param name: name of the parameter |
---|
| 121 | """ |
---|
[ae60f86] | 122 | # Look for dispersion parameters |
---|
[ae3ce4e] | 123 | toks = name.split('.') |
---|
[ae60f86] | 124 | if len(toks)==2: |
---|
| 125 | for item in self.dispersion.keys(): |
---|
| 126 | if item.lower()==toks[0].lower(): |
---|
| 127 | for par in self.dispersion[item]: |
---|
| 128 | if par.lower() == toks[1].lower(): |
---|
| 129 | return self.dispersion[item][par] |
---|
| 130 | else: |
---|
| 131 | # Look for standard parameter |
---|
| 132 | for item in self.params.keys(): |
---|
| 133 | if item.lower()==name.lower(): |
---|
| 134 | return self.params[item] |
---|
| 135 | |
---|
| 136 | raise ValueError, "Model does not contain parameter %s" % name |
---|
| 137 | |
---|
[ae3ce4e] | 138 | def getParamList(self): |
---|
| 139 | """ |
---|
[ae60f86] | 140 | Return a list of all available parameters for the model |
---|
| 141 | """ |
---|
| 142 | list = self.params.keys() |
---|
| 143 | # WARNING: Extending the list with the dispersion parameters |
---|
| 144 | list.extend(self.getDispParamList()) |
---|
| 145 | return list |
---|
| 146 | |
---|
| 147 | def getDispParamList(self): |
---|
| 148 | """ |
---|
| 149 | Return a list of all available parameters for the model |
---|
| 150 | """ |
---|
| 151 | list = [] |
---|
| 152 | |
---|
| 153 | for item in self.dispersion.keys(): |
---|
| 154 | for p in self.dispersion[item].keys(): |
---|
| 155 | if p not in ['type']: |
---|
| 156 | list.append('%s.%s' % (item.lower(), p.lower())) |
---|
| 157 | |
---|
| 158 | return list |
---|
| 159 | |
---|
| 160 | # Old-style methods that are no longer used |
---|
| 161 | def setParamWithToken(self, name, value, token, member): return NotImplemented |
---|
| 162 | def getParamWithToken(self, name, token, member): return NotImplemented |
---|
| 163 | def getParamListWithToken(self, token, member): return NotImplemented |
---|
| 164 | def __add__(self, other): raise ValueError, "Model operation are no longer supported" |
---|
| 165 | def __sub__(self, other): raise ValueError, "Model operation are no longer supported" |
---|
| 166 | def __mul__(self, other): raise ValueError, "Model operation are no longer supported" |
---|
| 167 | def __div__(self, other): raise ValueError, "Model operation are no longer supported" |
---|
| 168 | |
---|