User Manual, Developers Guide and API Documentation

rise::VectorCache Class Reference

Interface of class VectorCache. More...

#include <transceiver/cache/vectorcache.hpp>

Inheritance diagram for rise::VectorCache:

Inheritance graph
[legend]
Collaboration diagram for rise::VectorCache:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void attach (Transmitter *t)
 Attaches given Transmitter to the list of active Transmitters.
virtual wns::Ratio getLoss (Transmitter *txA, double freq)
 Computes loss between the receiver and an antenna dependent on pathloss, shadowing and antennaGain.
virtual void invalidatePropagationEntries ()
 For all transmitters update propagation conditions in cache.
virtual void invalidatePropagationEntries (Transmitter *t)
 For the given transmitter update propagation conditions in cache.
 VectorCache (receiver::ReceiverInterface *r)
 Default Constructor.
virtual ~VectorCache ()
 Destructor.

Private Types

typedef std::vector
< PropCacheEntry
CacheVector
 Vector that stores a list of PropCacheEntry object.
typedef std::list< doubleFrequencyContainer
 Struct to store a list of Frequencies.
typedef FreqHash< CacheVectorFrequencyHash
 Hash that contains a CacheVector for each used Frequency.
typedef
FrequencyContainer::iterator 
FrequencyIterator
 Iterator.
typedef std::list< Transmitter * > TransmitterContainer
 Struct to store a list of Transmitters.
typedef
TransmitterContainer::iterator 
TransmitterIterator
 Iterator.

Private Member Functions

void attachFrequency (double freq)
 Expands the cache.
int getIndex (Transmitter *t)
 Returns an index for a transmitter.

Private Attributes

FrequencyContainer frequencies
 List of all used Frequencies.
FrequencyHash pathlossShadowGain
 Cache that stores the total loss towards all active Transmitters.
PointerHashMap< Transmitter
*, long int
transmitter2Index
 Stores an individual index for each active transmitter.
TransmitterContainer transmitters
 List of all active TransmissionObjects.


Detailed Description

The VectorCache stores the loss between its receiver and all active transmitters in a vector sorted by an index which is set for each transmitter.

Definition at line 45 of file vectorcache.hpp.


Member Typedef Documentation

typedef std::vector<PropCacheEntry> rise::VectorCache::CacheVector [private]

Definition at line 73 of file vectorcache.hpp.

typedef std::list<double> rise::VectorCache::FrequencyContainer [private]

Definition at line 69 of file vectorcache.hpp.

Definition at line 75 of file vectorcache.hpp.

typedef FrequencyContainer::iterator rise::VectorCache::FrequencyIterator [private]

Definition at line 71 of file vectorcache.hpp.

Definition at line 65 of file vectorcache.hpp.

typedef TransmitterContainer::iterator rise::VectorCache::TransmitterIterator [private]

Definition at line 67 of file vectorcache.hpp.


Constructor & Destructor Documentation

VectorCache::VectorCache ( receiver::ReceiverInterface r  ) 

Definition at line 41 of file vectorcache.cpp.

VectorCache::~VectorCache (  )  [virtual]

Definition at line 47 of file vectorcache.cpp.


Member Function Documentation

void rise::VectorCache::attach ( Transmitter t  ) 

void VectorCache::attachFrequency ( double  freq  )  [private]

Create a new vector for a new frequency.

Definition at line 120 of file vectorcache.cpp.

int VectorCache::getIndex ( Transmitter t  )  [private]

If the transmitter is not active, it will be attached to the cache and receive an individual index.

Definition at line 64 of file vectorcache.cpp.

wns::Ratio VectorCache::getLoss ( Transmitter txA,
double  freq 
) [virtual]

Implements rise::PropagationCache.

Definition at line 51 of file vectorcache.cpp.

void VectorCache::invalidatePropagationEntries (  )  [virtual]

Implements rise::PropagationCache.

Definition at line 105 of file vectorcache.cpp.

void VectorCache::invalidatePropagationEntries ( Transmitter t  )  [virtual]

Implements rise::PropagationCache.

Definition at line 90 of file vectorcache.cpp.


Member Data Documentation

Definition at line 88 of file vectorcache.hpp.

Cache stores PropCacheEntry objects, which contains pathloss, shadowing, antennaGain and computes the total loss.

Definition at line 83 of file vectorcache.hpp.

Definition at line 77 of file vectorcache.hpp.

Definition at line 86 of file vectorcache.hpp.


The documentation for this class was generated from the following files:

Generated on Sat May 26 03:32:37 2012 for openWNS by  doxygen 1.5.5