OLD | NEW |
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ | 1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
2 /* | 2 /* |
3 * Copyright (c) 2012 CTTC | 3 * Copyright (c) 2012 CTTC |
4 * | 4 * |
5 * This program is free software; you can redistribute it and/or modify | 5 * This program is free software; you can redistribute it and/or modify |
6 * it under the terms of the GNU General Public License version 2 as | 6 * it under the terms of the GNU General Public License version 2 as |
7 * published by the Free Software Foundation; | 7 * published by the Free Software Foundation; |
8 * | 8 * |
9 * This program is distributed in the hope that it will be useful, | 9 * This program is distributed in the hope that it will be useful, |
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
(...skipping 15 matching lines...) Expand all Loading... |
26 #include <ns3/object-factory.h> | 26 #include <ns3/object-factory.h> |
27 #include <ns3/node-container.h> | 27 #include <ns3/node-container.h> |
28 #include <ns3/ptr.h> | 28 #include <ns3/ptr.h> |
29 | 29 |
30 | 30 |
31 namespace ns3 { | 31 namespace ns3 { |
32 | 32 |
33 class MobilityModel; | 33 class MobilityModel; |
34 class Building; | 34 class Building; |
35 | 35 |
| 36 /** |
| 37 * \ingroup buildings |
| 38 * |
| 39 * \brief Building helper class |
| 40 */ |
36 class BuildingsHelper | 41 class BuildingsHelper |
37 { | 42 { |
38 public: | 43 public: |
39 /** | 44 /** |
40 * Install the MobilityBuildingInfo to a node | 45 * Install the MobilityBuildingInfo to a node |
41 * | 46 * |
42 * \param node the mobility model of the node to be updated | 47 * \param node the mobility model of the node to be updated |
43 */ | 48 */ |
44 static void Install (Ptr<Node> node); // for any nodes | 49 static void Install (Ptr<Node> node); // for any nodes |
45 /** | 50 /** |
46 * Install the MobilityBuildingInfo to the set of nodes in a NodeContainer | 51 * Install the MobilityBuildingInfo to the set of nodes in a NodeContainer |
47 * | 52 * |
48 * \param c the NodeContainer including the nodes to be updated | 53 * \param c the NodeContainer including the nodes to be updated |
49 */ | 54 */ |
50 static void Install (NodeContainer c); // for any nodes | 55 static void Install (NodeContainer c); // for any nodes |
51 /** | 56 /** |
52 * This method goes through the whole NodeList and, for each node in | 57 * This method goes through the whole NodeList and, for each node in |
53 * the list, calls BuildingsHelper::MakeConsistent() passing to it | 58 * the list, calls BuildingsHelper::MakeConsistent() passing to it |
54 * the MobilityModel of that node. | 59 * the MobilityModel of that node. |
55 * | 60 * |
56 */ | 61 */ |
57 static void MakeMobilityModelConsistent (); | 62 static void MakeMobilityModelConsistent (); |
58 /** | 63 /** |
59 * Make the given mobility model consistent, by determining whether | 64 * Make the given mobility model consistent, by determining whether |
60 * its position falls inside any of the building in BuildingList, and | 65 * its position falls inside any of the building in BuildingList, and |
61 * updating accordingly the BuildingInfo aggregated with the MobilityModel. | 66 * updating accordingly the BuildingInfo aggregated with the MobilityModel. |
62 * | 67 * |
63 * \param bmm the mobility model to be made consistent | 68 * \param bmm the mobility model to be made consistent |
64 */ | 69 */ |
65 static void MakeConsistent (Ptr<MobilityModel> bmm); | 70 static void MakeConsistent (Ptr<MobilityModel> bmm); |
66 | 71 |
67 }; | 72 }; |
68 | 73 |
69 | 74 |
70 } | 75 } |
71 | 76 |
72 #endif /* BUILDINGS_HELPER_H */ | 77 #endif /* BUILDINGS_HELPER_H */ |
OLD | NEW |