User Manual, Developers Guide and API Documentation

rise::PropCacheEntry Class Reference

PropCacheEntry is an object that stores the values of pathloss, shadowing and antennaGain to compute the total loss.

#include <transceiver/cache/propcacheentry.hpp>

Collaboration diagram for rise::PropCacheEntry:

Collaboration graph
[legend]

List of all members.

Public Member Functions

wns::Ratio getAntennaGain () const
 Returns the stored value for the antennaGain.
wns::Ratio getPathloss () const
 Returns the strored value for the pathloss.
wns::Ratio getShadowing () const
 Returns the stored value for the shadowing.
wns::Ratio getTotalLoss () const
 Returns the total loss of this PSG.
bool isValid () const
 Returns true if stored values are valid.
 PropCacheEntry ()
 Default Constructor.
void setAntennaGain (wns::Ratio gain)
 Stores the given value for antennaGain.
void setPathloss (wns::Ratio loss)
 Stores the given value for pathloss.
void setShadowing (wns::Ratio shadow)
 Stores the given value for shadowing.
void setValid (bool valid)
 Set true for guilty values and false to set the object dirty.
 ~PropCacheEntry ()
 Defeult Destructor.

Private Member Functions

void recomputeTotalLoss ()
 Computes total loss from the currently stored values.

Private Attributes

wns::Ratio antennaGain
wns::Ratio pathloss
wns::Ratio shadowing
wns::Ratio totalLoss
bool valid


Detailed Description

Definition at line 38 of file propcacheentry.hpp.


Constructor & Destructor Documentation

PropCacheEntry::PropCacheEntry (  ) 

Definition at line 33 of file propcacheentry.cpp.

PropCacheEntry::~PropCacheEntry (  ) 

Definition at line 42 of file propcacheentry.cpp.


Member Function Documentation

wns::Ratio PropCacheEntry::getAntennaGain (  )  const

Definition at line 61 of file propcacheentry.cpp.

wns::Ratio PropCacheEntry::getPathloss (  )  const

Definition at line 51 of file propcacheentry.cpp.

wns::Ratio PropCacheEntry::getShadowing (  )  const

Definition at line 56 of file propcacheentry.cpp.

wns::Ratio PropCacheEntry::getTotalLoss (  )  const

Definition at line 46 of file propcacheentry.cpp.

bool PropCacheEntry::isValid (  )  const

Definition at line 66 of file propcacheentry.cpp.

void rise::PropCacheEntry::recomputeTotalLoss (  )  [inline, private]

Definition at line 66 of file propcacheentry.hpp.

void PropCacheEntry::setAntennaGain ( wns::Ratio  gain  ) 

Definition at line 84 of file propcacheentry.cpp.

void PropCacheEntry::setPathloss ( wns::Ratio  loss  ) 

Definition at line 72 of file propcacheentry.cpp.

void PropCacheEntry::setShadowing ( wns::Ratio  shadow  ) 

Definition at line 78 of file propcacheentry.cpp.

void PropCacheEntry::setValid ( bool  valid  ) 

Definition at line 90 of file propcacheentry.cpp.


Member Data Documentation

Definition at line 74 of file propcacheentry.hpp.

Definition at line 72 of file propcacheentry.hpp.

Definition at line 73 of file propcacheentry.hpp.

Definition at line 71 of file propcacheentry.hpp.

Definition at line 75 of file propcacheentry.hpp.


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

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