/usr/include/ns3.27/ns3/propagation-cache.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2012 Telum (www.telum.ru)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Kirill Andreev <andreev@telum.ru>
*/
#ifndef PROPAGATION_CACHE_H_
#define PROPAGATION_CACHE_H_
#include "ns3/mobility-model.h"
#include <map>
namespace ns3
{
/**
* \ingroup propagation
* \brief Constructs a cache of objects, where each object is responsible for a single propagation path loss calculations.
* Propagation path a-->b and b-->a is the same thing. Propagation path is identified by
* a couple of MobilityModels and a spectrum model UID
*/
template<class T>
class PropagationCache
{
public:
PropagationCache () {};
~PropagationCache () {};
/**
* Get the model associated with the path
* \param a 1st node mobility model
* \param b 2nd node mobility model
* \param modelUid model UID
* \return the model
*/
Ptr<T> GetPathData (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b, uint32_t modelUid)
{
PropagationPathIdentifier key = PropagationPathIdentifier (a, b, modelUid);
typename PathCache::iterator it = m_pathCache.find (key);
if (it == m_pathCache.end ())
{
return 0;
}
return it->second;
};
/**
* Add a model to the path
* \param data the model to associate to the path
* \param a 1st node mobility model
* \param b 2nd node mobility model
* \param modelUid model UID
*/
void AddPathData (Ptr<T> data, Ptr<const MobilityModel> a, Ptr<const MobilityModel> b, uint32_t modelUid)
{
PropagationPathIdentifier key = PropagationPathIdentifier (a, b, modelUid);
NS_ASSERT (m_pathCache.find (key) == m_pathCache.end ());
m_pathCache.insert (std::make_pair (key, data));
};
private:
/// Each path is identified by
struct PropagationPathIdentifier
{
/**
* Constructor
* @param a 1st node mobility model
* @param b 2nd node mobility model
* @param modelUid model UID
*/
PropagationPathIdentifier (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b, uint32_t modelUid) :
m_srcMobility (a), m_dstMobility (b), m_spectrumModelUid (modelUid)
{};
Ptr<const MobilityModel> m_srcMobility; //!< 1st node mobility model
Ptr<const MobilityModel> m_dstMobility; //!< 2nd node mobility model
uint32_t m_spectrumModelUid; //!< model UID
/**
* Less-than operator.
*
* The goal of this operator is just to provide a stable comparison
* to be used in containers requiring a order (of any kind).
*
* If the models are different, the comparison is based on their Uid.
* Otherwise, the comparison is based on the pointers of the Mobility models.
*
* \param other Right value of the operator.
* \returns True if the Left value is less than the Right value.
*/
bool operator < (const PropagationPathIdentifier & other) const
{
if (m_spectrumModelUid != other.m_spectrumModelUid)
{
return m_spectrumModelUid < other.m_spectrumModelUid;
}
/// Links are supposed to be symmetrical!
if (std::min (m_dstMobility, m_srcMobility) != std::min (other.m_dstMobility, other.m_srcMobility))
{
return std::min (m_dstMobility, m_srcMobility) < std::min (other.m_dstMobility, other.m_srcMobility);
}
if (std::max (m_dstMobility, m_srcMobility) != std::max (other.m_dstMobility, other.m_srcMobility))
{
return std::max (m_dstMobility, m_srcMobility) < std::max (other.m_dstMobility, other.m_srcMobility);
}
return false;
}
};
/// Typedef: PropagationPathIdentifier, Ptr<T>
typedef std::map<PropagationPathIdentifier, Ptr<T> > PathCache;
private:
PathCache m_pathCache; //!< Path cache
};
} // namespace ns3
#endif // PROPAGATION_CACHE_H_
|