particle.py 70 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
198
199
200
            return tmp_memory
        else:
            return None




Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
201
202
203
204
205
206
207
208
209
210
211
    def matter_in(self, dir=E):
        """
        :param dir: the direction to check if a matter is there
        :return: True: if a matter is there, False: if not
        """
        if  self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords() \
            or self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords() \
            or self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords():
            return True
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
212
213

    def tile_in(self, dir=E):
Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
214
215
216
217
218
219
220
221
        """
        :param dir: the direction to check if a tile is there
        :return: True: if a tile is there, False: if not
        """
        if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_tile_map_coords():
            return True
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
222
223

    def particle_in(self, dir=E):
Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
224
225
226
227
228
229
230
231
        """
        :param dir: the direction to check if a particle is there
        :return: True: if a particle is there, False: if not
        """
        if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_particle_map_coords():
            return True
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
232

233
    def marker_in(self, dir=E):
Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
234
235
236
237
238
239
240
241
        """
        :param dir: the direction to check if a marker is there
        :return: True: if a marker is there, False: if not
        """
        if self.sim.get_coords_in_dir(self.coords, dir) in self.sim.get_marker_map_coords():
            return True
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
242

Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
243
244
245
246
247
248
249
250
251
    def get_matter_in(self, dir=E):
        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)]
        elif 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)]
        elif 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)]
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
252
253
254


    def get_tile_in(self, dir=E):
255
256
        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 Cheraghi's avatar
Ahmad Reza Cheraghi committed
257
258
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
259
260

    def get_particle_in(self, dir=E):
261
262
        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 Cheraghi's avatar
Ahmad Reza Cheraghi committed
263
264
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
265

266
267
268
    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 Cheraghi's avatar
Ahmad Reza Cheraghi committed
269
270
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
271

272
273
274
    def get_marker(self):
        if self.coords in self.sim.marker_map_coords:
            return self.sim.get_marker_map_coords()[self.coords]
Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
275
276
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
277

Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
278
279
280
    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 Cheraghi's avatar
Ahmad Reza Cheraghi committed
281
282
        else:
            return False
Ahmad Reza's avatar
Ahmad Reza committed
283
284
285
286


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

289
        :param matter: The matter can be either a particle, tile, or marker
Ahmad Reza's avatar
Ahmad Reza committed
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
        :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)
308
309
310
                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
311
312
313
314
315
316
                return True
            else:
                return False
        else:
            return False

Ahmad Reza's avatar
Ahmad Reza committed
317
318
    def scan_for_matter_within(self, matter='all', hop=1):
        """
319
        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
320
321
322

        :todo: If nothing then everything should be scanned

323
        :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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
        :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):
        """
340
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
341

342
        :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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
        :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":
359
360
361
362
                    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)])
363
364
365
366
367
                elif matter == "markers":
                    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
368
                elif matter == "tiles":
369
370
371
372
                    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
373
                elif matter == "all":
Ahmad Reza Cheraghi's avatar
Ahmad Reza Cheraghi committed
374

375
376
377
378
                    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)])
379
380
381
382
                    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)])
383
384
385
386
                    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
387
388
389
390
                else:
                    logging.info("No matter specified")
            else:
                if matter == "particles":
391
392
393
394
395
396
397
398
                    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)])
399
400
401
402
403
404
405
406
407
                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
408
                elif matter == "tiles":
409
410
411
412
413
414
415
416
                    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
417
                elif matter == "all":
418
419
420
421
422
423
424
425
426
                    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)])

427
428
429
430
431
432
433
434
                    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)])
435
436
437
438
439
440
441
442
443

                    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
444
445
446
447
448
449
450
451
452
453
454
455

                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":
456
457
458
459
                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)])
460
461
462
463
464
            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
465
            elif matter == "tiles":
466
467
468
469
                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
470
471
            if matter == "all":
                if hop == 0:
472
473
                    if (0, 0) in self.sim.particle_map_coords:
                        hop_list.append(self.sim.particle_map_coords[(0, 0)])
474
475
                    if (0, 0) in self.sim.marker_map_coords:
                        hop_list.append(self.sim.marker_map_coords[(0, 0)])
476
477
                    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
478
                else:
479
480
481
482
                    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
483

484
485
486
487
                    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
488

489
490
491
492
                    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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508

            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):
        """
509
        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
510
511
512

        :todo: If nothing then everything should be scanned

513
        :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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
        :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):
        """
530
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
531

532
        :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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
        :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:
548
549
550
551
552
553
                # 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
554
            else:
555
556
557
558
559
560
561
562
                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
563
564
565
566
567
568
569
570
            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
571
572
573
574
            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
575
576
577
578
579
580
581
582
583
584
585
586
587
            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):
        """
588
        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
589
590
591

        :todo: If nothing then everything should be scanned

592
        :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
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
        :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):
        """
609
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
610

611
        :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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
        :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:
627
628
629
630
631
632
                # 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
633
            else:
634
635
636
637
638
639
640
641
                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
642
643
644
645
646
647
648
649
            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
650
651
652
653
            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
654
655
656
657
658
659
660
661
662
663
            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


664
    def scan_for_marker_within(self, hop=1):
Ahmad Reza's avatar
Ahmad Reza committed
665
        """
666
        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
667
668
669

        :todo: If nothing then everything should be scanned

670
        :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
671
672
673
674
675
676
        :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):
677
            list = self.scan_for_marker_in(i)
Ahmad Reza's avatar
Ahmad Reza committed
678
679
680
681
682
683
684
            if list != None:
                hop_list.extend(list)
        if len(hop_list) != 0:
            return hop_list
        else:
            return None

685
    def scan_for_marker_in(self, hop=1):
Ahmad Reza's avatar
Ahmad Reza committed
686
        """
687
        Scanning for particles, tiles, or marker on a given hop distance
Ahmad Reza's avatar
Ahmad Reza committed
688

689
        :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
690
691
692
693
        :param hop: The hop distance from thee actual position of the scanning particle
        :return: A list of the founded matters
        """
        hop_list = []
694
        logging.info("particle is scanning for marker in %i hops", hop)
Ahmad Reza's avatar
Ahmad Reza committed
695
696
697
698
699
700
701
702
703
704
        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:
705
706
707
708
709
710
                # 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
711
712
            else:

713
714
715
716
717
718
719
720
                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
721
722
723
724
725
726
727
728
            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
729
730
731
732
            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
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
            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:
751
752
            if self.coords in self.sim.particle_map_coords:
                del self.sim.particle_map_coords[self.coords]
Ahmad Reza's avatar
Ahmad Reza committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
            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
        """
767
        self.sim.particle_map_coords[coords] = self
Ahmad Reza's avatar
Ahmad Reza committed
768
769
770
771
772
773
774
775
        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
776
        :return: New Tile or False
Ahmad Reza's avatar
Ahmad Reza committed
777
778
        """
        logging.info("Going to create a tile on position %s", str(self.coords))
Ahmad Reza's avatar
Ahmad Reza committed
779
780
781
782
783
784
785
786
787
        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
788
789
790
791
792
793

    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
794
        :return: New tile or False
Ahmad Reza's avatar
Ahmad Reza committed
795
796
797
798
        """
        logging.info("particle with id %s is", self.get_id())
        logging.info("Going to create a tile in %s ", str(dir) )
        if dir != None:
799
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
800
801
            new_tile = self.sim.add_tile(coords[0], coords[1], color, alpha)
            if new_tile:
802
                self.sim.tile_map_coords[coords[0], coords[1]].created = True
Ahmad Reza's avatar
Ahmad Reza committed
803
                logging.info("Tile is created")
804
                self.sim.new_tile_flag = True
Ahmad Reza's avatar
Ahmad Reza committed
805
                self.csv_particle_writer.write_particle(tile_created=1)
806
807
                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
808
809
810
                return new_tile
            else:
                return False
Ahmad Reza's avatar
Ahmad Reza committed
811
812
        else:
            logging.info("Not created tile ")
Ahmad Reza's avatar
Ahmad Reza committed
813
            return False
Ahmad Reza's avatar
Ahmad Reza committed
814
815
816
817
818
819
820

    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
821
        :return: New Tile or False
Ahmad Reza's avatar
Ahmad Reza committed
822
823
824
825
826
        """

        logging.info("particle with id %s is", self.get_id())
        if x is not None and y is not None:
            coords = (x, y)
827
            if self.sim.check_coords(x,y):
Ahmad Reza's avatar
Ahmad Reza committed
828
                logging.info("Going to create a tile on position \(%i , %i\)", x,y )
829
830
831
                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
832
                    self.csv_particle_writer.write_particle(tile_created=1)
833
834
                    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
835
836
837
838
839
840
                    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
841
                return False
Ahmad Reza's avatar
Ahmad Reza committed
842
843
844
845
846
847
848
849
850

    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")
851
852
        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
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
                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))
868
        if self.sim.remove_tile(id):
Ahmad Reza's avatar
Ahmad Reza committed
869
870
871
872
873
874
            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
875
    def delete_tile_in(self, dir=None):
Ahmad Reza's avatar
Ahmad Reza committed
876
877
878
879
880
881
882
883
        """
        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
884
        if dir is not None:
885
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
886
887
            logging.info("Deleting tile in %s direction", str(dir))
            if coords is not None:
888
                if self.sim.remove_tile_on(coords):
Ahmad Reza's avatar
Ahmad Reza committed
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
                    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)
910
            if self.sim.remove_tile_on(coords):
Ahmad Reza's avatar
Ahmad Reza committed
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
                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:
929
930
            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
931
932
                if self.carried_tile.take(coords=self.coords):
                    logging.info("Tile has been taken")
933
                    self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
934
935
936
937
938
939
                    self.csv_particle_writer.write_particle(tiles_taken=1)
                    return True
                else:
                    logging.info("Tile could not be taken")
                    return False
            else:
940
                logging.info("No tile on the actual position not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
941
942
943
944
945
946
947
948
949
950
951
952
953
                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:
954
955
956
            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
957
958
                if self.carried_tile.take(coords=self.coords):
                    logging.info("Tile with tile id %s  has been taken", str(id))
959
                    self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
960
961
962
963
964
965
                    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:
966
                logging.info("Tile with tile id %s is not in the sim", str(id))
Ahmad Reza's avatar
Ahmad Reza committed
967
968
969
970
971
972
973
974
975
976
977
978
979
                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:
980
981
982
983
            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
984
985
                if self.carried_tile.take(coords=self.coords):
                    logging.info("Tile with tile id %s  has been taken", str(self.carried_tile.get_id()))
986
                    self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
987
988
989
990
991
992
                    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:
993
                logging.info("Tile is not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
                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:
1008
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1009
                coords = (x, y)
1010
1011
1012
                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
1013
                    if self.carried_tile.take(coords=self.coords):
1014
                        self.sim.csv_round_writer.update_metrics( tiles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
1015
1016
1017
1018
1019
1020
1021
                        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:
1022
                    logging.info("Tile is not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
                    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:
1038
            if self.coords not in self.sim.tile_map_coords:
Ahmad Reza's avatar
Ahmad Reza committed
1039
1040
1041
1042
1043
1044
                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")
1045
                self.sim.csv_round_writer.update_metrics( tiles_dropped=1)
Ahmad Reza's avatar
Ahmad Reza committed
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
                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:
1061
1062
            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
1063
1064
1065
1066
1067
                try:  # cher: insert so to overcome the AttributeError
                    self.carried_tile.drop_me(coords)
                except AttributeError:
                    pass
                self.carried_tile = None
1068
                self.sim.csv_round_writer.update_metrics( tiles_dropped=1)
Ahmad Reza's avatar
Ahmad Reza committed
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
                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:
1088
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1089
                coords = (x, y)
1090
                if coords not in self.sim.get_tile_map_coords():
Ahmad Reza's avatar
Ahmad Reza committed
1091
1092
1093
1094
1095
                    try:  # cher: insert so to overcome the AttributeError
                        self.carried_tile.drop_me(coords)
                    except AttributeError:
                        pass
                    self.carried_tile = None
1096
                    self.sim.csv_round_writer.update_metrics( tiles_dropped=1)
Ahmad Reza's avatar
Ahmad Reza committed
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
                    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
1114
        :return: New Particle or False
Ahmad Reza's avatar
Ahmad Reza committed
1115
1116
        """
        logging.info("Going to create on position %s", str(self.coords))
Ahmad Reza's avatar
Ahmad Reza committed
1117
1118
1119
1120
1121
1122
1123
1124
1125
        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
1126
1127
1128
1129
1130
1131
1132
1133

    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
1134
        :return: New Particle or False
Ahmad Reza's avatar
Ahmad Reza committed
1135
1136
1137
        """
        coords = (0, 0)
        if dir is not None:
1138
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
1139
            logging.info("Going to create a particle in %s on position %s", str(dir), str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1140
1141
            new_particle= self.sim.add_particle(coords[0], coords[1], color, alpha)
            if new_particle:
1142
                self.sim.particle_map_coords[coords[0], coords[1]].created = True
Ahmad Reza's avatar
Ahmad Reza committed
1143
                logging.info("Created particle on coords %s", coords)
1144
1145
                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
1146
                self.csv_particle_writer.write_particle(particle_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
1147
1148
1149
                return new_particle
            else:
                return False
Ahmad Reza's avatar
Ahmad Reza committed
1150
1151
        else:
            logging.info("Not created particle on coords %s", str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1152
            return False
Ahmad Reza's avatar
Ahmad Reza committed
1153
1154
1155
1156
1157
1158
1159
1160
1161

    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
1162
        :return: New Particle or False
Ahmad Reza's avatar
Ahmad Reza committed
1163
1164
1165
        """
        coords = (0, 0)
        if x is not None and y is not None:
1166
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1167
1168
                coords = (x, y)
                logging.info("Going to create a particle on position %s", str(coords))
Ahmad Reza's avatar
Ahmad Reza committed
1169
1170
                new_particle = self.sim.add_particle(coords[0], coords[1], color, alpha)
                if new_particle:
1171
                    self.sim.particle_map_coords[coords[0], coords[1]].created = True
Ahmad Reza's avatar
Ahmad Reza committed
1172
                    logging.info("Created particle on coords %s", str(coords))
1173
1174
                    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
1175
                    self.csv_particle_writer.write_particle(particle_created=1)
Ahmad Reza's avatar
Ahmad Reza committed
1176
                    return new_particle
Ahmad Reza's avatar
Ahmad Reza committed
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
                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")
1193
1194
        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
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
                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))
1210
        if self.sim.remove_particle(id):
Ahmad Reza's avatar
Ahmad Reza committed
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
            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
1223
        if dir is not None:
1224
            coords = self.sim.get_coords_in_dir(self.coords, dir)
Ahmad Reza's avatar
Ahmad Reza committed
1225
            logging.info("Deleting tile in %s direction", str(dir))
Ahmad Reza's avatar
Ahmad Reza committed
1226
1227
1228
1229
1230
            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
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240

    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:
1241
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1242
                coords = (x, y)
1243
                if self.sim.remove_particle_on(coords):
Ahmad Reza's avatar
Ahmad Reza committed
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
                    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:
1262
1263
            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
1264
1265
                if self.carried_particle.take_me(coords=self.coords):
                    logging.info("particle has been taken")
1266
                    self.sim.csv_round_writer.update_metrics( particles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
1267
1268
1269
1270
1271
1272
                    self.csv_particle_writer.write_particle(particles_taken=1)
                    return True
                else:
                    logging.info("particle could not be taken")
                    return False
            else:
1273
                logging.info("No particle on the actual position not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
                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:
1287
            if id in self.sim.get_particle_map_id():
1288
1289
                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
1290
1291
1292
                if self.carried_particle.take_me(self.coords):
                    logging.info("particle with particle id %s  has been taken", str(id))

1293
                    self.sim.csv_round_writer.update_metrics(
Ahmad Reza's avatar
Ahmad Reza committed
1294
1295
1296
1297
1298
1299
1300
                                                               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:
1301
                logging.info("particle with particle id %s is not in the sim", str(id))
Ahmad Reza's avatar
Ahmad Reza committed
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
        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:
1313
1314
            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
1315
                logging.info("Take particle")
1316
                self.carried_particle = self.sim.particle_map_coords[coords]
Ahmad Reza's avatar
Ahmad Reza committed
1317
1318
                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()))
1319
                    self.sim.csv_round_writer.update_metrics(
Ahmad Reza's avatar
Ahmad Reza committed
1320
1321
1322
1323
1324
1325
1326
                                                               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:
1327
                pass
1328
                logging.info("particl is not in the sim")
Ahmad Reza's avatar
Ahmad Reza committed
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
        else:
            logging.info("particle cannot be  taken")

    def take_particle_on(self, x=None, y=None):
        """
        Takes the particle on the given coordinate if it is not taken

        :param y:
        :param x:
        :return: True: Successful taken; False: Cannot be taken or wrong Coordinates
        """
        if self.carried_particle is None and self.carried_tile is None:
1341
            if self.sim.check_coords(x, y):
Ahmad Reza's avatar
Ahmad Reza committed
1342
                coords = (x, y)
1343
1344
1345
                if coords in self.sim.particle_map_coords:
                    self.carried_particle = self.sim.particle_map_coords[coords]
                    logging.info("Particle with id %s is in the sim", str(self.carried_particle.get_id()))
Ahmad Reza's avatar
Ahmad Reza committed
1346
                    if self.carried_particle.take_me(coords=self.coords):
1347
                        self.sim.csv_round_writer.update_metrics( particles_taken=1)
Ahmad Reza's avatar
Ahmad Reza committed
1348
1349