Module messages
[hide private]
[frames] | no frames]

Source Code for Module messages

 1  ################################################################################## 
 2  # Copyright (c) 2012, Daniel Urieli, Peter Stone 
 3  # University of Texas at Austin 
 4  # All right reserved 
 5  #  
 6  # Based On: 
 7  #  
 8  # Copyright (c) 2000-2003, Jelle Kok, University of Amsterdam 
 9  # All rights reserved. 
10  #  
11  # Redistribution and use in source and binary forms, with or without 
12  # modification, are permitted provided that the following conditions are met: 
13  #  
14  # 1. Redistributions of source code must retain the above copyright notice, this 
15  # list of conditions and the following disclaimer. 
16  #  
17  # 2. Redistributions in binary form must reproduce the above copyright notice, 
18  # this list of conditions and the following disclaimer in the documentation 
19  # and/or other materials provided with the distribution. 
20  #  
21  # 3. Neither the name of the University of Amsterdam nor the names of its 
22  # contributors may be used to endorse or promote products derived from this 
23  # software without specific prior written permission. 
24  #  
25  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
26  # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
27  # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
28  # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
29  # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
30  # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
31  # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
32  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
33  # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
34  # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
35  ################################################################################## 
36   
37   
38   
39   
40 -class PrimitiveMessage:
41 """ 42 A primitive message that is send from an agent to 43 other agent / other agents / the simulation environment. 44 """ 45 46 # message types 47 TYPE_VISIT = 'MSG_TYPE_VISIT' 48 TYPE_EDGE_LENGTH = 'MSG_TYPE_EDGE_LENGTH' 49 TYPE_START_PATROL = 'MSG_TYPE_START_PATROL' 50 TYPE_POSITION = 'MSG_TYPE_POSITION' 51 TYPE_PATROL_DIVISION = 'MSG_TYPE_PATROL_DIVISION' 52 TYPE_REACHED_START = 'MSG_TYPE_REACHED_START' 53 54 # receiver options 55 TO_SIMULATOR = -1 56 TO_ALL = -2 57 # SUBSET_OF_AGENTS - need to add support for that 58
59 - def __init__(self, to, type, content):
60 self.to = to 61 self.type = type 62 self.content = content
63
64 - def __str__(self):
65 res = "PrimitiveMessage:" 66 res += " to=" + self.to 67 res += " type=" + self.type 68 res += " content=" + str(self.content) 69 res += "\n" 70 return res
71 72
73 -class CompositeMessage:
74 """ 75 Class for general Message that is created by an agent. 76 A CompositeMessage is just a (possibly empty) list of PrimitiveMessage. 77 """
78 - def __init__(self):
79 self.primitiveMsgs = []
80
81 - def __str__(self):
82 res = "\nCompositeMessage:\n" 83 for a in self.primitiveMsgs: 84 res += str(a) 85 res += "\n" 86 return res
87 88
89 - def appendMsg(self, msg):
90 """ 91 Adding a primitive message to the list of outgoing messages. 92 93 @type msg: PrimitiveMessage 94 @param msg: the message to be added to the list 95 """ 96 self.primitiveMsgs.append(msg)
97