ns-3.24: src/buildings/model/buildings-mobility-model.h@c6d3c7862cfb (annotated)

8184 b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	1	/* -- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -- */
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	2	/*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	3	* Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	4	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	5	* This program is free software; you can redistribute it and/or modify
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	6	* it under the terms of the GNU General Public License version 2 as
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	7	* published by the Free Software Foundation;
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	8	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	9	* This program is distributed in the hope that it will be useful,
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	12	* GNU General Public License for more details.
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	13	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	14	* You should have received a copy of the GNU General Public License
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	15	* along with this program; if not, write to the Free Software
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	16	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	17	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	18	* Author: Marco Miozzo <marco.miozzo@cttc.es>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	19	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	20	*/
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	21	#ifndef BUILDINGS_MOBILITY_MODEL_H
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	22	#define BUILDINGS_MOBILITY_MODEL_H
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	23
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	24
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	25
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	26	#include <ns3/mobility-model.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	27	#include <ns3/ptr.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	28	#include <ns3/object.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	29	#include <ns3/box.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	30	#include <map>
8317 2ec35f16dc11 buildings does not depend on spectrum any more Nicola Baldo <nbaldo@cttc.es> parents: 8248 diff changeset	31	#include <ns3/building.h>
8184 b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	32	#include <ns3/constant-velocity-helper.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	33
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	34
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	35
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	36	namespace ns3 {
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	37
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	38
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	39	/**
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	40	* \ingroup mobility
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	41	* \brief Buildings mobility model
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	42	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	43	* This model implements the managment of scenarios where users might be
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	44	* either indoor (e.g., houses, offices, etc.) and outdoor.
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	45	*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	46	*/
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	47
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	48
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	49	class BuildingsMobilityModel : public MobilityModel
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	50	{
8332 c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	51	public:
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	52	static TypeId GetTypeId (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	53	BuildingsMobilityModel ();
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	54
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	55	bool IsIndoor (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	56	bool IsOutdoor (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	57
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	58	void SetIndoor (Ptr<Building> building);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	59	void SetOutdoor (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	60
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	61	void SetSurroudingBuilding (Ptr<Building> building);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	62
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	63	void SetFloorNumber (uint8_t nfloor);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	64	void SetRoomNumberX (uint8_t nroomx);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	65	void SetRoomNumberY (uint8_t nroomy);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	66
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	67	uint8_t GetFloorNumber (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	68	uint8_t GetRoomNumberX (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	69	uint8_t GetRoomNumberY (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	70
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	71	Ptr<Building> GetBuilding ();
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	72
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	73
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	74
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	75	private:
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	76	virtual void DoDispose (void);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	77	virtual Vector DoGetPosition (void) const;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	78	virtual void DoSetPosition (const Vector &position);
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	79	virtual Vector DoGetVelocity (void) const;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	80	ConstantVelocityHelper m_helper;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	81	Box m_bounds; // bounds of the simulation field (if needed)
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	82	std::list < Ptr<Building> > m_surroudingBuildings; // buildings blocks
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	83	Ptr<Building> m_myBuilding;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	84	bool m_indoor;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	85	/**
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	86	* floors numbering starts from 0 (basement)
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	87	*/
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	88	uint8_t m_nFloor;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	89	uint8_t m_roomX;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	90	uint8_t m_roomY;
c6d3c7862cfb Style fixed in buildings module mmiozzo parents: 8317 diff changeset	91
8184 b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	92	};
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	93
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	94
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	95
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	96	} // namespace ns3
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	97
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel Marco Miozzo <marco.miozzo@cttc.es> parents: diff changeset	98
8317 2ec35f16dc11 buildings does not depend on spectrum any more Nicola Baldo <nbaldo@cttc.es> parents: 8248 diff changeset	99	#endif // BUILDINGS_MOBILITY_MODEL_H

author	mmiozzo
	Fri, 18 Nov 2011 16:28:06 +0100
changeset 8332	c6d3c7862cfb
parent 8317	2ec35f16dc11
child 8338	ff32cd151f7c
permissions	-rw-r--r--