import pdb from operationscore.SmootCoreObject import * from logger import main_log class Behavior(SmootCoreObject): """Abstract class for a behavior. On every time step, the behavior is passed the inputs from all sensors it is bound to as well as any recursive inputs that it spawned during the last time step. Inheriting classes MUST define processResponse. processResponse should return a list of dictionaries which define the properties of the light response, (outputs, recursions). They must give a location and color. They may define a PixelEvent to more closely control the outgoing data, however, this is normally handled by routing the event to a behavior specifically designed to do this (like AddPixelEvent). timeStep is called on every iteration of the LightInstallation addInput is called on each individual input received, and the inputs queue""" def init(self): self.validateArgs('Behavior.params') if type(self['Inputs']) != type([]): self['Inputs'] = [self['Inputs']] self.recursiveResponseQueue = [] self.sensorResponseQueue = [] self.outGoingQueue = [] self.lastState = None self.behaviorInit() def behaviorInit(self): pass def addMapper(fn): def withmap(fn): return self.addMapperToResponse(fn()) return withmap def processResponse(self, sensorInputs, recursiveInputs): raise Exception('ProcessResponse not defined!') def addInput(self, sensorInput): self.sensorResponseQueue.append(sensorInput) #used for behavior chaining def immediateProcessInput(self, sensorInputs, recursiveInputs=[]): (outputs,recursions) = self.processResponse(sensorInputs, \ recursiveInputs) return self.addMapperToResponse((outputs,recursions)) def addInputs(self, sensorInputs): if type(sensorInputs) == type([]): [self.addInput(sensorInput) for sensorInput in sensorInputs] else: self.addInput(sensorInputs) @staticmethod def deepCopyPacket(datapacket): """Returns a deep copy of a behavior data packet (a list of dicts) so that modifying the returned packet will not modify the incoming packet.""" ret = [] for d in datapacket: d = dict(d) ret.append(d) return ret def getLastOutput(self): return self.lastState def setLastOutput(self, output): """Override to modify state. For example: if you are using a behavior that does uses strings for location specification, you will want to override this to point to a single location. Make sure you keep lastState as a [] of {}. (List of dicts). Additonally, ensure that you call Behavior.deepCopyPacket on the packet before hand to avoid inadvertent down-stream modifications. Look at Square.py for an example of this.""" self.lastState = Behavior.deepCopyPacket(output) def addMapperToResponse(self, responses): if self['Mapper'] != None: if type(responses) == type(tuple): (out, recurs) = responses return (self.addMapperToResponse(out), self.addMapperToResponse(recurs)) if type(responses) == type([]): for r in responses: r['Mapper'] = self['Mapper'] return responses return responses def timeStep(self): #TODO: type checking. clean this up (outputs, recursions) = self.processResponse(self.sensorResponseQueue, \ self.recursiveResponseQueue) self.sensorResponseQueue = [] self.recursiveResponseQueue = recursions self.setLastOutput(outputs) main_log.debug(self['Id'] + ' Ouputs ' + str(outputs)) return self.addMapperToResponse(outputs)