A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
building-allocator.h
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2007 INRIA
4
* Copyright (C) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
5
*
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License version 2 as
8
* published by the Free Software Foundation;
9
*
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
14
*
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
*
19
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
20
* Author: Nicola Baldo <nbaldo@cttc.es> (took position-allocator and turned it into building-allocator)
21
*/
22
#ifndef BUILDING_ALLOCATOR_H
23
#define BUILDING_ALLOCATOR_H
24
25
#include "ns3/object.h"
26
#include "ns3/object-factory.h"
27
#include "ns3/vector.h"
28
#include "ns3/building-container.h"
29
#include "ns3/position-allocator.h"
30
31
namespace
ns3
{
32
33
class
Building;
34
35
44
class
GridBuildingAllocator
:
public
Object
45
{
46
public
:
47
GridBuildingAllocator
();
48
virtual
~GridBuildingAllocator
();
49
54
static
TypeId
GetTypeId
(
void
);
55
62
void
SetBuildingAttribute
(std::string n,
const
AttributeValue
&v);
63
71
BuildingContainer
Create
(uint32_t n)
const
;
72
73
private
:
77
void
PushAttributes
()
const
;
78
79
mutable
uint32_t
m_current
;
80
enum
GridPositionAllocator::LayoutType
m_layoutType
;
81
double
m_xMin
;
82
double
m_yMin
;
83
uint32_t
m_n
;
84
double
m_lengthX
;
85
double
m_lengthY
;
86
double
m_deltaX
;
87
double
m_deltaY
;
88
double
m_height
;
89
90
mutable
ObjectFactory
m_buildingFactory
;
91
Ptr<GridPositionAllocator>
m_lowerLeftPositionAllocator
;
92
Ptr<GridPositionAllocator>
m_upperRightPositionAllocator
;
93
94
};
95
96
}
// namespace ns3
97
98
#endif
/* BUILDING_ALLOCATOR_H */
ns3::AttributeValue
Hold a value for an Attribute.
Definition:
attribute.h:69
ns3::BuildingContainer
keep track of a set of building pointers.
Definition:
building-container.h:41
ns3::GridBuildingAllocator
Allocate buildings on a rectangular 2d grid.
Definition:
building-allocator.h:45
ns3::GridBuildingAllocator::GridBuildingAllocator
GridBuildingAllocator()
Definition:
building-allocator.cc:36
ns3::GridBuildingAllocator::m_layoutType
enum GridPositionAllocator::LayoutType m_layoutType
Layout type.
Definition:
building-allocator.h:80
ns3::GridBuildingAllocator::SetBuildingAttribute
void SetBuildingAttribute(std::string n, const AttributeValue &v)
Set an attribute to be used for each new building to be created.
Definition:
building-allocator.cc:97
ns3::GridBuildingAllocator::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition:
building-allocator.cc:49
ns3::GridBuildingAllocator::m_yMin
double m_yMin
The y coordinate where the grid starts.
Definition:
building-allocator.h:82
ns3::GridBuildingAllocator::m_buildingFactory
ObjectFactory m_buildingFactory
The building factory.
Definition:
building-allocator.h:90
ns3::GridBuildingAllocator::m_xMin
double m_xMin
The x coordinate where the grid starts.
Definition:
building-allocator.h:81
ns3::GridBuildingAllocator::m_n
uint32_t m_n
The number of objects laid out on a line.
Definition:
building-allocator.h:83
ns3::GridBuildingAllocator::Create
BuildingContainer Create(uint32_t n) const
Create a set of buildings allocated on a grid.
Definition:
building-allocator.cc:104
ns3::GridBuildingAllocator::m_deltaX
double m_deltaX
The x space between buildings.
Definition:
building-allocator.h:86
ns3::GridBuildingAllocator::~GridBuildingAllocator
virtual ~GridBuildingAllocator()
Definition:
building-allocator.cc:44
ns3::GridBuildingAllocator::m_lowerLeftPositionAllocator
Ptr< GridPositionAllocator > m_lowerLeftPositionAllocator
The upper left position allocator.
Definition:
building-allocator.h:91
ns3::GridBuildingAllocator::m_lengthX
double m_lengthX
The length of the wall of each building along the X axis.
Definition:
building-allocator.h:84
ns3::GridBuildingAllocator::PushAttributes
void PushAttributes() const
Pushes the attributes into the relevant position allocators.
Definition:
building-allocator.cc:125
ns3::GridBuildingAllocator::m_current
uint32_t m_current
current building number
Definition:
building-allocator.h:79
ns3::GridBuildingAllocator::m_deltaY
double m_deltaY
The y space between buildings.
Definition:
building-allocator.h:87
ns3::GridBuildingAllocator::m_height
double m_height
The height of the building (roof level)
Definition:
building-allocator.h:88
ns3::GridBuildingAllocator::m_lengthY
double m_lengthY
The length of the wall of each building along the Y axis.
Definition:
building-allocator.h:85
ns3::GridBuildingAllocator::m_upperRightPositionAllocator
Ptr< GridPositionAllocator > m_upperRightPositionAllocator
The upper right position allocator.
Definition:
building-allocator.h:92
ns3::GridPositionAllocator::LayoutType
LayoutType
Determine whether positions are allocated row first or column first.
Definition:
position-allocator.h:138
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition:
object-factory.h:48
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:88
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:74
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
buildings
helper
building-allocator.h
Generated on Tue Feb 6 2024 19:21:16 for ns-3 by
1.9.1