User Manual, Developers Guide and API Documentation

wifimac::helper::HopContextWindowProbe Class Reference

FunctionalUnit to probe windowing throughputs that include the hopcount. More...

#include <helper/DestinationSortedThroughputProbe.hpp>

Inheritance diagram for wifimac::helper::HopContextWindowProbe:

Inheritance graph
[legend]
Collaboration diagram for wifimac::helper::HopContextWindowProbe:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 HopContextWindowProbe (wns::ldk::fun::FUN *fuNet, const wns::pyconfig::View &config)
 HopContextWindowProbe (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &config)
 HopContextWindowProbe (wns::ldk::fun::FUN *fuNet, const wns::pyconfig::View &config)
virtual void processIncoming (const wns::ldk::CompoundPtr &compound)
 Process compounds on uplink.
virtual void processIncoming (const wns::ldk::CompoundPtr &compound)
 Process compounds on uplink.
virtual void processIncoming (const wns::ldk::CompoundPtr &compound)
 Process compounds on uplink.
virtual ~HopContextWindowProbe ()
virtual ~HopContextWindowProbe ()
virtual ~HopContextWindowProbe ()

Private Types

typedef
wns::container::Registry< int,
wns::probe::bus::ContextCollectorPtr,
wns::container::registry::DeleteOnErase
PutterMap
 Store all putter in a registry, sorted by hop-count, created on-demand.
typedef
wns::container::Registry< int,
wns::probe::bus::ContextCollectorPtr,
wns::container::registry::DeleteOnErase
PutterMap
 Store all putter in a registry, sorted by hop-count, created on-demand.
typedef
wns::container::Registry< int,
wns::SlidingWindow
*, wns::container::registry::DeleteOnErase
slidingWindowMap
 Store all probes(sliding windows) in a registry, sorted by hop-count, created on-demand.
typedef
wns::container::Registry< int,
wns::SlidingWindow
*, wns::container::registry::DeleteOnErase
SlidingWindowMap
typedef
wns::container::Registry< int,
wns::SlidingWindow
*, wns::container::registry::DeleteOnErase
slidingWindowMap
 Store all probes(sliding windows) in a registry, sorted by hop-count, created on-demand.

Private Member Functions

wns::SlidingWindowgetProbe (SlidingWindowMap &probeHolder, PutterMap &putterHolder, std::string id, unsigned int numHops)
 Helper for all putInto* functions.
wns::SlidingWindowgetProbe (SlidingWindowMap &probeHolder, PutterMap &putterHolder, std::string id, unsigned int numHops)
 Helper for all putInto* functions.
virtual void onFUNCreated ()
 Resolve inter-FU dependencies.
virtual void onFUNCreated ()
 Resolve inter-FU dependencies.
virtual void onFUNCreated ()
 Resolve inter-FU dependencies.
void periodically ()
 Periodically storing of the slidingWindow results.
void periodically ()
 Periodically storing of the slidingWindow results.
void periodically ()
 Periodically storing of the slidingWindow results.
void putIntoBitsAggregated (unsigned int numHops, double value)
 Add sample for aggregated bits.
void putIntoBitsAggregated (unsigned int numHops, double value)
 Add sample for aggregated bits.
void putIntoBitsIncomming (unsigned int numHops, double value)
 Add sample for incomming bits.
void putIntoBitsIncomming (unsigned int numHops, double value)
 Add sample for incomming bits.
void putIntoCompoundsAggregated (unsigned int numHops, double value)
 Add sample for aggregated compounds.
void putIntoCompoundsAggregated (unsigned int numHops, double value)
 Add sample for aggregated compounds.
void putIntoCompoundsIncomming (unsigned int numHops, double value)
 Add sample for incomming compounds.
void putIntoCompoundsIncomming (unsigned int numHops, double value)
 Add sample for incomming compounds.
void putProbe (SlidingWindowMap &probeHolder, unsigned int numHops, double value)
 put a probe sample into the (hop-sorted) slidingWindowRegistry, create new entry on-demand
void storeProbes (SlidingWindowMap &probeHolder, PutterMap &putterHolder)
 Helper for periodically: store all probes in the given sliding windows into the putters.
void storeProbes (SlidingWindowMap &probeHolder, wns::probe::bus::ContextCollectorPtr &putter)
 Helper for periodically: store all probes in the given sliding windows into the putters.
void storeProbes (SlidingWindowMap &probeHolder, PutterMap &putterHolder)
 Helper for periodically: store all probes in the given sliding windows into the putters.

Private Attributes

SlidingWindowMap bitsAggregatedProbeHolder
slidingWindowMap bitsAggregatedProbeHolder
PutterMap bitsAggregatedPutterHolder
SlidingWindowMap bitsIncomingProbeHolder
 Store all probes(sliding windows) in a registry, sorted by hop-count, created on-demand.
slidingWindowMap bitsIncomingProbeHolder
PutterMap bitsIncomingPutterHolder
SlidingWindowMap compoundsAggregatedProbeHolder
slidingWindowMap compoundsAggregatedProbeHolder
PutterMap compoundsAggregatedPutterHolder
SlidingWindowMap compoundsIncomingProbeHolder
slidingWindowMap compoundsIncomingProbeHolder
PutterMap compoundsIncomingPutterHolder
wns::pyconfig::View config_
wns::ldk::CommandReaderInterfaceforwardingReader
 Access the number of hops in the forwarding command.
wns::ldk::CommandReaderInterfaceforwardingReader
 Access the number of hops in the forwarding command.
wns::ldk::CommandReaderInterfaceforwardingReader
 Access the number of hops in the forwarding command.
struct
wifimac::helper::HopContextWindowProbe::Friends 
friends
struct
wifimac::helper::HopContextWindowProbe::Friends 
friends
wns::probe::bus::ContextCollectorPtr hopCountedBitsAggregated
wns::probe::bus::ContextCollectorPtr hopCountedBitsIncoming
 Store all putter in a registry, sorted by hop-count, created on-demand.
wns::probe::bus::ContextCollectorPtr hopCountedCompoundsAggregated
wns::probe::bus::ContextCollectorPtr hopCountedCompoundsIncoming
const simTimeType windowSize
 One common window size for all probes.

Classes

struct  Friends
 Required to differentiate between probes in different transceivers of the same node. More...


Detailed Description

This is a derivate of the wns::ldk::probe::Window

Definition at line 48 of file DestinationSortedThroughputProbe.hpp.


Member Typedef Documentation

Definition at line 116 of file ThroughputProbe.hpp.

Definition at line 116 of file DestinationSortedThroughputProbe.hpp.

Definition at line 124 of file ThroughputProbe.hpp.

Definition at line 51 of file HopContextWindowProbe.hpp.

Definition at line 124 of file DestinationSortedThroughputProbe.hpp.


Constructor & Destructor Documentation

HopContextWindowProbe::HopContextWindowProbe ( wns::ldk::fun::FUN fuNet,
const wns::pyconfig::View config 
)

Definition at line 50 of file HopContextWindowProbe.cpp.

HopContextWindowProbe::~HopContextWindowProbe (  )  [virtual]

Definition at line 71 of file HopContextWindowProbe.cpp.

wifimac::helper::HopContextWindowProbe::HopContextWindowProbe ( wns::ldk::fun::FUN fun,
const wns::pyconfig::View config 
)

virtual wifimac::helper::HopContextWindowProbe::~HopContextWindowProbe (  )  [virtual]

wifimac::helper::HopContextWindowProbe::HopContextWindowProbe ( wns::ldk::fun::FUN fuNet,
const wns::pyconfig::View config 
)

virtual wifimac::helper::HopContextWindowProbe::~HopContextWindowProbe (  )  [virtual]


Member Function Documentation

wns::SlidingWindow* wifimac::helper::HopContextWindowProbe::getProbe ( SlidingWindowMap probeHolder,
PutterMap putterHolder,
std::string  id,
unsigned int  numHops 
) [private]

wns::SlidingWindow * HopContextWindowProbe::getProbe ( SlidingWindowMap probeHolder,
PutterMap putterHolder,
std::string  id,
unsigned int  numHops 
) [private]

Definition at line 114 of file ThroughputProbe.cpp.

virtual void wifimac::helper::HopContextWindowProbe::onFUNCreated (  )  [private, virtual]

Often FunctionalUnits require the collaboration with other FunctionalUnits to accomplish their task. For the collaboration between FunctionalUnits we coined the term "friendship".

The onFUNCreated method is a hook being called after the complete FUN has been set up. FunctionalUnits requiring the collaboration with other FunctionalUnits should resolve these dependencies by implementing this hook accordingly.

Finding friends is usually done calling wns::ldk::fun::FUN::findFriend.

When building reconfigurable FUNs, this method may get called multiple times (e.g., after each FUN reconfiguration). Keep that in mind when allocating resources in your onFUNCreated implementation.

Reimplemented from wns::ldk::FunctionalUnit.

virtual void wifimac::helper::HopContextWindowProbe::onFUNCreated (  )  [private, virtual]

Often FunctionalUnits require the collaboration with other FunctionalUnits to accomplish their task. For the collaboration between FunctionalUnits we coined the term "friendship".

The onFUNCreated method is a hook being called after the complete FUN has been set up. FunctionalUnits requiring the collaboration with other FunctionalUnits should resolve these dependencies by implementing this hook accordingly.

Finding friends is usually done calling wns::ldk::fun::FUN::findFriend.

When building reconfigurable FUNs, this method may get called multiple times (e.g., after each FUN reconfiguration). Keep that in mind when allocating resources in your onFUNCreated implementation.

Reimplemented from wns::ldk::FunctionalUnit.

void HopContextWindowProbe::onFUNCreated (  )  [private, virtual]

Often FunctionalUnits require the collaboration with other FunctionalUnits to accomplish their task. For the collaboration between FunctionalUnits we coined the term "friendship".

The onFUNCreated method is a hook being called after the complete FUN has been set up. FunctionalUnits requiring the collaboration with other FunctionalUnits should resolve these dependencies by implementing this hook accordingly.

Finding friends is usually done calling wns::ldk::fun::FUN::findFriend.

When building reconfigurable FUNs, this method may get called multiple times (e.g., after each FUN reconfiguration). Keep that in mind when allocating resources in your onFUNCreated implementation.

Reimplemented from wns::ldk::FunctionalUnit.

Definition at line 77 of file HopContextWindowProbe.cpp.

void wifimac::helper::HopContextWindowProbe::periodically (  )  [private, virtual]

Reimplemented from wns::ldk::probe::bus::Window.

void wifimac::helper::HopContextWindowProbe::periodically (  )  [private, virtual]

Reimplemented from wns::ldk::probe::bus::Window.

void HopContextWindowProbe::periodically (  )  [private, virtual]

Reimplemented from wns::ldk::probe::bus::Window.

Definition at line 123 of file HopContextWindowProbe.cpp.

virtual void wifimac::helper::HopContextWindowProbe::processIncoming ( const wns::ldk::CompoundPtr compound  )  [virtual]

Override this method to handle incoming compounds.

Reimplemented from wns::ldk::probe::bus::Window.

virtual void wifimac::helper::HopContextWindowProbe::processIncoming ( const wns::ldk::CompoundPtr compound  )  [virtual]

Override this method to handle incoming compounds.

Reimplemented from wns::ldk::probe::bus::Window.

void HopContextWindowProbe::processIncoming ( const wns::ldk::CompoundPtr compound  )  [virtual]

Override this method to handle incoming compounds.

Reimplemented from wns::ldk::probe::bus::Window.

Definition at line 84 of file HopContextWindowProbe.cpp.

void wifimac::helper::HopContextWindowProbe::putIntoBitsAggregated ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

void HopContextWindowProbe::putIntoBitsAggregated ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

Definition at line 141 of file ThroughputProbe.cpp.

void wifimac::helper::HopContextWindowProbe::putIntoBitsIncomming ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

void HopContextWindowProbe::putIntoBitsIncomming ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

Definition at line 132 of file ThroughputProbe.cpp.

void wifimac::helper::HopContextWindowProbe::putIntoCompoundsAggregated ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

void HopContextWindowProbe::putIntoCompoundsAggregated ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

Definition at line 159 of file ThroughputProbe.cpp.

void wifimac::helper::HopContextWindowProbe::putIntoCompoundsIncomming ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

void HopContextWindowProbe::putIntoCompoundsIncomming ( unsigned int  numHops,
double  value 
) [private]

The sample is sorted into the probe with the given number of hops, this sample is the first one the probe & putter is created

Definition at line 150 of file ThroughputProbe.cpp.

void HopContextWindowProbe::putProbe ( SlidingWindowMap probeHolder,
unsigned int  numHops,
double  value 
) [private]

Definition at line 112 of file HopContextWindowProbe.cpp.

void wifimac::helper::HopContextWindowProbe::storeProbes ( SlidingWindowMap probeHolder,
PutterMap putterHolder 
) [private]

void HopContextWindowProbe::storeProbes ( SlidingWindowMap probeHolder,
wns::probe::bus::ContextCollectorPtr putter 
) [private]

Definition at line 140 of file HopContextWindowProbe.cpp.

void HopContextWindowProbe::storeProbes ( SlidingWindowMap probeHolder,
PutterMap putterHolder 
) [private]

Definition at line 190 of file ThroughputProbe.cpp.


Member Data Documentation

Definition at line 95 of file HopContextWindowProbe.hpp.

Definition at line 126 of file DestinationSortedThroughputProbe.hpp.

Definition at line 118 of file DestinationSortedThroughputProbe.hpp.

Definition at line 94 of file HopContextWindowProbe.hpp.

Definition at line 125 of file DestinationSortedThroughputProbe.hpp.

Definition at line 117 of file DestinationSortedThroughputProbe.hpp.

Definition at line 97 of file HopContextWindowProbe.hpp.

Definition at line 128 of file DestinationSortedThroughputProbe.hpp.

Definition at line 120 of file DestinationSortedThroughputProbe.hpp.

Definition at line 96 of file HopContextWindowProbe.hpp.

Definition at line 127 of file DestinationSortedThroughputProbe.hpp.

Definition at line 119 of file DestinationSortedThroughputProbe.hpp.

Definition at line 111 of file DestinationSortedThroughputProbe.hpp.

Definition at line 109 of file ThroughputProbe.hpp.

Definition at line 80 of file HopContextWindowProbe.hpp.

Definition at line 109 of file DestinationSortedThroughputProbe.hpp.

Definition at line 88 of file HopContextWindowProbe.hpp.

Definition at line 87 of file HopContextWindowProbe.hpp.

Definition at line 90 of file HopContextWindowProbe.hpp.

Definition at line 89 of file HopContextWindowProbe.hpp.

Definition at line 112 of file DestinationSortedThroughputProbe.hpp.


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

Generated on Sat Feb 11 03:32:41 2012 for openWNS by  doxygen 1.5.5