particle.py 70.5 KB
Newer Older
Ahmad Reza's avatar
Ahmad Reza committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
"""
.. module:: particle
   :platform: Unix, Windows
   :synopsis: This module provides the interfaces of the robotics particle

.. moduleauthor:: Ahmad Reza Cheraghi

TODO: Erase Memory

"""

import logging, math
from lib import csv_generator, matter

black = 1
gray = 2
red = 3
green = 4
blue = 5
20
21
22
23
yellow = 6
orange = 7
cyan = 8
violett = 9
Ahmad Reza's avatar
Ahmad Reza committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37


NE=0
E = 1
SE = 2
SW = 3
W = 4
NW = 5


read = 0
write = 1
particle_counter=0

Ahmad Reza's avatar
Ahmad Reza committed
38
class Particle(matter.Matter):
39
    """In the classe marker all the methods for the characterstic of a marker is included"""
Ahmad Reza's avatar
Ahmad Reza committed
40

41
    def __init__(self, sim, x, y, color=black, alpha=1, mm_limit=0, mm_size=0):
42
        """Initializing the marker constructor"""
Ahmad Reza's avatar
Ahmad Reza committed
43
        super().__init__( sim, x, y, color, alpha, type="particle", mm_limit=mm_limit, mm_size=mm_size)
Ahmad Reza's avatar
Ahmad Reza committed
44
45
46
47
48
49
50
51
52
53
54
55
        global particle_counter
        particle_counter+=1
        self.number=particle_counter
        self.__isCarried = False
        self.created = False
        self.carried_tile = None
        self.carried_particle = None
        self.__isCarried = False
        self.steps = 0
        self.created = False
        self.csv_particle_writer = csv_generator.CsvParticleData( self.get_id(), self.number)

56
    def coords_to_sim(self, coords):
Ahmad Reza's avatar
Ahmad Reza committed
57
58
        return coords[0], coords[1] * math.sqrt(3 / 4)

59
    def sim_to_coords(self, x, y):
Ahmad Reza's avatar
Ahmad Reza committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
        return x, round(y / math.sqrt(3 / 4), 0)

    def has_tile(self):
        if self.carried_tile == None:
            return False
        else:
            return True

    def has_particle(self):
        if self.carried_particle == None:
            return False
        else:
            return True


    def get_carried_status(self):
        """
        Get the status if it is taken or not

        :return: Tiles status
        """
        return self.__isCarried

    def check_on_tile(self):
        """
        Checks if the particle is on a tile

        :return: True: On a tile; False: Not on a Tile
        """
89
        if self.coords in self.sim.tile_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
90
91
92
93
94
95
96
97
98
99
100
            return True
        else:
            return False


    def check_on_particle(self):
        """
        Checks if the particle is on a particle

        :return: True: On a particle; False: Not on a particle
        """
101
        if self.coords in self.sim.particle_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
102
103
104
105
            return True
        else:
            return False

106
    def check_on_marker(self):
Ahmad Reza's avatar
Ahmad Reza committed
107
        """
108
        Checks if the particle is on a marker
Ahmad Reza's avatar
Ahmad Reza committed
109

110
        :return: True: On a marker; False: Not on a marker
Ahmad Reza's avatar
Ahmad Reza committed
111
        """
112
        if self.coords in self.sim.marker_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
113
114
115
116
117
118
119
120
121
122
123
            return True
        else:
            return False

    def move_to(self, dir):
        """
        Moves the particle to the given direction

        :param dir: The direction must be either: E, SE, SW, W, NW, or NE
        :return: True: Success Moving;  False: Non moving
        """
124
        dir_coord = self.sim.get_coords_in_dir(self.coords, dir)
125
126
127
        #sim = self.sim_to_coords(dir_coord[0], dir_coord[1])
        #print ("sim actual coord "+ str(sim))
        if self.sim.border==1:
Ahmad Reza's avatar
Ahmad Reza committed
128
            if abs(dir_coord[0]) > self.sim.get_sim_x_size() or  abs(dir_coord[1]) > self.sim.get_sim_y_size() :
129
130
                dir = dir - 3 if dir > 2 else dir + 3
                dir_coord = self.sim.get_coords_in_dir(self.coords, dir)
131
        if self.sim.check_coords(dir_coord[0], dir_coord[1]):
Ahmad Reza's avatar
Ahmad Reza committed
132
133

            try:  # cher: added so the program does not crashed if it does not find any entries in the map
134
                del self.sim.particle_map_coords[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
135
136
            except KeyError:
                pass
Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
137
138
139

            if not dir_coord in self.sim.particle_map_coords:
                self.coords = dir_coord
140
                self.sim.particle_map_coords[self.coords] = self
Ahmad Reza's avatar
Ahmad Reza committed
141
                logging.info("particle %s successfully moved to %s", str(self.get_id()), dir)
Ahmad Reza's avatar
Ahmad Reza committed
142
                self.sim.csv_round_writer.update_metrics( steps=1)
Ahmad Reza's avatar
Ahmad Reza committed
143
144
145
146
147
148
149
150
151
                self.csv_particle_writer.write_particle(steps=1)
                self.touch()
                if self.carried_tile is not None:
                    self.carried_tile.coords = self.coords
                    self.carried_tile.touch()
                elif self.carried_particle is not None:
                    self.carried_particle.coords = self.coords
                    self.carried_particle.touch()
                return True
152
        return False
Ahmad Reza's avatar
Ahmad Reza committed
153
154
155
156
157
158
159
160

    def move_to_in_bounds(self, dir):
        """
            Moves the particle to the given direction if it would remain in bounds.

            :param dir: The direction must be either: E, SE, SW, W, NW, or NE
            :return: True: Success Moving;  False: Non moving
        """
161
162
163
164
        dir_coord = self.sim.get_coords_in_dir(self.coords, dir)
        sim_coord = self.coords_to_sim(dir_coord)
        if self.sim.get_sim_x_size() >=  abs(sim_coord[0]) and \
                        self.sim.get_sim_y_size() >=  abs(sim_coord[1]):
Ahmad Reza's avatar
Ahmad Reza committed
165
166
167
168
169
170
171
172
            return self.move_to(dir)
        else:
            # 'bounce' off the wall
            n_dir = dir - 3 if dir > 2 else dir + 3
            self.move_to(n_dir)

    def read_from_with(self, matter, key=None):
        """
173
        Read the memories from the matters (paricle, tile, or marker object) memories with a given keyword
Ahmad Reza's avatar
Ahmad Reza committed
174

175
        :param matter: The matter can be either a particle, tile, or marker
Ahmad Reza's avatar
Ahmad Reza committed
176
177
178
179
180
181
182
183
184
185
        :param key: A string keyword to searcg for the data in the memory
        :return: The matters memory; None
        """
        if key != None:
            tmp_memory = matter.read_memory_with(key)
        else:
            tmp_memory =  matter.read_whole_memory()

        if tmp_memory != None and len(tmp_memory) > 0 :
            if matter.type == "particle":
186
                self.sim.csv_round_writer.update_metrics( particle_read=1)
Ahmad Reza's avatar
Ahmad Reza committed
187
188
                self.csv_particle_writer.write_particle(particle_read=1)
            elif matter.type == "tile":
189
                self.sim.csv_round_writer.update_metrics( tile_read=1)
Ahmad Reza's avatar
Ahmad Reza committed
190
                self.csv_particle_writer.write_particle(tile_read=1)
191
192
193
            elif matter.type == "marker":
                self.sim.csv_round_writer.update_metrics( marker_read=1)
                self.csv_particle_writer.write_particle(marker_read=1)
Ahmad Reza's avatar
Ahmad Reza committed
194
195
196
197
            return tmp_memory
        else:
            return None

Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
198
  
Ahmad Reza's avatar
Ahmad Reza committed
199
200
201
202
203



    def matter_in(self, matter="tile", dir=E):
        if matter=="tile":
204
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
205
        if matter=="particle":
206
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords()
207
208
        if matter=="marker":
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
209
210
211


    def tile_in(self, dir=E):
212
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
213
214

    def particle_in(self, dir=E):
215
        return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
216

217
218
    def marker_in(self, dir=E):
         return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
219
220
221


    def get_matter_in_dir(self, matter="tile", dir=E):
222
223
224
225
226
227
        if matter=="tile":
            if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords():
                return self.sim.get_tile_map_coords()[self.sim.get_coords_in_dir(self.coords, dir)]
        if matter=="particle":
            if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords():
                return self.sim.get_particle_map_coords()[self.sim.get_coords_in_dir(self.coords, dir)]
228
229
230
        if matter=="marker":
            if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords():
                return self.sim.get_marker_map_coords()[self.sim.get_coords_in_dir(self.coords, dir)]
Ahmad Reza's avatar
Ahmad Reza committed
231
232
233


    def get_tile_in(self, dir=E):
234
235
        if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords():
            return self.sim.get_tile_map_coords()[self.sim.get_coords_in_dir(self.coords, dir)]
Ahmad Reza's avatar
Ahmad Reza committed
236
237

    def get_particle_in(self, dir=E):
238
239
        if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords():
            return self.sim.get_particle_map_coords()[self.sim.get_coords_in_dir(self.coords, dir)]
Ahmad Reza's avatar
Ahmad Reza committed
240

241
242
243
    def get_marker_in(self, dir=E):
        if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords():
            return self.sim.get_marker_map_coords()[self.sim.get_coords_in_dir(self.coords, dir)]
Ahmad Reza's avatar
Ahmad Reza committed
244

245
246
247
    def get_marker(self):
        if self.coords in self.sim.marker_map_coords:
            return self.sim.get_marker_map_coords()[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
248

Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
249
250
251
    def get_tile(self):
        if self.self.coords in self.sim.get_tile_map_coords():
            return self.sim.get_tile_map_coords()[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
252
253
254
255


    def write_to_with(self, matter, key=None, data=None):
        """
256
        Writes data with given a keyword directly on the matters (paricle, tile, or marker object) memory
Ahmad Reza's avatar
Ahmad Reza committed
257

258
        :param matter: The matter can be either a particle, tile, or marker
Ahmad Reza's avatar
Ahmad Reza committed
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
        :param key: A string keyword so to order the data that is written into the memory
        :param data: The data that should be stored into the memory
        :return: True: Successful written into the memory; False: Unsuccessful
        """
        wrote=False
        if data != None:
            wrote=False
            if key==None:
                wrote=matter.write_memory(data)
            else:
                wrote= matter.write_memory_with(key, data)
            if  wrote==True:
                if matter.type == "particle":
                    self.sim.csv_round_writer.update_metrics( particle_write=1)
                    self.csv_particle_writer.write_particle(particle_write=1)
                elif matter.type == "tile":
                    self.sim.csv_round_writer.update_metrics( tile_write=1)
                    self.csv_particle_writer.write_particle(tile_write=1)
277
278
279
                elif matter.type == "marker":
                    self.sim.csv_round_writer.update_metrics( marker_write=1)
                    self.csv_particle_writer.write_particle(marker_write=1)
Ahmad Reza's avatar
Ahmad Reza committed
280
281
282
283
284
285
                return True
            else:
                return False
        else:
            return False

Ahmad Reza's avatar
Ahmad Reza committed
286
287
    def if_matter_in_dir(self, matter="tile", dir=E):
        if matter=="tile":
288
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
289
        if matter=="particle":
290
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords()
291
292
        if matter=="marker":
            return self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords()
Ahmad Reza's avatar
Ahmad Reza committed
293
294
295
296


    def scan_for_matter_within(self, matter='all', hop=1):
        """
297
        Scans for particles, tiles, or marker on a given hop distance and all the matters within the hop distance
Ahmad Reza's avatar
Ahmad Reza committed
298
299
300

        :todo: If nothing then everything should be scanned

301
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
        :param hop: The hop distance from the actual position of the scanning particle
        :return: A list of the founded matters
        """

        hop_list = []
        for i in range(1, hop + 1):
            list = self.scan_for_matter_in(matter, i)
            if list != None:
                hop_list.extend(list)
        if len(hop_list) != 0:
            return hop_list
        else:
            return None

    def scan_for_matter_in(self, matter='all', hop=1):
        """
318
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
319

320
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
        :param hop: The hop distance from thee actual position of the scanning particle
        :return: A list of the founded matters
        """
        hop_list = []
        logging.info("particle on %s is scanning for %s in %i hops", str(self.coords), matter, hop)
        cnt = 0
        x_offset = 0
        y_up_scan = self.coords[1] + hop
        y_down_scan = self.coords[1] - hop
        while cnt < hop:
            x_scan_pos = self.coords[0] + hop - x_offset
            x_scan_neg = self.coords[0] - hop + x_offset
            y_scan_coord_neg = self.coords[1] - cnt
            y_scan_coord_pos = self.coords[1] + cnt
            if cnt == 0:
                if matter == "particles":
337
338
                    # if self.coords in self.sim.particle_map_coords:
                    #     hop_list.append(self.sim.particle_map_coords[self.coords])
339
340
341
342
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_neg)])
343
344
345
346
347
348
349
                elif matter == "markers":
                    # if self.coords in self.sim.marker_map_coords:
                    #     hop_list.append(self.sim.marker_map_coords[self.coords])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
350
                elif matter == "tiles":
351
352
                    # if self.coords in self.sim.tile_map_coords:
                    #     hop_list.append(self.sim.tile_map_coords[self.coords])
353
354
355
356
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
357
                elif matter == "all":
358
359
                    # if self.coords in self.sim.tile_map_coords:
                    #     hop_list.append(self.sim.tile_map_coords[self.coords])
360
361
                    # if self.coords in self.sim.marker_map_coords:
                    #     hop_list.append(self.sim.marker_map_coords[self.coords])
362
363
                    # if self.coords in self.sim.particle_map_coords:
                    #    hop_list.append(self.sim.particle_map_coords[self.coords])
364
365
366
367
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_neg, y_scan_coord_neg)])
368
369
370
371
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_neg)])
372
373
374
375
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
376
377
378
379
                else:
                    logging.info("No matter specified")
            else:
                if matter == "particles":
380
381
382
383
384
385
386
387
                    if (x_scan_pos, y_scan_coord_pos) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_pos)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_pos) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_pos)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_neg)])
388
389
390
391
392
393
394
395
396
                elif matter == "markers":
                    if (x_scan_pos, y_scan_coord_pos) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_pos)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_pos) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_pos)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
397
                elif matter == "tiles":
398
399
400
401
402
403
404
405
                    if (x_scan_pos, y_scan_coord_pos) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_pos)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
406
                elif matter == "all":
407
408
409
410
411
412
413
414
415
                    if (x_scan_pos, y_scan_coord_pos) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_pos)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_pos) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_pos)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_neg)])

416
417
418
419
420
421
422
423
                    if (x_scan_pos, y_scan_coord_pos) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_pos)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_pos) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_pos)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_neg)])
424
425
426
427
428
429
430
431
432

                    if (x_scan_pos, y_scan_coord_pos) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_pos)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                    if (x_scan_neg, y_scan_coord_neg) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
433
434
435
436
437
438
439
440
441
442
443
444

                else:
                    logging.info("No matter specified")
            cnt += 1
            x_offset += 0.5

        cnt = 0
        x_upper_scan = self.coords[0] + hop / 2
        offset_x = 0
        while cnt < hop + 1:
            x_upper_scan = x_upper_scan - offset_x
            if matter == "particles":
445
446
447
448
                if (x_upper_scan, y_up_scan) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_upper_scan, y_up_scan)])
                if (x_upper_scan, y_down_scan) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_upper_scan, y_down_scan)])
449
450
451
452
453
            elif matter == "markers":
                if (x_upper_scan, y_up_scan) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_upper_scan, y_up_scan)])
                if (x_upper_scan, y_down_scan) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
454
            elif matter == "tiles":
455
456
457
458
                if (x_upper_scan, y_up_scan) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_upper_scan, y_up_scan)])
                if (x_upper_scan, y_down_scan) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
459
460
            if matter == "all":
                if hop == 0:
461
462
                    if (0, 0) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(0, 0)])
463
464
                    if (0, 0) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(0, 0)])
465
466
                    if (0, 0) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(0, 0)])
Ahmad Reza's avatar
Ahmad Reza committed
467
468

                else:
469
470
471
472
                    if (x_upper_scan, y_up_scan) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_upper_scan, y_up_scan)])
                    if (x_upper_scan, y_down_scan) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
473

474
475
476
477
                    if (x_upper_scan, y_up_scan) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_upper_scan, y_up_scan)])
                    if (x_upper_scan, y_down_scan) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
478

479
480
481
482
                    if (x_upper_scan, y_up_scan) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_upper_scan, y_up_scan)])
                    if (x_upper_scan, y_down_scan) in self.sim.tile_map_coords:
                        hop_list.append(self.sim.tile_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498

            else:
                logging.info("No matter specified")
            cnt += 1
            offset_x = 1
        if len(hop_list) > 0:
            logging.info("Got %s in %s hops", str(len(hop_list)), str(hop))
            return hop_list
        else:
            logging.info("Nothing in %s hops", str(hop))
            return None



    def scan_for_particle_within(self, hop=1):
        """
499
        Scans for particles, tiles, or marker on a given hop distance and all the matters within the hop distance
Ahmad Reza's avatar
Ahmad Reza committed
500
501
502

        :todo: If nothing then everything should be scanned

503
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
        :param hop: The hop distance from the actual position of the scanning particle
        :return: A list of the founded matters
        """

        hop_list = []
        for i in range(1, hop + 1):
            list = self.scan_for_particle_in( i)
            if list != None:
                hop_list.extend(list)
        if len(hop_list) != 0:
            return hop_list
        else:
            return None

    def scan_for_particle_in(self, hop=1):
        """
520
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
521

522
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
        :param hop: The hop distance from thee actual position of the scanning particle
        :return: A list of the founded matters
        """
        hop_list = []
        logging.info("particle on %s is scanning for particle in %i hops", str(self.coords), hop)
        cnt = 0
        x_offset = 0
        y_up_scan = self.coords[1] + hop
        y_down_scan = self.coords[1] - hop
        while cnt < hop:
            x_scan_pos = self.coords[0] + hop - x_offset
            x_scan_neg = self.coords[0] - hop + x_offset
            y_scan_coord_neg = self.coords[1] - cnt
            y_scan_coord_pos = self.coords[1] + cnt
            if cnt == 0:
538
539
540
541
542
543
                # if self.coords in self.sim.particle_map_coords:
                #     hop_list.append(self.sim.particle_map_coords[self.coords])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_neg, y_scan_coord_neg) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
544
            else:
545
546
547
548
549
550
551
552
                if (x_scan_pos, y_scan_coord_pos) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_pos)])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_neg, y_scan_coord_pos) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_pos)])
                if (x_scan_neg, y_scan_coord_neg) in self.sim.particle_map_coords:
                    hop_list.append(self.sim.particle_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
553
554
555
556
557
558
559
560
            cnt += 1
            x_offset += 0.5

        cnt = 0
        x_upper_scan = self.coords[0] + hop / 2
        offset_x = 0
        while cnt < hop + 1:
            x_upper_scan = x_upper_scan - offset_x
561
562
563
564
            if (x_upper_scan, y_up_scan) in self.sim.particle_map_coords:
                hop_list.append(self.sim.particle_map_coords[(x_upper_scan, y_up_scan)])
            if (x_upper_scan, y_down_scan) in self.sim.particle_map_coords:
                hop_list.append(self.sim.particle_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
565
566
567
568
569
570
571
572
573
574
575
576
577
            cnt += 1
            offset_x = 1
        if len(hop_list) > 0:
            logging.info("Got %s in %s hops", str(len(hop_list)), str(hop))
            return hop_list
        else:
            logging.info("Nothing in %s hops", str(hop))
            return None



    def scan_for_tile_within(self,  hop=1):
        """
578
        Scans for particles, tiles, or marker on a given hop distance and all the matters within the hop distance
Ahmad Reza's avatar
Ahmad Reza committed
579
580
581

        :todo: If nothing then everything should be scanned

582
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
        :param hop: The hop distance from the actual position of the scanning particle
        :return: A list of the founded matters
        """

        hop_list = []
        for i in range(1, hop + 1):
            list = self.scan_for_tile_in(i)
            if list != None:
                hop_list.extend(list)
        if len(hop_list) != 0:
            return hop_list
        else:
            return None

    def scan_for_tile_in(self, hop=1):
        """
599
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
600

601
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
        :param hop: The hop distance from thee actual position of the scanning particle
        :return: A list of the founded matters
        """
        hop_list = []
        logging.info("particle on %s is scanning for tile in %i hops", str(self.coords), hop)
        cnt = 0
        x_offset = 0
        y_up_scan = self.coords[1] + hop
        y_down_scan = self.coords[1] - hop
        while cnt < hop:
            x_scan_pos = self.coords[0] + hop - x_offset
            x_scan_neg = self.coords[0] - hop + x_offset
            y_scan_coord_neg = self.coords[1] - cnt
            y_scan_coord_pos = self.coords[1] + cnt
            if cnt == 0:
617
618
619
620
621
622
                # if self.coords in self.sim.tile_map_coords:
                #     hop_list.append(self.sim.tile_map_coords[self.coords])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_neg, y_scan_coord_neg) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
623
            else:
624
625
626
627
628
629
630
631
                if (x_scan_pos, y_scan_coord_pos) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_pos)])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_neg, y_scan_coord_neg) in self.sim.tile_map_coords:
                    hop_list.append(self.sim.tile_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
632
633
634
635
636
637
638
639
            cnt += 1
            x_offset += 0.5

        cnt = 0
        x_upper_scan = self.coords[0] + hop / 2
        offset_x = 0
        while cnt < hop + 1:
            x_upper_scan = x_upper_scan - offset_x
640
641
642
643
            if (x_upper_scan, y_up_scan) in self.sim.tile_map_coords:
                hop_list.append(self.sim.tile_map_coords[(x_upper_scan, y_up_scan)])
            if (x_upper_scan, y_down_scan) in self.sim.tile_map_coords:
                hop_list.append(self.sim.tile_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
644
645
646
647
648
649
650
651
652
653
            cnt += 1
            offset_x = 1
        if len(hop_list) > 0:
            logging.info("Got %s in %s hops", str(len(hop_list)), str(hop))
            return hop_list
        else:
            logging.info("Nothing in %s hops", str(hop))
            return None


654
    def scan_for_marker_within(self, hop=1):
Ahmad Reza's avatar
Ahmad Reza committed
655
        """
656
        Scans for particles, tiles, or marker on a given hop distance and all the matters within the hop distance
Ahmad Reza's avatar
Ahmad Reza committed
657
658
659

        :todo: If nothing then everything should be scanned

660
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
661
662
663
664
665
666
        :param hop: The hop distance from the actual position of the scanning particle
        :return: A list of the founded matters
        """

        hop_list = []
        for i in range(1, hop + 1):
667
            list = self.scan_for_marker_in(i)
Ahmad Reza's avatar
Ahmad Reza committed
668
669
670
671
672
673
674
            if list != None:
                hop_list.extend(list)
        if len(hop_list) != 0:
            return hop_list
        else:
            return None

675
    def scan_for_marker_in(self, hop=1):
Ahmad Reza's avatar
Ahmad Reza committed
676
        """
677
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
678

679
        :param matter: For what matter this method should scan for. Can be either particles, tiles, markers, or (default)all
Ahmad Reza's avatar
Ahmad Reza committed
680
681
682
683
        :param hop: The hop distance from thee actual position of the scanning particle
        :return: A list of the founded matters
        """
        hop_list = []
684
        logging.info("particle is scanning for marker in %i hops", hop)
Ahmad Reza's avatar
Ahmad Reza committed
685
686
687
688
689
690
691
692
693
694
        cnt = 0
        x_offset = 0
        y_up_scan = self.coords[1] + hop
        y_down_scan = self.coords[1] - hop
        while cnt < hop:
            x_scan_pos = self.coords[0] + hop - x_offset
            x_scan_neg = self.coords[0] - hop + x_offset
            y_scan_coord_neg = self.coords[1] - cnt
            y_scan_coord_pos = self.coords[1] + cnt
            if cnt == 0:
695
696
697
698
699
700
                # if self.coords in self.sim.marker_map_coords:
                #     hop_list.append(self.sim.marker_map_coords[self.coords])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_neg, y_scan_coord_neg) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
701
702
            else:

703
704
705
706
707
708
709
710
                if (x_scan_pos, y_scan_coord_pos) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_pos)])
                if (x_scan_pos, y_scan_coord_neg) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_scan_pos, y_scan_coord_neg)])
                if (x_scan_neg, y_scan_coord_pos) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_pos)])
                if (x_scan_neg, y_scan_coord_neg) in self.sim.marker_map_coords:
                    hop_list.append(self.sim.marker_map_coords[(x_scan_neg, y_scan_coord_neg)])
Ahmad Reza's avatar
Ahmad Reza committed
711
712
713
714
715
716
717
718
            cnt += 1
            x_offset += 0.5

        cnt = 0
        x_upper_scan = self.coords[0] + hop / 2
        offset_x = 0
        while cnt < hop + 1:
            x_upper_scan = x_upper_scan - offset_x
719
720
721
722
            if (x_upper_scan, y_up_scan) in self.sim.marker_map_coords:
                hop_list.append(self.sim.marker_map_coords[(x_upper_scan, y_up_scan)])
            if (x_upper_scan, y_down_scan) in self.sim.marker_map_coords:
                hop_list.append(self.sim.marker_map_coords[(x_upper_scan, y_down_scan)])
Ahmad Reza's avatar
Ahmad Reza committed
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
            cnt += 1
            offset_x = 1
        if len(hop_list) > 0:
            logging.info("Got %s in %s hops", str(len(hop_list)), str(hop))
            return hop_list
        else:
            logging.info("Nothing in %s hops", str(hop))
            return None



    def take_me(self, coords=0):
        """
        The particle is getting taken from the the other particle on the given coordinate

        :param coords: Coordination of particle that should be taken
        :return: True: Successful taken; False: Cannot be taken or wrong Coordinates
        """

        if not self.__isCarried:
743
744
            if self.coords in self.sim.particle_map_coords:
                del self.sim.particle_map_coords[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
            self.__isCarried = True
            self.coords = coords
            self.touch()
            return True
        else:
            return False


    def drop_me(self, coords):
        """
        The actual particle is getting dropped

        :param coords: the given position
        :return: None
        """
760
        self.sim.particle_map_coords[coords] = self
Ahmad Reza's avatar
Ahmad Reza committed
761
762
763
764
765
766
767
768
769
770
        self.coords = coords
        self.__isCarried = False
        self.touch()



    def create_tile(self, color=gray, alpha=1):
        """
        Creates a tile on the particles actual position

Ahmad Reza's avatar
Ahmad Reza committed
771
        :return: New Tile or False
Ahmad Reza's avatar
Ahmad Reza committed
772
773
        """
        logging.info("Going to create a tile on position %s", str(self.coords))
Ahmad Reza's avatar
Ahmad Reza committed
774
775
776
777
778
779
780
781
782
        new_tile = self.sim.add_tile(self.coords[0], self.coords[1], color, alpha)
        if new_tile:
            self.sim.tile_map_coords[self.coords[0], self.coords[1]].created = True
            self.csv_particle_writer.write_particle(tile_created=1)
            self.sim.csv_round_writer.update_tiles_num(len(self.sim.get_tiles_list()))
            self.sim.csv_round_writer.update_metrics( tile_created=1)
            return new_tile
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
783
784
785
786
787
788

    def create_tile_in(self, dir=None, color=gray, alpha=1):
        """
        Creates a tile either in a given direction

        :param dir: The direction on which the tile should be created. Options: E, SE, SW, W, NW, NE,
Ahmad Reza's avatar
Ahmad Reza committed
789
        :return: New tile or False
Ahmad Reza's avatar
Ahmad Reza committed
790
791
792
793
        """
        logging.info("particle with id %s is", self.get_id())
        logging.info("Going to create a tile in %s ", str(dir) )
        if dir != None:
794
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
795
796
            new_tile = self.sim.add_tile(coords[0], coords[1], color, alpha)
            if new_tile:
797
                self.sim.tile_map_coords[coords[0], coords[1]].created = True
Ahmad Reza's avatar
Ahmad Reza committed
798
                logging.info("Tile is created")
799
                self.sim.new_tile_flag = True
Ahmad Reza's avatar
Ahmad Reza committed
800
                self.csv_particle_writer.write_particle(tile_created=1)
801
802
                self.sim.csv_round_writer.update_tiles_num(len(self.sim.get_tiles_list()))
                self.sim.csv_round_writer.update_metrics( tile_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
803
804
805
                return new_tile
            else:
                return False
Ahmad Reza's avatar
Ahmad Reza committed
806
807
        else:
            logging.info("Not created tile ")
Ahmad Reza's avatar
Ahmad Reza committed
808
            return False
Ahmad Reza's avatar
Ahmad Reza committed
809
810
811
812
813
814
815

    def create_tile_on(self, x=None, y=None, color=gray, alpha=1):
        """
        Creates a tile either on a given x,y coordinates

        :param x: x coordinate
        :param y: y coordinate
Ahmad Reza's avatar
Ahmad Reza committed
816
        :return: New Tile or False
Ahmad Reza's avatar
Ahmad Reza committed
817
818
819
820
821
        """

        logging.info("particle with id %s is", self.get_id())
        if x is not None and y is not None:
            coords = (x, y)
822
            if self.sim.check_coords(x,y):
Ahmad Reza's avatar
Ahmad Reza committed
823
                logging.info("Going to create a tile on position \(%i , %i\)", x,y )
824
825
826
                if self.sim.add_tile(coords[0], coords[1], color, alpha) == True:
                    self.sim.tile_map_coords[coords[0], coords[1]].created = True
                    self.sim.new_tile_flag = True
Ahmad Reza's avatar
Ahmad Reza committed
827
                    self.csv_particle_writer.write_particle(tile_created=1)
828
829
                    self.sim.csv_round_writer.update_tiles_num(len(self.sim.get_tiles_list()) )
                    self.sim.csv_round_writer.update_metrics( tile_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
830
831
832
833
834
835
                    return True
                else:
                    logging.info("Not created tile on coords  \(%i , %i\)", y,x )
                    return False
            else:
                logging.info("Not created tile on coords   \(%i , %i\)", y,x )
Ahmad Reza's avatar
Ahmad Reza committed
836
                return False
Ahmad Reza's avatar
Ahmad Reza committed
837
838
839
840
841
842
843
844
845

    def delete_tile(self):
        """
        Deletes a tile on current position

        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        logging.info("Particle %s is", self.get_id())
        logging.info("is going to delete a tile on current position")
846
847
        if self.coords in self.sim.get_tile_map_coords():
            if self.sim.remove_tile_on(self.coords):
Ahmad Reza's avatar
Ahmad Reza committed
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
                self.csv_particle_writer.write_particle(tile_deleted=1)
                return True
        else:
            logging.info("Could not delet tile")
            return False

    def delete_tile_with(self, id):
        """
        Deletes a tile with a given tile-id

        :param tile_id: The id of the tile that should be deleted
        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        logging.info("Particle %s is", self.get_id())
        logging.info("is going to delete a tile with tile id %s", str(id))
863
        if self.sim.remove_tile(id):
Ahmad Reza's avatar
Ahmad Reza committed
864
865
866
867
868
869
            self.csv_particle_writer.write_particle(tile_deleted=1)
            return True
        else:
            logging.info("Could not delet tile with tile id %s", str(id))
            return False

Ahmad Reza's avatar
Ahmad Reza committed
870
    def delete_tile_in(self, dir=None):
Ahmad Reza's avatar
Ahmad Reza committed
871
872
873
874
875
876
877
878
        """
        Deletes a tile either in a given direction

        :param dir: The direction on which the tile should be deleted. Options: E, SE, SW, W, NW, NE,

        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        coords = ()
Ahmad Reza's avatar
Ahmad Reza committed
879
        if dir is not None:
880
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
881
882
            logging.info("Deleting tile in %s direction", str(dir))
            if coords is not None:
883
                if self.sim.remove_tile_on(coords):
Ahmad Reza's avatar
Ahmad Reza committed
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
                    logging.info("Deleted tile with tile on coords %s", str(coords))
                    self.csv_particle_writer.write_particle(tile_deleted=1)
                    return True
                else:
                    logging.info("Could not delet tile on coords %s", str(coords))
                    return False
        else:
            logging.info("Could not delet tile on coords %s", str(coords))
            return False

    def delete_tile_on(self, x=None, y=None):
        """
        Deletes a tile either on a given x,y coordinates
,
        :param x: x coordinate
        :param y: y coordinate
        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        coords = ()
        if x is not None and y is not None:
            coords = (x, y)
905
            if self.sim.remove_tile_on(coords):
Ahmad Reza's avatar
Ahmad Reza committed
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
                logging.info("Deleted tile with tile on coords %s", str(coords))
                self.csv_particle_writer.write_particle(tile_deleted=1)
                return True
            else:
                logging.info("Could not delet tile on coords %s", str(coords))
                return False
        else:
            logging.info("Could not delet tile on coords %s", str(coords))
            return False


    def take_tile(self):
        """
        Takes a tile on the actual position

        :param id:  The id of the tile that should be taken
        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_particle is None and self.carried_tile is None:
925
926
            if self.coords in self.sim.tile_map_coords:
                self.carried_tile = self.sim.tile_map_coords[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
927
928
                if self.carried_tile.take(coords=self.coords):
                    logging.info("Tile has been taken")
929
                    self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
930
931
932
933
934
935
                    self.csv_particle_writer.write_particle(tiles_taken=1)
                    return True
                else:
                    logging.info("Tile could not be taken")
                    return False
            else:
936
                logging.info("No tile on the actual position not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
937
938
939
940
941
942
943
944
945
946
947
948
949
950
                return False
        else:
            logging.info("Tile cannot taken because particle is carrieng either a tile or a particle")
            return False


    def take_tile_with(self, id):
        """
        Takes a tile with a given tile id

        :param id:  The id of the tile that should be taken
        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_particle is None and self.carried_tile is None:
951
952
953
            if id in self.sim.tile_map_id:
                logging.info("Tile with tile id %s is in the sim", str(id))
                self.carried_tile = self.sim.tile_map_id[id]
Ahmad Reza's avatar
Ahmad Reza committed
954
955
                if self.carried_tile.take(coords=self.coords):
                    logging.info("Tile with tile id %s  has been taken", str(id))
956
                    self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
957
958
959
960
961
962
                    self.csv_particle_writer.write_particle(tiles_taken=1)
                    return True
                else:
                    logging.info("Tile with tile id %s could not be taken", str(id))
                    return False
            else:
963
                logging.info("Tile with tile id %s is not in the sim", str(id))
Ahmad Reza's avatar
Ahmad Reza committed
964
965
966
967
968
969
970
971
972
973
974
975
976
                return False
        else:
            logging.info("Tile cannot taken because particle is carrieng either a tile or a particle", str(id))
            return False

    def take_tile_in(self, dir):
        """
        Takes a tile that is in a given direction

        :param dir: The direction on which the tile should be taken. Options: E, SE, SW, W, NW, NE,
        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_particle is None and self.carried_tile is None:
977
978
979
980
            coords = self.sim.get_coords_in_dir(self.coords, dir)
            if coords in self.sim.tile_map_coords:
                self.carried_tile = self.sim.tile_map_coords[coords]
                logging.info("Tile with tile id %s is in the sim", str(self.carried_tile.get_id()))
Ahmad Reza's avatar
Ahmad Reza committed
981
982
                if self.carried_tile.take(coords=self.coords):
                    logging.info("Tile with tile id %s  has been taken", str(self.carried_tile.get_id()))
983
                    self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
984
985
986
987
988
989
                    self.csv_particle_writer.write_particle(tiles_taken=1)
                    return True
                else:
                    logging.info("Tile with tile id %s could not be taken", str(self.carried_tile.get_id()))
                    return False
            else:
990
                logging.info("Tile is not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
                return False
        else:
            logging.info("Tile cannot taken because particle is carrieng either a tile or a particle")
            return False

    def take_tile_on(self, x=None, y=None):
        """
        Takes a tile that is in a given direction

        :param x: x coordinate
        :param y: y coordinate
        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_particle is None and self.carried_tile is None:
1005
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1006
                coords = (x, y)
1007
1008
1009
                if coords in self.sim.tile_map_coords:
                    self.carried_tile = self.sim.tile_map_coords[coords]
                    logging.info("Tile with tile id %s is in the sim", str(self.carried_tile.get_id()))
Ahmad Reza's avatar
Ahmad Reza committed
1010
                    if self.carried_tile.take(coords=self.coords):
1011
                        self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
1012
1013
1014
1015
1016
1017
1018
                        self.csv_particle_writer.write_particle(tiles_taken=1)
                        logging.info("Tile with tile id %s  has been taken", str(self.carried_tile.get_id()))
                        return True
                    else:
                        logging.info("Tile with tile id %s could not be taken", str(self.carried_tile.get_id()))
                        return False
                else:
1019
                    logging.info("Tile is not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
                    return False
            else:
                logging.info("Coordinates are wrong")
                return False
        else:
            logging.info("Tile cannot taken because particle is carrieng either a tile or a particle")
            return False

    def drop_tile(self):
        """
        Drops the taken tile on the particles actual position

        :return: None
        """
        if self.carried_tile is not None:
1035
            if self.coords not in self.sim.tile_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
1036
1037
1038
1039
1040
1041
                try:  # cher: insert so to overcome the AttributeError
                    self.carried_tile.drop_me(self.coords)
                except AttributeError:
                    pass
                self.carried_tile = None
                logging.info("Tile has been dropped on the actual position")
1042
                self.sim.csv_round_writer.update_metrics( tiles_dropped=1)
Ahmad Reza's avatar
Ahmad Reza committed
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
                self.csv_particle_writer.write_particle(tiles_dropped=1)
                return True
            else:
                logging.info("Is not possible to drop the tile on that position because it is occupied")
                return False
        else:
            return False

    def drop_tile_in(self, dir):
        """
        Drops the taken tile on a given direction

         :param dir: The direction on which the tile should be dropped. Options: E, SE, SW, W, NW, NE,
        """
        if self.carried_tile is not None:
1058
1059
            coords = self.sim.get_coords_in_dir(self.coords, dir)
            if coords not in self.sim.tile_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
1060
1061
1062
1063
1064
                try:  # cher: insert so to overcome the AttributeError
                    self.carried_tile.drop_me(coords)
                except AttributeError:
                    pass
                self.carried_tile = None
1065
                self.sim.csv_round_writer.update_metrics( tiles_dropped=1)
Ahmad Reza's avatar
Ahmad Reza committed
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
                self.csv_particle_writer.write_particle(tiles_dropped=1)
                logging.info("Dropped tile on %s coordinate", str(coords))
                return True
            else:
                logging.info("Is not possible to drop the tile on that position")
                return False

        else:
            logging.info("No tile taken for dropping")
            return False

    def drop_tile_on(self, x=None, y=None):
        """
        Drops the taken tile on a given direction

        :param x: x coordinate
        :param y: y coordinate
        """
        if self.carried_tile is not None:
1085
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1086
                coords = (x, y)
1087
                if coords not in self.sim.get_tile_map_coords():
Ahmad Reza's avatar
Ahmad Reza committed
1088
1089
1090
1091
1092
                    try:  # cher: insert so to overcome the AttributeError
                        self.carried_tile.drop_me(coords)
                    except AttributeError:
                        pass
                    self.carried_tile = None
1093
                    self.sim.csv_round_writer.update_metrics( tiles_dropped=1)
Ahmad Reza's avatar
Ahmad Reza committed
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
                    self.csv_particle_writer.write_particle(tiles_dropped=1)
                    logging.info("Dropped tile on %s coordinate", str(coords))
                    return True
                else:
                    logging.info("Is not possible to drop the tile on that position because it is occupied")
                    return False
            else:
                logging.info("Wrong coordinates for dropping the tile")
                return False
        else:
            logging.info("No tile is taken for dropping")
            return False

    def create_particle(self, color=black, alpha=1):
        """
        Creates a particle on the particles actual position

Ahmad Reza's avatar
Ahmad Reza committed
1111
        :return: New Particle or False
Ahmad Reza's avatar
Ahmad Reza committed
1112
1113
        """
        logging.info("Going to create on position %s", str(self.coords))
Ahmad Reza's avatar
Ahmad Reza committed
1114
1115
1116
1117
1118
1119
1120
1121
1122
        new_particle = self.sim.add_particle(self.coords[0], self.coords[1], color, alpha)
        if new_particle:
            self.sim.particle_map_coords[self.coords[0], self.coords[1]].created=True
            self.csv_particle_writer.write_particle(particle_created=1)
            self.sim.csv_round_writer.update_particle_num(len(self.sim.get_particle_list()))
            self.sim.csv_round_writer.update_metrics( particle_created=1)
            return new_particle
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
1123
1124
1125
1126
1127
1128
1129
1130

    def create_particle_in(self, dir=None, color=black, alpha=1):
        """
        Creates a particle either in a given direction

        :toDo: seperate the direction and coordinates and delete state

        :param dir: The direction on which the particle should be created. Options: E, SE, SW, W, NW, NE,
Ahmad Reza's avatar
Ahmad Reza committed
1131
        :return: New Particle or False
Ahmad Reza's avatar
Ahmad Reza committed
1132
1133
1134
        """
        coords = (0, 0)
        if dir is not None:
1135
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
1136
            logging.info("Going to create a particle in %s on position %s", str(dir), str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1137
1138
            new_particle= self.sim.add_particle(coords[0], coords[1], color, alpha)
            if new_particle:
1139
                self.sim.particle_map_coords[coords[0], coords[1]].created = True
Ahmad Reza's avatar
Ahmad Reza committed
1140
                logging.info("Created particle on coords %s", coords)
1141
1142
                self.sim.csv_round_writer.update_particle_num(len(self.sim.get_particle_list()))
                self.sim.csv_round_writer.update_metrics( particle_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
1143
                self.csv_particle_writer.write_particle(particle_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
1144
1145
1146
                return new_particle
            else:
                return False
Ahmad Reza's avatar
Ahmad Reza committed
1147
1148
        else:
            logging.info("Not created particle on coords %s", str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1149
            return False
Ahmad Reza's avatar
Ahmad Reza committed
1150
1151
1152
1153
1154
1155
1156
1157
1158

    def create_particle_on(self, x=None, y=None, color=black, alpha=1):
        """
        Creates a particle either on a given x,y coordinates

        :toDo: seperate the direction and coordinates and delete state

        :param x: x coordinate
        :param y: y coordinate
Ahmad Reza's avatar
Ahmad Reza committed
1159
        :return: New Particle or False
Ahmad Reza's avatar
Ahmad Reza committed
1160
1161
1162
        """
        coords = (0, 0)
        if x is not None and y is not None:
1163
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1164
1165
                coords = (x, y)
                logging.info("Going to create a particle on position %s", str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1166
1167
                new_particle = self.sim.add_particle(coords[0], coords[1], color, alpha)
                if new_particle:
1168
                    self.sim.particle_map_coords[coords[0], coords[1]].created = True
Ahmad Reza's avatar
Ahmad Reza committed
1169
                    logging.info("Created particle on coords %s", str(coords))
1170
1171
                    self.sim.csv_round_writer.update_particle_num(len(self.sim.get_particle_list()))
                    self.sim.csv_round_writer.update_metrics( particle_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
1172
                    self.csv_particle_writer.write_particle(particle_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
1173
                    return new_particle
Ahmad Reza's avatar
Ahmad Reza committed
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
                else:
                    return False
            else:
                return False
        else:
            logging.info("Not created particle on coords %s", str(coords))
            return False

    def delete_particle(self):
        """
        Deletes a tile on current position

        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        logging.info("Particle %s is", self.get_id())
        logging.info("is going to delete a particle on current position")
1190
1191
        if self.coords in self.sim.get_particle_map_coords():
            if self.sim.remove_particle_on(self.coords):
Ahmad Reza's avatar
Ahmad Reza committed
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
                self.csv_particle_writer.write_particle(particle_deleted=1)
                return True
        else:
            logging.info("Could not delet particle")
            return False

    def delete_particle_with(self, id):
        """
        Deletes a particle with a given id

        :param id: The id of the particle that should be deleted
        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        logging.info("Particle %s is", self.get_id())
        logging.info("is going to delete a particle with id %s", str(id))
1207
        if self.sim.remove_particle(id):
Ahmad Reza's avatar
Ahmad Reza committed
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
            self.csv_particle_writer.write_particle(particle_deleted=1)
            return
        else:
            logging.info("Could not delet particle with particle id %s", str(id))

    def delete_particle_in(self, dir=None):
        """
        Deletes a particle either in a given direction

        :param dir: The direction on which the particle should be deleted. Options: E, SE, SW, W, NW, NE,
        :return: True: Deleting successful; False: Deleting unsuccessful
        """
Ahmad Reza's avatar
Ahmad Reza committed
1220
        if dir is not None:
1221
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
1222
            logging.info("Deleting tile in %s direction", str(dir))
Ahmad Reza's avatar
Ahmad Reza committed
1223
1224
1225
1226
1227
            if self.sim.remove_particle_on(coords):
                logging.info("Deleted particle with particle on coords %s", str(coords))
                self.csv_particle_writer.write_particle(particle_deleted=1)
            else:
                logging.info("Could not delet particle on coords %s", str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237

    def delete_particle_on(self, x=None, y=None):
        """
        Deletes a particle either on a given x,y coordinates

        :param x: x coordinate
        :param y: y coordinate
        :return: True: Deleting successful; False: Deleting unsuccessful
        """
        if x is not None and y is not None:
1238
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1239
                coords = (x, y)
1240
                if self.sim.remove_particle_on(coords):
Ahmad Reza's avatar
Ahmad Reza committed
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
                    logging.info("Deleted particle with particle on coords %s", str(coords))
                    self.csv_particle_writer.write_particle(particle_deleted=1)
                    return True
                else:
                    logging.info("Could not delet particle on coords %s", str(coords))
                    return False
            else:
                return False
        else:
            return False

    def take_particle(self):
        """
        Takes a particle on the actual position

        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_particle is None and self.carried_tile is None:
1259
1260
            if self.coords in self.sim.particle_map_coords:
                self.carried_particle = self.sim.particle_map_coords[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
1261
1262
                if self.carried_particle.take_me(coords=self.coords):
                    logging.info("particle has been taken")
1263
                    self.sim.csv_round_writer.update_metrics( particles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
1264
1265
1266
1267
1268
1269
                    self.csv_particle_writer.write_particle(particles_taken=1)
                    return True
                else:
                    logging.info("particle could not be taken")
                    return False
            else:
1270
                logging.info("No particle on the actual position not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
                return False
        else:
            logging.info("particle cannot taken because particle is carrieng either a particle or a particle")
            return False

    def take_particle_with(self, id):
        """
        Takes a particle with a given tile id

        :param id:  The id of the particle that should be taken
        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_tile is None and self.carried_particle is None:
1284
            if id in self.sim.get_particle_map_id():
1285
1286
                logging.info("particle with particle id %s is in the sim", str(id))
                self.carried_particle = self.sim.particle_map_id[id]
Ahmad Reza's avatar
Ahmad Reza committed
1287
1288
1289
                if self.carried_particle.take_me(self.coords):
                    logging.info("particle with particle id %s  has been taken", str(id))

1290
                    self.sim.csv_round_writer.update_metrics(
Ahmad Reza's avatar
Ahmad Reza committed
1291
1292
1293
1294
1295
1296
1297
                                                               particles_taken=1)
                    self.csv_particle_writer.write_particle(particles_taken=1)
                    return True
                else:
                    logging.info("particle with particle id %s could not be taken", str(id))
                    return False
            else:
1298
                logging.info("particle with particle id %s is not in the sim", str(id))
Ahmad Reza's avatar
Ahmad Reza committed
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
        else:
            logging.info("particle cannot taken because particle is carrieng either a particle or a particle", str(id))

    def take_particle_in(self, dir):
        """
        Takes a particle that is in a given direction

        :param dir: The direction on which the particle should be taken. Options: E, SE, SW, W, NW, NE,
        :return: True: successful taken; False: unsuccessful taken
        """
        if self.carried_tile is None and self.carried_particle is None:
1310
1311
            coords = self.sim.get_coords_in_dir(self.coords, dir)
            if coords in self.sim.particle_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
1312
                logging.info("Take particle")
1313
                self.carried_particle = self.sim.particle_map_coords[coords]
Ahmad Reza's avatar
Ahmad Reza committed
1314
1315
                if self.carried_particle.take_me(coords=self.coords):
                    logging.info("particle with particle id %s  has been taken", str(self.carried_particle.get_id()))
1316
                    self.sim.csv_round_writer.update_metrics(
Ahmad Reza's avatar
Ahmad Reza committed
1317
1318
1319
1320
1321
1322
1323
                                                               particles_taken=1)
                    self.csv_particle_writer.write_particle(particles_taken=1)
                    return True
                else:
                    logging.info("particle could not be taken")
                    return False
            else:
1324
                pass
1325
                logging.info("particl is not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed